synchronize GTK2 minimum version in docs

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

diff --git a/interface/wx/cshelp.h b/interface/wx/cshelp.h
index cb24c27ec30539f432c46c60df31690e29392a9d..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$
 // 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.
     */
         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.
 
     /**
         Removes the association between the window pointer and the help text.


@@ -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
 
     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:
     and the application may respond to it by popping up some help.
 
     For example:


@@ -232,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
 
     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
     when the user clicks on a window.
 
     On Windows, you may add a question-mark icon to a dialog by use of the


@@ -256,9 +256,11 @@ public:
             Button identifier. Defaults to wxID_CONTEXT_HELP.
         @param pos
             Button position.
             Button identifier. Defaults to wxID_CONTEXT_HELP.
         @param pos
             Button position.

+            If ::wxDefaultPosition is specified then a default position is chosen.

         @param size
         @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.
 
         @param style
             Window style.