// Name: cshelp.h
// Purpose: interface of wxHelpProvider
// Author: wxWidgets team
-// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
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.
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:
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
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.