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

NAME

6       wxNavigationKeyEvent - Functions for wxNavigationKeyEvent class
7

DESCRIPTION

9       This  event  class contains information about navigation events, gener‐
10       ated by navigation keys such as tab and page down.
11
12       This event is mainly used by wxWidgets implementations. A wxNavigation‐
13       KeyEvent handler is automatically provided by wxWidgets when you enable
14       keyboard navigation inside a window by inheriting it from  wxNavigatio‐
15       nEnabled<>.
16
17       See: wxWindow:navigate/2, wxWindow::NavigateIn (not implemented in wx)
18
19       This class is derived (and can use functions) from: wxEvent
20
21       wxWidgets docs: wxNavigationKeyEvent
22

EVENTS

24       Use  wxEvtHandler:connect/3  with wxNavigationKeyEventType to subscribe
25       to events of this type.
26

DATA TYPES

28       wxNavigationKeyEvent() = wx:wx_object()
29
30       wxNavigationKey() =
31           #wxNavigationKey{type =
32                                wxNavigationKeyEvent:wxNavigationKeyEventType(),
33                            dir = boolean(),
34                            focus = wxWindow:wxWindow()}
35
36       wxNavigationKeyEventType() = navigation_key
37

EXPORTS

39       getDirection(This) -> boolean()
40
41              Types:
42
43                 This = wxNavigationKeyEvent()
44
45              Returns true if the navigation was in the forward direction.
46
47       setDirection(This, Direction) -> ok
48
49              Types:
50
51                 This = wxNavigationKeyEvent()
52                 Direction = boolean()
53
54              Sets the direction to forward if direction is true, or  backward
55              if false.
56
57       isWindowChange(This) -> boolean()
58
59              Types:
60
61                 This = wxNavigationKeyEvent()
62
63              Returns  true if the navigation event represents a window change
64              (for example, from Ctrl-Page Down in a notebook).
65
66       setWindowChange(This, WindowChange) -> ok
67
68              Types:
69
70                 This = wxNavigationKeyEvent()
71                 WindowChange = boolean()
72
73              Marks the event as a window change event.
74
75       isFromTab(This) -> boolean()
76
77              Types:
78
79                 This = wxNavigationKeyEvent()
80
81              Returns true if the navigation event was from a tab key.
82
83              This is required for proper navigation over radio buttons.
84
85       setFromTab(This, FromTab) -> ok
86
87              Types:
88
89                 This = wxNavigationKeyEvent()
90                 FromTab = boolean()
91
92              Marks the navigation event as from a tab key.
93
94       getCurrentFocus(This) -> wxWindow:wxWindow()
95
96              Types:
97
98                 This = wxNavigationKeyEvent()
99
100              Returns the child that has the focus, or NULL.
101
102       setCurrentFocus(This, CurrentFocus) -> ok
103
104              Types:
105
106                 This = wxNavigationKeyEvent()
107                 CurrentFocus = wxWindow:wxWindow()
108
109              Sets the current focus window member.
110
111
112
113wxWidgets team.                    wx 2.3.1            wxNavigationKeyEvent(3)