Class: Wx::NavigationKeyEvent

Inherits:
Event show all
Defined in:
lib/wx/doc/gen/events.rb

Overview

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 NavigationKeyEvent handler is automatically provided by wxWidgets when you enable keyboard navigation inside a window by inheriting it from NavigationEnabled<>.

Events using this class

The following event-handler methods redirect the events to member method or handler blocks for NavigationKeyEvent events. Event handler methods:

Category: Events

See Also:

Defined Under Namespace

Classes: NavigationKeyEventFlags

Instance Method Summary collapse

Methods inherited from Event

#clone, #get_event_category, #get_event_object, #get_event_type, #get_id, #get_skipped, #get_timestamp, #is_command_event, #resume_propagation, #set_event_object, #set_event_type, #set_id, #set_timestamp, #should_propagate, #skip, #stop_propagation

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::NavigationKeyEvent #initialize(event) ⇒ Wx::NavigationKeyEvent

Returns a new instance of NavigationKeyEvent.

Overloads:



2526
 
# File 'lib/wx/doc/gen/events.rb', line 2526

def initialize(*args) end

Instance Method Details

#get_current_focus ⇒ Wx::Window Also known as: current_focus

Returns the child that has the focus, or NULL.

Returns:



2530
 
# File 'lib/wx/doc/gen/events.rb', line 2530

def get_current_focus; end

#get_direction ⇒ Boolean Also known as: direction

Returns true if the navigation was in the forward direction.

Returns:

  • (Boolean) 


2535
 
# File 'lib/wx/doc/gen/events.rb', line 2535

def get_direction; end

#is_from_tab ⇒ Boolean Also known as: from_tab?

Returns true if the navigation event was from a tab key.

This is required for proper navigation over radio buttons.

Returns:

  • (Boolean) 


2542
 
# File 'lib/wx/doc/gen/events.rb', line 2542

def is_from_tab; end

#is_window_change ⇒ Boolean Also known as: window_change?

Returns true if the navigation event represents a window change (for example, from Ctrl-Page Down in a notebook).

Returns:

  • (Boolean) 


2547
 
# File 'lib/wx/doc/gen/events.rb', line 2547

def is_window_change; end

#set_current_focus(currentFocus) ⇒ void Also known as: current_focus=

This method returns an undefined value.

Sets the current focus window member.

Parameters:



2553
 
# File 'lib/wx/doc/gen/events.rb', line 2553

def set_current_focus(currentFocus) end

#set_direction(direction) ⇒ void Also known as: direction=

This method returns an undefined value.

Sets the direction to forward if direction is true, or backward if false.

Parameters:

  • direction (Boolean) 


2559
 
# File 'lib/wx/doc/gen/events.rb', line 2559

def set_direction(direction) end

#set_flags(flags) ⇒ void Also known as: flags=

This method returns an undefined value.

Sets the flags for this event.

The flags can be a combination of the NavigationKeyEventFlags values.

Parameters:

  • flags (Integer) 


2567
 
# File 'lib/wx/doc/gen/events.rb', line 2567

def set_flags(flags) end

#set_from_tab(fromTab) ⇒ void Also known as: from_tab=

This method returns an undefined value.

Marks the navigation event as from a tab key.

Parameters:

  • fromTab (Boolean) 


2573
 
# File 'lib/wx/doc/gen/events.rb', line 2573

def set_from_tab(fromTab) end

#set_window_change(windowChange) ⇒ void Also known as: window_change=

This method returns an undefined value.

Marks the event as a window change event.

Parameters:

  • windowChange (Boolean) 


2579
 
# File 'lib/wx/doc/gen/events.rb', line 2579

def set_window_change(windowChange) end