X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7cb74906e1ea58aad0cca0a38d1cf87834f577e9..43f06cfda107a4a74776b58dca3353a4414ecfb1:/docs/latex/wx/cshelp.tex?ds=sidebyside diff --git a/docs/latex/wx/cshelp.tex b/docs/latex/wx/cshelp.tex index 8e3d862ca2..2c4e0d04a4 100644 --- a/docs/latex/wx/cshelp.tex +++ b/docs/latex/wx/cshelp.tex @@ -21,6 +21,9 @@ Normally you will write your application so that this button is only added to a (use wxDIALOG\_EX\_CONTEXTHELP on Windows). \end{itemize} +Note that on Mac OS X, the cursor does not change when in context-sensitive +help mode. + \wxheading{Derived from} \helpref{wxObject}{wxobject} @@ -37,16 +40,16 @@ Normally you will write your application so that this button is only added to a \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxContextHelp::wxContextHelp} +\membersection{wxContextHelp::wxContextHelp}\label{wxcontexthelpctor} -\func{}{wxContextHelp}{\param{wxWindow*}{ window = NULL}, \param{bool}{ doNow = TRUE}} +\func{}{wxContextHelp}{\param{wxWindow*}{ window = NULL}, \param{bool}{ doNow = true}} Constructs a context help object, calling \helpref{BeginContextHelp}{wxcontexthelpbegincontexthelp} if\rtfsp -{\it doNow} is TRUE (the default). +{\it doNow} is true (the default). If {\it window} is NULL, the top window is used. -\membersection{wxContextHelp::\destruct{wxContextHelp}} +\membersection{wxContextHelp::\destruct{wxContextHelp}}\label{wxcontexthelpdtor} \func{}{\destruct{wxContextHelp}}{\void} @@ -59,7 +62,7 @@ Destroys the context help object. Puts the application into context-sensitive help mode. {\it 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. +Returns true if the application was successfully put into context-sensitive help mode. This function only returns when the event loop has finished. \membersection{wxContextHelp::EndContextHelp}\label{wxcontexthelpendcontexthelp} @@ -104,7 +107,7 @@ Default constructor. \func{}{wxContextHelpButton}{ \param{wxWindow* }{parent}, -\param{wxWindowID }{id = wxID\_CONTEXT_HELP}, +\param{wxWindowID }{id = wxID\_CONTEXT\_HELP}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxBU\_AUTODRAW}}