avoid GTK+ prefixes for our tree entry code, it is not part of GTK+, should have...

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

diff --git a/interface/wx/cshelp.h b/interface/wx/cshelp.h
index 116aad6a3f4b5d945dcc55862d71b3e6537b932a..db3ce6f1504f0ab8880e8b64ab8978cd4eb17645 100644 (file)
--- a/interface/wx/cshelp.h
+++ b/interface/wx/cshelp.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxHelpProvider
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -66,7 +66,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.
@@ -111,8 +111,8 @@ 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);
 };
 
 
@@ -163,7 +163,7 @@ public:
 
     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:
@@ -205,16 +205,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,7 +232,7 @@ public:
 
     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
@@ -245,9 +247,6 @@ public:
 class wxContextHelpButton : public wxBitmapButton
 {
 public:
-    /// Default constructor.
-    wxContextHelpButton();
-
     /**
         Constructor, creating and showing a context help button.
 
@@ -257,9 +256,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.