wxNavigationKeyEvent Class Reference
[Events]
#include <wx/event.h>
Detailed Description
This event class contains information about navigation events, generated by navigation keys such as tab and page down.This event is mainly used by wxWidgets implementations. A wxNavigationKeyEvent handler is automatically provided by wxWidgets when you make a class into a control container with the macro WX_DECLARE_CONTROL_CONTAINER.
Events:
The following event handler macros redirect the events to member function handlers 'func' with prototypes like:
Event macros:
- EVT_NAVIGATION_KEY(func):Process a navigation key event.
- See also:
- wxWindow::Navigate, wxWindow::NavigateIn
Public Member Functions | |
| wxNavigationKeyEvent () | |
| wxNavigationKeyEvent (const wxNavigationKeyEvent &event) | |
| wxWindow * | GetCurrentFocus () const |
| bool | GetDirection () const |
| bool | IsFromTab () const |
| bool | IsWindowChange () const |
| void | SetCurrentFocus (wxWindow *currentFocus) |
| void | SetDirection (bool direction) |
| void | SetFlags (long flags) |
| void | SetFromTab (bool fromTab) |
| void | SetWindowChange (bool windowChange) |
Constructor & Destructor Documentation
| wxNavigationKeyEvent::wxNavigationKeyEvent | ( | ) |
| wxNavigationKeyEvent::wxNavigationKeyEvent | ( | const wxNavigationKeyEvent & | event | ) |
Member Function Documentation
| wxWindow* wxNavigationKeyEvent::GetCurrentFocus | ( | ) | const |
Returns the child that has the focus, or NULL.
| bool wxNavigationKeyEvent::GetDirection | ( | ) | const |
Returns true if the navigation was in the forward direction.
| bool wxNavigationKeyEvent::IsFromTab | ( | ) | const |
Returns true if the navigation event was from a tab key. This is required for proper navigation over radio buttons.
| bool wxNavigationKeyEvent::IsWindowChange | ( | ) | const |
Returns true if the navigation event represents a window change (for example, from Ctrl-Page Down in a notebook).
| void wxNavigationKeyEvent::SetCurrentFocus | ( | wxWindow * | currentFocus | ) |
Sets the current focus window member.
| void wxNavigationKeyEvent::SetDirection | ( | bool | direction | ) |
Sets the direction to forward if direction is true, or backward if false.
| void wxNavigationKeyEvent::SetFlags | ( | long | flags | ) |
Sets the flags for this event. The flags can be a combination of the wxNavigationKeyEventFlags values.
| void wxNavigationKeyEvent::SetFromTab | ( | bool | fromTab | ) |
Marks the navigation event as from a tab key.
| void wxNavigationKeyEvent::SetWindowChange | ( | bool | windowChange | ) |
Marks the event as a window change event.
