Added context-sensitive help docs
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@8497 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
74
docs/latex/wx/helpprov.tex
Normal file
74
docs/latex/wx/helpprov.tex
Normal file
@@ -0,0 +1,74 @@
|
||||
\section{\class{wxHelpProvider}}\label{wxhelpprovider}
|
||||
|
||||
wxHelpProvider is an abstract class used by a program implementing context-sensitive help to
|
||||
show the help text for the given window.
|
||||
|
||||
The current help provider must be explicitly set by the application using
|
||||
wxHelpProvider::Set().
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
No base class
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxHelpContext}{wxhelpcontext}, \helpref{wxHelpContextButton}{wxhelpcontextbutton},
|
||||
\helpref{wxSimpleHelpProvider}{wxsimplehelpprovider}, \helpref{wxHelpControllerHelpProvider}{wxhelpcontrollerhelpprovider},
|
||||
\helpref{wxWindow::SetHelpText}{wxwindowsethelptext}, \helpref{wxWindow::GetHelpText}{wxwindowgethelptext}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxHelpProvider::\destruct{wxHelpProvider}}\label{wxhelpproviderdtor}
|
||||
|
||||
\func{}{\destruct{wxHelpProvider}}{\void}
|
||||
|
||||
Virtual destructor for any base class.
|
||||
|
||||
\membersection{wxHelpProvider::Set}\label{wxhelpproviderset}
|
||||
|
||||
\func{wxHelpProvider*}{Set}{\param{wxHelpProvider* }{helpProvider}}
|
||||
|
||||
Get/set the current, application-wide help provider. Returns
|
||||
the previous one.
|
||||
|
||||
\membersection{wxHelpProvider::Get}\label{wxhelpproviderget}
|
||||
|
||||
\func{wxHelpProvider*}{Get}{\void}
|
||||
|
||||
Unlike some other classes, the help provider is not created on demand.
|
||||
This must be explicitly done by the application.
|
||||
|
||||
\membersection{wxHelpProvider::GetHelp}\label{wxhelpprovidergethelp}
|
||||
|
||||
\func{wxString}{GetHelp}{\param{const wxWindowBase* }{window}}
|
||||
|
||||
Gets the help string for this window. Its interpretation is dependent on the help provider
|
||||
except that empty string always means that no help is associated with
|
||||
the window.
|
||||
|
||||
\membersection{wxHelpProvider::ShowHelp}\label{wxhelpprovidershowhelp}
|
||||
|
||||
\func{bool}{ShowHelp}{\param{wxWindowBase* }{window}}
|
||||
|
||||
Shows help for the given window. Uses \helpref{GetHelp}{wxhelpprovidergethelp} internally if
|
||||
applicable.
|
||||
|
||||
Returns TRUE if it was done, or FALSE if no help was available
|
||||
for this window.
|
||||
|
||||
\membersection{wxHelpProvider::AddHelp}\label{wxhelpprovideraddhelp}
|
||||
|
||||
\func{void}{AddHelp}{\param{wxWindowBase* }{window}, \param{const wxString\& }{text}}
|
||||
|
||||
Associates the text with the given window or id. Although all help
|
||||
providers have these functions to allow making \helpref{wxWindow::SetHelpText}{wxwindowsethelptext}
|
||||
work, not all of them implement the functions.
|
||||
|
||||
\membersection{wxHelpProvider::AddHelp}\label{wxhelpprovideraddhelp}
|
||||
|
||||
\func{void}{AddHelp}{\param{wxWindowID }{id}, \param{const wxString\& }{text}}
|
||||
|
||||
This version associates the given text with all windows with this id.
|
||||
May be used to set the same help string for all Cancel buttons in
|
||||
the application, for example.
|
||||
|
Reference in New Issue
Block a user