\section{\class{wxDialUpManager}}\label{wxdialupmanager}
-This class encapsulates functions dealing with veryfying the connection status
+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).
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 wxWindows classes in that there is at most
+This class is different from other wxWidgets classes in that there is at most
one instance of this class in the program accessed via
\helpref{wxDialUpManager::Create()}{wxdialupmanagercreate} and you can't
create the objects of this class directly.
<wx/dialup.h>
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
\wxheading{Event table macros}
To be notified about the change in the network connection status, use these
\constfunc{bool}{IsOk}{\void}
-Returns {\tt TRUE} if the dialup manager was initialized correctly. If this
-function returns {\tt FALSE}, no other functions will work neither, so it is a
+Returns {\tt true} if the dialup manager was initialized correctly. If this
+function returns {\tt false}, no other functions will work neither, so it is a
good idea to call this function and check its result before calling any other
wxDialUpManager methods
\membersection{wxDialUpManager::Dial}\label{wxdialupmanagerdial}
-\func{bool}{Dial}{\param{const wxString\& }{nameOfISP = wxEmptyString}, \param{const wxString\& }{username = wxEmptyString}, \param{const wxString\& }{password = wxEmptyString}, \param{bool }{async = TRUE}}
+\func{bool}{Dial}{\param{const wxString\& }{nameOfISP = wxEmptyString}, \param{const wxString\& }{username = wxEmptyString}, \param{const wxString\& }{password = wxEmptyString}, \param{bool }{async = true}}
-Dial the given ISP, use {\it username} and {\it password} to authentificate.
+Dial the given ISP, use {\it username} and {\it password} to authenticate.
The parameters are only used under Windows currently, for Unix you should use
\helpref{SetConnectCommand}{wxdialupmanagersetconnectcommand} to customize this
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 {\it async} parameter is {\tt FALSE}, the function waits until the end of dialing
-and returns {\tt TRUE} upon successful completion.
+If {\it async} parameter is {\tt false}, the function waits until the end of dialing
+and returns {\tt true} upon successful completion.
-If {\it async} is {\tt TRUE}, the function only initiates the connection and
+If {\it async} is {\tt 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).
\constfunc{bool}{IsDialing}{\void}
-Returns TRUE if (async) dialing is in progress.
+Returns true if (async) dialing is in progress.
\wxheading{See also}
\func{bool}{CancelDialing}{\void}
Cancel dialing the number initiated with \helpref{Dial}{wxdialupmanagerdial}
-with async parameter equal to {\tt TRUE}.
+with async parameter equal to {\tt true}.
Note that this won't result in DISCONNECTED event being sent.
\constfunc{bool}{IsAlwaysOnline}{\void}
-Returns {\tt TRUE} if the computer has a permanent network connection (i.e. is
+Returns {\tt true} if the computer has a permanent network connection (i.e. is
on a LAN) and so there is no need to use Dial() function to go online.
{\bf NB:} this functions tries to guess the result and it is not always
\constfunc{bool}{IsOnline}{\void}
-Returns {\tt TRUE} if the computer is connected to the network: under Windows,
+Returns {\tt 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
\helpref{SetWellKnownHost}{wxdialupmanagersetwellknownhost}) is reachable.
\membersection{wxDialUpManager::SetOnlineStatus}\label{wxdialupmanagersetonlinestatus}
-\func{void}{SetOnlineStatus}{\param{bool }{isOnline = TRUE}}
+\func{void}{SetOnlineStatus}{\param{bool }{isOnline = true}}
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
\func{bool}{EnableAutoCheckOnlineStatus}{\param{size\_t }{nSeconds = 60}}
-Enable automatical checks for the connection status and sending of
+Enable automatic checks for the connection status and sending of
{\tt wxEVT\_DIALUP\_CONNECTED/wxEVT\_DIALUP\_DISCONNECTED} 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.
-Returns {\tt FALSE} if couldn't set up automatic check for online status.
+Returns {\tt false} if couldn't set up automatic check for online status.
\membersection{wxDialUpManager::DisableAutoCheckOnlineStatus}\label{wxdialupmanagerdisableautocheckonlinestatus}
\membersection{wxDialUpManager::SetConnectCommand}\label{wxdialupmanagersetconnectcommand}
-\func{}{SetConnectCommand}{\param{const wxString\& }{commandDial = wxT("/usr/bin/pon")}, \param{const wxString\& }{commandHangup = wxT("/usr/bin/poff")}}
+\func{void}{SetConnectCommand}{\param{const wxString\& }{commandDial = wxT("/usr/bin/pon")}, \param{const wxString\& }{commandHangup = wxT("/usr/bin/poff")}}
This method is for Unix only.
projects / wxWidgets.git / blobdiff