wxruby3 1.6.1 → 1.7.0

data/lib/wx/doc/gen/dial_up_event.rb

@@ -0,0 +1,45 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # connected event
+  EVT_DIALUP_CONNECTED = 10134
+  
+  # disconnected event
+  EVT_DIALUP_DISCONNECTED = 10135
+  
+  # This is the event class for the dialup events sent by {Wx::DialUpManager}.
+  # 
+  # Category:  {Wx::Events}
+  # 
+  # @wxrb_require USE_DIALUP_MANAGER
+  class DialUpEvent < Event
+  
+    # Constructor is only used by {Wx::DialUpManager}.
+    # @param isConnected [Boolean] 
+    # @param isOwnEvent [Boolean] 
+    # @return [Wx::DialUpEvent]
+    def initialize(isConnected, isOwnEvent) end
+    
+    # Is this a CONNECTED or DISCONNECTED event?
+    # 
+    # In other words, does it notify about transition from offline to online state or vice versa?
+    # @return [Boolean]
+    def is_connected_event; end
+    alias_method :connected_event?, :is_connected_event
+    
+    # Does this event come from {Wx::DialUpManager#dial} or from some external process (i.e.
+    # 
+    # does it result from our own attempt to establish the connection)?
+    # @return [Boolean]
+    def is_own_event; end
+    alias_method :own_event?, :is_own_event
+    
+  end # DialUpEvent
+  
+
+end

data/lib/wx/doc/gen/dial_up_manager.rb

@@ -0,0 +1,149 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This class encapsulates functions dealing with verifying the connection status of the workstation (connected to the Internet via a direct connection, connected through a modem or not connected at all) and to establish this connection if possible/required (i.e.
+  # 
+  # in the case of the modem).
+  # The program may also wish to be notified about the change in the connection status (for example, to perform some action when the user connects to the network the next time or, on the contrary, to stop receiving data from the net when the user hangs up the modem). For this, you need to use one of the event macros described below.
+  # This class is different from other wxWidgets classes in that there is at most one instance of this class in the program accessed via {Wx::DialUpManager.create} and you can't create the objects of this class directly.
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::DialUpEvent} events.
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_dialup_connected}(meth = nil, &block): A connection with the network was established. 
+  # 
+  # - {Wx::EvtHandler#evt_dialup_disconnected}(meth = nil, &block): The connection with the network was lost. 
+  # 
+  # Category:  {Wx::Networking}
+  # @see page_samples_dialup
+  # @see  Wx::DialUpEvent 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_DIALUP_MANAGER
+  class DialUpManager < ::Object
+  
+    # Cancel dialing the number initiated with {Wx::DialUpManager#dial} with async parameter equal to true.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This won't result in a DISCONNECTED event being sent.
+    # </p>
+    # </div>
+    # @see Wx::DialUpManager#is_dialing 
+    # @return [Boolean]
+    def cancel_dialing; end
+    
+    # Dial the given ISP, use username and password to authenticate.
+    # 
+    # The parameters are only used under Windows currently, for Unix you should use {Wx::DialUpManager#set_connect_command} to customize this functions behaviour.
+    # If no nameOfISP is given, the function will select the default one (proposing the user to choose among all connections defined on this machine) and if no username and/or password are given, the function will try to do without them, but will ask the user if really needed.
+    # If async parameter is false, the function waits until the end of dialing and returns true upon successful completion.
+    # If async is true, the function only initiates the connection and returns immediately - the result is reported via events (an event is sent anyhow, but if dialing failed it will be a DISCONNECTED one).
+    # @param nameOfISP [String] 
+    # @param username [String] 
+    # @param password [String] 
+    # @param async [Boolean] 
+    # @return [Boolean]
+    def dial(nameOfISP=(''), username=(''), password=(''), async=true) end
+    
+    # Disable automatic check for connection status change - notice that the {Wx::EVT_DIALUP_XXX} events won't be sent any more either.
+    # @return [void]
+    def disable_auto_check_online_status; end
+    
+    # Enable automatic checks for the connection status and sending of <code>wxEVT_DIALUP_CONNECTED/wxEVT_DIALUP_DISCONNECTED</code> events.
+    # 
+    # The interval parameter is only for Unix where we do the check manually and specifies how often should we repeat the check (each minute by default). Under Windows, the notification about the change of connection status is sent by the system and so we don't do any polling and this parameter is ignored.
+    # false if couldn't set up automatic check for online status.
+    # @param nSeconds [Integer] 
+    # @return [Boolean]
+    def enable_auto_check_online_status(nSeconds=60) end
+    
+    # This function is only implemented under Windows.
+    # 
+    # Fills the array with the names of all possible values for the first parameter to {Wx::DialUpManager#dial} on this machine and returns their number (may be 0).
+    # @return [Array<String>]
+    def get_isp_names; end
+    alias_method :isp_names, :get_isp_names
+    
+    # Hang up the currently active dial up connection.
+    # @return [Boolean]
+    def hang_up; end
+    
+    # Returns true if the computer has a permanent network connection (i.e.
+    # 
+    # \ is on a LAN) and so there is no need to use {Wx::DialUpManager#dial} function to go online.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This function tries to guess the result and it is not always guaranteed to be correct, so it is better to ask user for confirmation or give him a possibility to override it. 
+    # </p>
+    # </div>
+    # @return [Boolean]
+    def is_always_online; end
+    alias_method :always_online?, :is_always_online
+    
+    # Returns true if (async) dialing is in progress.
+    # 
+    # 
+    # @see Wx::DialUpManager#dial 
+    # @return [Boolean]
+    def is_dialing; end
+    alias_method :dialing?, :is_dialing
+    
+    # Returns true if the dialup manager was initialized correctly.
+    # 
+    # If this function returns false, no other functions will work either, so it is a good idea to call this function and check its result before calling any other {Wx::DialUpManager} methods.
+    # @return [Boolean]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # Returns true if the computer is connected to the network: under Windows, this just means that a RAS connection exists, under Unix we check that the "well-known host" (as specified by {Wx::DialUpManager#set_well_known_host}) is reachable.
+    # @return [Boolean]
+    def is_online; end
+    alias_method :online?, :is_online
+    
+    # This method is for Unix only.
+    # 
+    # Sets the commands to start up the network and to hang up again.
+    # @param commandDial [String] 
+    # @param commandHangup [String] 
+    # @return [void]
+    def set_connect_command(commandDial=("/USR/BIN/PON"), commandHangup=("/USR/BIN/POFF")) end
+    alias_method :connect_command=, :set_connect_command
+    
+    # Sometimes the built-in logic for determining the online status may fail, so, in general, the user should be allowed to override it.
+    # 
+    # This function allows forcefully setting the online status - whatever our internal algorithm may think about it.
+    # @see Wx::DialUpManager#is_online 
+    # @param isOnline [Boolean] 
+    # @return [void]
+    def set_online_status(isOnline=true) end
+    alias_method :online_status=, :set_online_status
+    
+    # This method is for Unix only.
+    # 
+    # Under Unix, the value of well-known host is used to check whether we're connected to the internet. It is unused under Windows, but this function is always safe to call. The default value is <code>"www.yahoo.com:80"</code>.
+    # @param hostname [String] 
+    # @param portno [Integer] 
+    # @return [void]
+    def set_well_known_host(hostname, portno=80) end
+    alias_method :well_known_host=, :set_well_known_host
+    
+    # This function should create and return the object of the platform-specific class derived from {Wx::DialUpManager}.
+    # 
+    # You should delete the pointer when you are done with it.
+    # @return [Wx::DialUpManager]
+    def self.create; end
+    
+  end # DialUpManager
+  
+
+end