From 33fe4b1837cd76c4ecf8ff623856a38f8998f222 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Fri, 5 Dec 2014 22:17:27 +0000 Subject: [PATCH] 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 --- interface/wx/frame.h | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/interface/wx/frame.h b/interface/wx/frame.h index 6a16f9ac66..b1cf02d6f3 100644 --- a/interface/wx/frame.h +++ b/interface/wx/frame.h @@ -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.