Intial review of calctrl.h.

[wxWidgets.git] / interface / dialup.h

diff --git a/interface/dialup.h b/interface/dialup.h
index 87b921f9682c552cf6343fad6ca84a4c6cfc868e..2b72e9786b7c34c2708f7e3dad5e1174f1c853fe 100644 (file)
--- a/interface/dialup.h
+++ b/interface/dialup.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dialup.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dialup.h

-// Purpose:     documentation for wxDialUpManager class
+// Purpose:     interface of wxDialUpManager

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -29,8 +29,7 @@
     @library{wxcore}
     @category{net}
 
     @library{wxcore}
     @category{net}
 

-    @seealso
-    @ref overview_sampledialup "dialup sample", wxDialUpEvent
+    @see @ref overview_sampledialup "dialup sample", wxDialUpEvent

 */
 class wxDialUpManager
 {
 */
 class wxDialUpManager
 {


@@ -44,7 +43,7 @@ public:
         Cancel dialing the number initiated with Dial()
         with async parameter equal to @true.
         Note that this won't result in DISCONNECTED event being sent.
         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();
         @see IsDialing()
     */
     bool CancelDialing();


@@ -99,7 +98,7 @@ public:
         parameter to Dial() on this machine and returns
         their number (may be 0).
     */
         parameter to Dial() on this machine and returns
         their number (may be 0).
     */

-    size_t GetISPNames(wxArrayString& names);
+    size_t GetISPNames(wxArrayString& names) const;

 
     /**
         Hang up the currently active dial up connection.
 
     /**
         Hang up the currently active dial up connection.


@@ -109,18 +108,18 @@ public:
     /**
         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.
     /**
         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.
     */
         guaranteed to be correct, so it is better to ask user for
         confirmation or give him a possibility to override it.
     */

-    bool IsAlwaysOnline();
+    bool IsAlwaysOnline() const;

 
     /**
         Returns @true if (async) dialing is in progress.
 
     /**
         Returns @true if (async) dialing is in progress.

-        
+

         @see Dial()
     */
         @see Dial()
     */

-    bool IsDialing();
+    bool IsDialing() const;

 
     /**
         Returns @true if the dialup manager was initialized correctly. If this
 
     /**
         Returns @true if the dialup manager was initialized correctly. If this


@@ -128,7 +127,7 @@ public:
         good idea to call this function and check its result before calling any other
         wxDialUpManager methods
     */
         good idea to call this function and check its result before calling any other
         wxDialUpManager methods
     */

-    bool IsOk();
+    bool IsOk() const;

 
     /**
         Returns @true if the computer is connected to the network: under Windows,
 
     /**
         Returns @true if the computer is connected to the network: under Windows,


@@ -136,21 +135,21 @@ public:
         the "well-known host" (as specified by
         wxDialUpManager::SetWellKnownHost) is reachable.
     */
         the "well-known host" (as specified by
         wxDialUpManager::SetWellKnownHost) is reachable.
     */

-    bool IsOnline();
+    bool IsOnline() const;

 
     /**
 
     /**

-        , @b const wxString&@e commandHangup = wxT("/usr/bin/poff"))
+        ,  wxString&@e commandHangup = wxT("/usr/bin/poff"))

         This method is for Unix only.
         Sets the commands to start up the network and to hang up again.
     */
         This method is for Unix only.
         Sets the commands to start up the network and to hang up again.
     */

-    void SetConnectCommand();
+    void SetConnectCommand() const;

 
     /**
         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 to forcefully set the online status - whatever our internal
         algorithm may think about it.
 
     /**
         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 to forcefully set the online status - whatever our internal
         algorithm may think about it.

-        
+

         @see IsOnline()
     */
     void SetOnlineStatus(bool isOnline = true);
         @see IsOnline()
     */
     void SetOnlineStatus(bool isOnline = true);


@@ -165,6 +164,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxDialUpEvent
     @wxheader{dialup.h}
 /**
     @class wxDialUpEvent
     @wxheader{dialup.h}


@@ -187,12 +187,13 @@ public:
         Is this a @c CONNECTED or @c DISCONNECTED event? In other words, does it
         notify about transition from offline to online state or vice versa?
     */
         Is this a @c CONNECTED or @c DISCONNECTED event? In other words, does it
         notify about transition from offline to online state or vice versa?
     */

-    bool IsConnectedEvent();
+    bool IsConnectedEvent() const;

 
     /**
         Does this event come from wxDialUpManager::Dial() or from some extrenal
         process (i.e. does it result from our own attempt to establish the
         connection)?
     */
 
     /**
         Does this event come from wxDialUpManager::Dial() or from some extrenal
         process (i.e. does it result from our own attempt to establish the
         connection)?
     */

-    bool IsOwnEvent();
+    bool IsOwnEvent() const;

 };
 };

+