X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4707b84cd074ff2ae9ada99579f864eb300f8774..9e9574fe45b176ee74bba8fad7574cf9906145d1:/interface/wx/cshelp.h?ds=sidebyside diff --git a/interface/wx/cshelp.h b/interface/wx/cshelp.h index cb24c27ec3..493ac77152 100644 --- a/interface/wx/cshelp.h +++ b/interface/wx/cshelp.h @@ -2,8 +2,7 @@ // Name: cshelp.h // Purpose: interface of wxHelpProvider // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -66,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. @@ -163,7 +162,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: @@ -232,7 +231,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 @@ -256,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.