// 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.
@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);
};
/**
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
class wxContextHelpButton : public wxBitmapButton
{
public:
- /// Default constructor.
- wxContextHelpButton();
-
/**
Constructor, creating and showing a context help button.
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.