]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/navevent.tex
interface headers reviewed
[wxWidgets.git] / docs / latex / wx / navevent.tex
1 \section{\class{wxNavigationKeyEvent}}\label{wxnavigationkeyevent}
2
3 This event class contains information about navigation events,
4 generated by navigation keys such as tab and page down.
5
6 This event is mainly used by wxWidgets implementations. A
7 wxNavigationKeyEvent handler is automatically provided by wxWidgets
8 when you make a class into a control container with the macro WX\_DECLARE\_CONTROL\_CONTAINER.
9
10 \wxheading{Derived from}
11
12 \helpref{wxEvent}{wxevent}\\
13 \helpref{wxObject}{wxobject}
14
15 \wxheading{Include files}
16
17 <wx/event.h>
18
19 \wxheading{Library}
20
21 \helpref{wxCore}{librarieslist}
22
23 \wxheading{Event table macros}
24
25 To process a navigation command event, use these event handler macros to direct input to member
26 functions that take a wxNavigationKeyEvent argument.
27
28 \twocolwidtha{7cm}
29 \begin{twocollist}\itemsep=0pt
30 \twocolitem{{\bf EVT\_NAVIGATION\_KEY(func)}}{Process a navigation key event.}
31 \end{twocollist}%
32
33 \latexignore{\rtfignore{\wxheading{Types}}}
34
35 \begin{verbatim}
36 enum
37 {
38 IsBackward = 0x0000,
39 IsForward = 0x0001,
40 WinChange = 0x0002,
41 FromTab = 0x0004
42 };
43 \end{verbatim}
44
45 \wxheading{See also}
46
47 \helpref{wxWindow::Navigate}{wxwindownavigate}\\
48 \helpref{wxWindow::NavigateIn}{wxwindownavigatein}
49
50
51 \latexignore{\rtfignore{\wxheading{Members}}}
52
53 \membersection{wxNavigationKeyEvent::wxNavigationKeyEvent}\label{wxnavigationkeyeventctor}
54
55 \func{}{wxNavigationKeyEvent}{\void}
56
57 \func{}{wxNavigationKeyEvent}{\param{const wxNavigationKeyEvent\&}{ event}}
58
59 Constructor.
60
61 \membersection{wxNavigationKeyEvent::GetCurrentFocus}\label{wxnavigationkeyeventgetcurrentfocus}
62
63 \constfunc{wxWindow*}{GetCurrentFocus}{\void}
64
65 Returns the child that has the focus, or NULL.
66
67 \membersection{wxNavigationKeyEvent::GetDirection}\label{wxnavigationkeyeventgetdirection}
68
69 \constfunc{bool}{GetDirection}{\void}
70
71 Returns \true if the navigation was in the forward direction.
72
73 \membersection{wxNavigationKeyEvent::IsWindowChange}\label{wxnavigationkeyeventiswindowchange}
74
75 \constfunc{bool}{IsWindowChange}{\void}
76
77 Returns \true if the navigation event represents a window change (for example, from Ctrl-Page Down
78 in a notebook).
79
80 \membersection{wxNavigationKeyEvent::IsFromTab}\label{wxnavigationkeyeventisfromtab}
81
82 \constfunc{bool}{IsFromTab}{\void}
83
84 Returns \true if the navigation event was from a tab key. This is required for proper navigation over radio buttons.
85
86 \membersection{wxNavigationKeyEvent::SetCurrentFocus}\label{wxnavigationkeyeventsetcurrentfocus}
87
88 \func{void}{SetCurrentFocus}{\param{wxWindow* }{currentFocus}}
89
90 Sets the current focus window member.
91
92 \membersection{wxNavigationKeyEvent::SetDirection}\label{wxnavigationkeyeventsetdirection}
93
94 \func{void}{SetDirection}{\param{bool }{direction}}
95
96 Sets the direction to forward if {\it direction} is \true, or backward if \false.
97
98 \membersection{wxNavigationKeyEvent::SetFlags}\label{wxnavigationkeyeventsetflags}
99
100 \func{void}{SetFlags}{\param{long }{flags}}
101
102 Sets the flags.
103
104 \membersection{wxNavigationKeyEvent::SetFromTab}\label{wxnavigationkeyeventsetfromtab}
105
106 \func{void}{SetFromTab}{\param{bool }{fromTab}}
107
108 Marks the navigation event as from a tab key.
109
110 \membersection{wxNavigationKeyEvent::SetWindowChange}\label{wxnavigationkeyeventsetwindowchange}
111
112 \func{void}{SetWindowChange}{\param{bool }{windowChange}}
113
114 Marks the event as a window change event.
115