Document the long existing wxFrame::DoGiveHelp().
This function was added way back in 2002 (r15339) but was never documented. Do it now as it's a useful method to override for customizing the help strings display. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@78223 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
parent
90639b8339
commit
33fe4b1837
@ -277,6 +277,26 @@ public:
|
||||
wxWindowID id = wxID_ANY,
|
||||
const wxString& name = wxToolBarNameStr);
|
||||
|
||||
/**
|
||||
Method used to show help string of the selected menu toolbar item.
|
||||
|
||||
This method is called by the default @c wxEVT_MENU_HIGHLIGHT event
|
||||
handler and also by wxToolBar to show the optional help string
|
||||
associated with the selected menu or toolbar item. It can be overridden
|
||||
if the default behaviour of showing this string in the frame status bar
|
||||
is not appropriate.
|
||||
|
||||
@param text The help string to show, may be empty. The default
|
||||
implementation simply shows this string in the frame status bar
|
||||
(after remembering its previous text to restore it later).
|
||||
@param show Whether the help should be shown or hidden. The default
|
||||
implementation restores the previously saved status bar text when
|
||||
it is @false.
|
||||
|
||||
@see SetStatusBarPane()
|
||||
*/
|
||||
virtual void DoGiveHelp(const wxString& text, bool show);
|
||||
|
||||
/**
|
||||
Returns the origin of the frame client area (in client coordinates).
|
||||
It may be different from (0, 0) if the frame has a toolbar.
|
||||
|
Loading…
Reference in New Issue
Block a user