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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.ContextHelp:
==========================================================================================================================================
|phoenix_title| **wx.ContextHelp**
==========================================================================================================================================
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: ::
contextHelp = wx.ContextHelp(myWindow)
There are a couple of ways to invoke this behaviour implicitly:
- Use the ``wx.DIALOG_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.
- Create a :ref:`wx.ContextHelpButton`, 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 ``wx.DIALOG_EX_CONTEXTHELP`` on Windows).
Note that on Mac OS X, the cursor does not change when in context-sensitive help mode.
.. seealso:: :ref:`wx.HelpEvent`, :ref:`HelpController`, :ref:`wx.ContextHelpButton`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>ContextHelp</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.ContextHelp_inheritance.png" alt="Inheritance diagram of ContextHelp" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Object.html" title="wx.Object" alt="" coords="24,5,105,35"/> <area shape="rect" id="node2" href="wx.ContextHelp.html" title="wx.ContextHelp" alt="" coords="5,83,125,112"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ContextHelp.__init__` Constructs a context help object, calling :meth:`~ContextHelp.BeginContextHelp` if `doNow` is ``True`` (the default).
:meth:`~wx.ContextHelp.BeginContextHelp` Puts the application into context-sensitive help mode.
:meth:`~wx.ContextHelp.EndContextHelp` Ends context-sensitive help mode.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ContextHelp(Object)
**Possible constructors**::
ContextHelp(window=None, doNow=True)
This class changes the cursor to a query and puts the application into
a 'context-sensitive help mode'.
.. method:: __init__(self, window=None, doNow=True)
Constructs a context help object, calling :meth:`BeginContextHelp` if `doNow` is ``True`` (the default).
If `window` is ``None``, the top window is used.
:param `window`:
:type `window`: wx.Window
:param `doNow`:
:type `doNow`: bool
.. method:: BeginContextHelp(self, window)
Puts the application into context-sensitive help mode.
`window` is the window which will be used to catch events; if ``None``, 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.
:param `window`:
:type `window`: wx.Window
:rtype: `bool`
.. method:: EndContextHelp(self)
Ends context-sensitive help mode.
Not normally called by the application.
:rtype: `bool`
|
