// Purpose: interface of wxDialUpManager
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
most one instance of this class in the program accessed via Create() and
you can't create the objects of this class directly.
- @beginEventTable{wxDialUpEvent}
+ @beginEventEmissionTable{wxDialUpEvent}
@event{EVT_DIALUP_CONNECTED(func)}
- A connection with the network was established.
+ A connection with the network was established.
@event{EVT_DIALUP_DISCONNECTED(func)}
- The connection with the network was lost.
+ The connection with the network was lost.
@endEventTable
@library{wxcore}
/**
Destructor.
*/
- ~wxDialUpManager();
+ virtual ~wxDialUpManager();
/**
Cancel dialing the number initiated with Dial() with async parameter
@see IsDialing()
*/
- bool CancelDialing();
+ virtual bool CancelDialing() = 0;
/**
This function should create and return the object of the
platform-specific class derived from wxDialUpManager. You should delete
the pointer when you are done with it.
*/
- wxDialUpManager* Create();
+ static wxDialUpManager* Create();
/**
Dial the given ISP, use @a username and @a password to authenticate.
returns immediately - the result is reported via events (an event is
sent anyhow, but if dialing failed it will be a DISCONNECTED one).
*/
- bool Dial(const wxString& nameOfISP = wxEmptyString,
- const wxString& username = wxEmptyString,
- const wxString& password = wxEmptyString,
- bool async = true);
+ virtual bool Dial(const wxString& nameOfISP = wxEmptyString,
+ const wxString& username = wxEmptyString,
+ const wxString& password = wxEmptyString,
+ bool async = true) = 0;
/**
Disable automatic check for connection status change - notice that the
@c wxEVT_DIALUP_XXX events won't be sent any more neither.
*/
- void DisableAutoCheckOnlineStatus();
+ virtual void DisableAutoCheckOnlineStatus() = 0;
/**
Enable automatic checks for the connection status and sending of
@return @false if couldn't set up automatic check for online status.
*/
- bool EnableAutoCheckOnlineStatus(size_t nSeconds = 60);
+ virtual bool EnableAutoCheckOnlineStatus(size_t nSeconds = 60) = 0;
/**
This function is only implemented under Windows.
parameter to Dial() on this machine and returns their number (may be
0).
*/
- size_t GetISPNames(wxArrayString& names) const;
+ virtual size_t GetISPNames(wxArrayString& names) const = 0;
/**
Hang up the currently active dial up connection.
*/
- bool HangUp();
+ virtual bool HangUp() = 0;
/**
Returns @true if the computer has a permanent network connection (i.e.
guaranteed to be correct, so it is better to ask user for
confirmation or give him a possibility to override it.
*/
- bool IsAlwaysOnline() const;
+ virtual bool IsAlwaysOnline() const = 0;
/**
Returns @true if (async) dialing is in progress.
@see Dial()
*/
- bool IsDialing() const;
+ virtual bool IsDialing() const = 0;
/**
Returns @true if the dialup manager was initialized correctly. If this
a good idea to call this function and check its result before calling
any other wxDialUpManager methods.
*/
- bool IsOk() const;
+ virtual bool IsOk() const = 0;
/**
Returns @true if the computer is connected to the network: under
check that the "well-known host" (as specified by SetWellKnownHost())
is reachable.
*/
- bool IsOnline() const;
+ virtual bool IsOnline() const = 0;
/**
This method is for Unix only.
Sets the commands to start up the network and to hang up again.
*/
- void SetConnectCommand(const wxString& commandDial = "/usr/bin/pon",
- const wxString& commandHangup = "/usr/bin/poff") const;
+ virtual void SetConnectCommand(const wxString& commandDial = "/usr/bin/pon",
+ const wxString& commandHangup = "/usr/bin/poff") = 0;
/**
Sometimes the built-in logic for determining the online status may
@see IsOnline()
*/
- void SetOnlineStatus(bool isOnline = true);
+ virtual void SetOnlineStatus(bool isOnline = true) = 0;
/**
This method is for Unix only.
function is always safe to call. The default value is
@c "www.yahoo.com:80".
*/
- void SetWellKnownHost(const wxString& hostname, int portno = 80);
+ virtual void SetWellKnownHost(const wxString& hostname,
+ int portno = 80) = 0;
};