/////////////////////////////////////////////////////////////////////////////
// Name: dialup.h
-// Purpose: documentation for wxDialUpManager class
+// Purpose: interface of wxDialUpManager
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxcore}
@category{net}
- @seealso
- @ref overview_sampledialup "dialup sample", wxDialUpEvent
+ @see @ref overview_sampledialup "dialup sample", wxDialUpEvent
*/
class wxDialUpManager
{
Cancel dialing the number initiated with Dial()
with async parameter equal to @true.
Note that this won't result in DISCONNECTED event being sent.
-
+
@see IsDialing()
*/
bool CancelDialing();
/**
Returns @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.
- @b NB: this functions tries to guess the result and it is not always
+ @note this functions 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.
*/
/**
Returns @true if (async) dialing is in progress.
-
+
@see Dial()
*/
bool IsDialing() const;
so, in general, the user should be allowed to override it. This function
allows to forcefully set the online status - whatever our internal
algorithm may think about it.
-
+
@see IsOnline()
*/
void SetOnlineStatus(bool isOnline = true);
};
+
/**
@class wxDialUpEvent
@wxheader{dialup.h}
*/
bool IsOwnEvent() const;
};
+