1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
\section{\class{wxContextHelp}}\label{wxcontexthelp}
This class changes the cursor to a query and puts the application into a 'context-sensitive help mode'.
When the user left-clicks on a window within the specified window, a wxEVT\_HELP event is
sent to that control, and the application may respond to it by popping up some help.
For example:
\begin{verbatim}
wxContextHelp contextHelp(myWindow);
\end{verbatim}
There are a couple of ways to invoke this behaviour implicitly:
\begin{itemize}
\item Use the wxDIALOG\_EX\_CONTEXTHELP style for a dialog (Windows only). This will put a question mark
in the titlebar, and Windows will put the application into context-sensitive help mode automatically,
with further programming.
\item Create a \helpref{wxContextHelpButton}{wxcontexthelpbutton}, whose predefined behaviour is to create a context help object.
Normally you will write your application so that this button is only added to a dialog for non-Windows platforms
(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{Include files}
<wx/cshelp.h>
\wxheading{See also}
\helpref{wxHelpEvent}{wxhelpevent},
\helpref{wxHelpController}{wxhelpcontroller},
\helpref{wxContextHelpButton}{wxcontexthelpbutton}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxContextHelp::wxContextHelp}\label{wxcontexthelpctor}
\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).
If {\it window} is NULL, the top window is used.
\membersection{wxContextHelp::\destruct{wxContextHelp}}\label{wxcontexthelpdtor}
\func{}{\destruct{wxContextHelp}}{\void}
Destroys the context help object.
\membersection{wxContextHelp::BeginContextHelp}\label{wxcontexthelpbegincontexthelp}
\func{bool}{BeginContextHelp}{\param{wxWindow*}{ window = NULL}}
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.
This function only returns when the event loop has finished.
\membersection{wxContextHelp::EndContextHelp}\label{wxcontexthelpendcontexthelp}
\func{bool}{EndContextHelp}{\void}
Ends context-sensitive help mode. Not normally called by the application.
\section{\class{wxContextHelpButton}}\label{wxcontexthelpbutton}
Instances of this class may be used to add a question mark button that when pressed, puts the
application into context-help mode. It does this by creating a \helpref{wxContextHelp}{wxcontexthelp} object which itself
generates a wxEVT\_HELP event when the user clicks on a window.
On Windows, you may add a question-mark icon to a dialog by use of the wxDIALOG\_EX\_CONTEXTHELP extra style, but
on other platforms you will have to add a button explicitly, usually next to OK, Cancel or similar buttons.
\wxheading{Derived from}
\helpref{wxBitmapButton}{wxbitmapbutton}\\
\helpref{wxButton}{wxbutton}\\
\helpref{wxControl}{wxcontrol}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/cshelp.h>
\wxheading{See also}
\helpref{wxBitmapButton}{wxbitmapbutton}, \helpref{wxContextHelp}{wxcontexthelp}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxContextHelpButton::wxContextHelpButton}\label{wxcontexthelpbuttonconstr}
\func{}{wxContextHelpButton}{\void}
Default constructor.
\func{}{wxContextHelpButton}{
\param{wxWindow* }{parent},
\param{wxWindowID }{id = wxID\_CONTEXT\_HELP},
\param{const wxPoint\& }{pos = wxDefaultPosition},
\param{const wxSize\& }{size = wxDefaultSize},
\param{long }{style = wxBU\_AUTODRAW}}
Constructor, creating and showing a context help button.
\wxheading{Parameters}
\docparam{parent}{Parent window. Must not be NULL.}
\docparam{id}{Button identifier. Defaults to wxID\_CONTEXT\_HELP.}
\docparam{pos}{Button position.}
\docparam{size}{Button size. If the default size (-1, -1) is specified then the button is sized
appropriately for the question mark bitmap.}
\docparam{style}{Window style.}
\wxheading{Remarks}
Normally you need pass only the parent window to the constructor, and use the defaults for the remaining parameters.
|
