Add wxFileName::SetPermissions().

[wxWidgets.git] / interface / wx / cshelp.h

diff --git a/interface/wx/cshelp.h b/interface/wx/cshelp.h
index e727f54a71a4d32b8888fefe7fa67bf644db378a..493ac77152bf5cc98d6554af76eb702a137365d6 100644 (file)
--- a/interface/wx/cshelp.h
+++ b/interface/wx/cshelp.h
@@ -2,13 +2,11 @@
 // Name:        cshelp.h
 // Purpose:     interface of wxHelpProvider
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxHelpProvider
-    @wxheader{cshelp.h}
 
     wxHelpProvider is an abstract class used by a program implementing
     context-sensitive help to show the help text for the given window.
@@ -67,7 +65,7 @@ public:
         May be used to set the same help string for all Cancel buttons in
         the application, for example.
     */
-    virtual wxString GetHelp(const wxWindowBase* window);
+    virtual wxString GetHelp(const wxWindowBase* window) = 0;
 
     /**
         Removes the association between the window pointer and the help text.
@@ -112,15 +110,14 @@ public:
 
         @since 2.7.0
     */
-    virtual bool ShowHelpAtPoint(wxWindowBase* window, const wxPoint point,
-                                   wxHelpEvent::Origin origin);
+    virtual bool ShowHelpAtPoint(wxWindowBase* window, const wxPoint& point,
+                                 wxHelpEvent::Origin origin);
 };
 
 
 
 /**
     @class wxHelpControllerHelpProvider
-    @wxheader{cshelp.h}
 
     wxHelpControllerHelpProvider is an implementation of wxHelpProvider which
     supports both context identifiers and plain text help strings. If the help
@@ -162,11 +159,10 @@ public:
 
 /**
     @class wxContextHelp
-    @wxheader{cshelp.h}
 
     This class changes the cursor to a query and puts the application into a
     'context-sensitive help mode'.  When the user left-clicks on a window
-    within the specified window, a wxEVT_HELP event is sent to that control,
+    within the specified window, a @c wxEVT_HELP event is sent to that control,
     and the application may respond to it by popping up some help.
 
     For example:
@@ -208,16 +204,18 @@ public:
     /**
         Destroys the context help object.
     */
-    ~wxContextHelp();
+    virtual ~wxContextHelp();
 
     /**
         Puts the application into context-sensitive help mode. @a window is the
         window which will be used to catch events; if @NULL, the top window
-        will be used.  Returns @true if the application was successfully put
-        into context-sensitive help mode.  This function only returns when the
-        event loop has finished.
+        will be used.
+
+        Returns @true if the application was successfully put into
+        context-sensitive help mode.
+        This function only returns when the event loop has finished.
     */
-    bool BeginContextHelp(wxWindow* window = NULL);
+    bool BeginContextHelp(wxWindow* window);
 
     /**
         Ends context-sensitive help mode. Not normally called by the
@@ -230,11 +228,10 @@ public:
 
 /**
     @class wxContextHelpButton
-    @wxheader{cshelp.h}
 
     Instances of this class may be used to add a question mark button that when
     pressed, puts the application into context-help mode. It does this by
-    creating a wxContextHelp object which itself generates a wxEVT_HELP event
+    creating a wxContextHelp object which itself generates a @c wxEVT_HELP event
     when the user clicks on a window.
 
     On Windows, you may add a question-mark icon to a dialog by use of the
@@ -249,9 +246,6 @@ public:
 class wxContextHelpButton : public wxBitmapButton
 {
 public:
-    /// Default constructor.
-    wxContextHelpButton();
-
     /**
         Constructor, creating and showing a context help button.
 
@@ -261,9 +255,11 @@ public:
             Button identifier. Defaults to wxID_CONTEXT_HELP.
         @param pos
             Button position.
+            If ::wxDefaultPosition is specified then a default position is chosen.
         @param size
-            Button size. If wxDefaultSize is specified then the button is sized
-            appropriately for the question mark bitmap.
+            Button size. 
+            If ::wxDefaultSize is specified then the button is sized appropriately 
+            for the question mark bitmap.
         @param style
             Window style.
 
@@ -281,7 +277,6 @@ public:
 
 /**
     @class wxSimpleHelpProvider
-    @wxheader{cshelp.h}
 
     wxSimpleHelpProvider is an implementation of wxHelpProvider which supports
     only plain text help strings, and shows the string associated with the