1wxHelpEvent(3)             Erlang Module Definition             wxHelpEvent(3)
2
3
4

NAME

6       wxHelpEvent - Functions for wxHelpEvent class
7

DESCRIPTION

9       A  help  event  is  sent  when the user has requested context-sensitive
10       help. This can either be caused by the application requesting  context-
11       sensitive  help  mode via wxContextHelp (not implemented in wx), or (on
12       MS Windows) by the system generating a WM_HELP message  when  the  user
13       pressed F1 or clicked on the query button in a dialog caption.
14
15       A  help  event  is  sent to the window that the user clicked on, and is
16       propagated up the window hierarchy until  the  event  is  processed  or
17       there are no more event handlers.
18
19       The  application  should  call wxEvent:getId/1 to check the identity of
20       the clicked-on window, and then either show some suitable help or  call
21       wxEvent:skip/2 if the identifier is unrecognised.
22
23       Calling  Skip is important because it allows wxWidgets to generate fur‐
24       ther events for ancestors of the clicked-on window. Otherwise it  would
25       be  impossible  to  show  help  for container windows, since processing
26       would stop after the first window found.
27
28       See: wxContextHelp (not implemented in wx), wxDialog, Overview events
29
30       This class is derived (and can use functions) from: wxEvent
31
32       wxWidgets docs: wxHelpEvent
33

EVENTS

35       Use wxEvtHandler:connect/3 with wxHelpEventType to subscribe to  events
36       of this type.
37

DATA TYPES

39       wxHelpEvent() = wx:wx_object()
40
41       wxHelp() = #wxHelp{type = wxHelpEvent:wxHelpEventType()}
42
43       wxHelpEventType() = help | detailed_help
44

EXPORTS

46       getOrigin(This) -> wx:wx_enum()
47
48              Types:
49
50                 This = wxHelpEvent()
51
52              Returns  the  origin  of  the help event which is one of the wx‐
53              HelpEvent::Origin (not implemented in wx) values.
54
55              The application may handle events generated using  the  keyboard
56              or  mouse  differently, e.g. by using wx_misc:getMousePosition/0
57              for the mouse events.
58
59              See: setOrigin/2
60
61       getPosition(This) -> {X :: integer(), Y :: integer()}
62
63              Types:
64
65                 This = wxHelpEvent()
66
67              Returns the left-click position of the mouse, in screen  coordi‐
68              nates.
69
70              This allows the application to position the help appropriately.
71
72       setOrigin(This, Origin) -> ok
73
74              Types:
75
76                 This = wxHelpEvent()
77                 Origin = wx:wx_enum()
78
79              Set  the  help  event  origin, only used internally by wxWidgets
80              normally.
81
82              See: getOrigin/1
83
84       setPosition(This, Pt) -> ok
85
86              Types:
87
88                 This = wxHelpEvent()
89                 Pt = {X :: integer(), Y :: integer()}
90
91              Sets the left-click position of the  mouse,  in  screen  coordi‐
92              nates.
93
94
95
96wxWidgets team.                    wx 2.1.4                     wxHelpEvent(3)
Impressum