added wxMessageQueue class for inter-thread communications

[wxWidgets.git] / docs / latex / wx / cshelp.tex

diff --git a/docs/latex/wx/cshelp.tex b/docs/latex/wx/cshelp.tex
index 8e3d862ca28b484f20caaca14f247be53dd84c90..647578499f115d110e24dc4927f3e214cd07775b 100644 (file)
--- 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}
 
 (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}
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}


@@ -29,6 +32,10 @@ Normally you will write your application so that this button is only added to a
 
 <wx/cshelp.h>
 
 
 <wx/cshelp.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxHelpEvent}{wxhelpevent}, 
 \wxheading{See also}
 
 \helpref{wxHelpEvent}{wxhelpevent}, 


@@ -37,16 +44,16 @@ Normally you will write your application so that this button is only added to a
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \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
 
 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.
 
 
 If {\it window} is NULL, the top window is used.
 

-\membersection{wxContextHelp::\destruct{wxContextHelp}}
+\membersection{wxContextHelp::\destruct{wxContextHelp}}\label{wxcontexthelpdtor}

 
 \func{}{\destruct{wxContextHelp}}{\void}
 
 
 \func{}{\destruct{wxContextHelp}}{\void}
 


@@ -59,7 +66,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.
 
 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}
 This function only returns when the event loop has finished.
 
 \membersection{wxContextHelp::EndContextHelp}\label{wxcontexthelpendcontexthelp}


@@ -90,6 +97,10 @@ on other platforms you will have to add a button explicitly, usually next to OK,
 
 <wx/cshelp.h>
 
 
 <wx/cshelp.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxBitmapButton}{wxbitmapbutton}, \helpref{wxContextHelp}{wxcontexthelp}
 \wxheading{See also}
 
 \helpref{wxBitmapButton}{wxbitmapbutton}, \helpref{wxContextHelp}{wxcontexthelp}


@@ -104,7 +115,7 @@ Default constructor.
 
 \func{}{wxContextHelpButton}{
 \param{wxWindow* }{parent}, 
 
 \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}}
 \param{const wxPoint\& }{pos = wxDefaultPosition}, 
 \param{const wxSize\& }{size = wxDefaultSize}, 
 \param{long }{style = wxBU\_AUTODRAW}}