Class: Wx::AUI::AuiNotebookEvent

Inherits:

BookCtrlEvent

• Object
• Object
• Event
• CommandEvent
• NotifyEvent
• BookCtrlEvent
• Wx::AUI::AuiNotebookEvent

Defined in:

lib/wx/doc/gen/aui/aui_notebook_event.rb

Overview

This class is used by the events generated by AuiNotebook.

Events emitted by this class

The following event-handler methods redirect the events to member method or handler blocks for AuiNotebookEvent events. Event handler methods for events emitted by this class:

• EvtHandler#evt_auinotebook_page_close(id, meth = nil, &block): A page is about to be closed. Processes a EVT_AUINOTEBOOK_PAGE_CLOSE event.

• EvtHandler#evt_auinotebook_page_closed(winid, meth = nil, &block): A page has been closed. Processes a EVT_AUINOTEBOOK_PAGE_CLOSED event.

• EvtHandler#evt_auinotebook_page_changed(id, meth = nil, &block): The page selection was changed. Processes a EVT_AUINOTEBOOK_PAGE_CHANGED event.

• EvtHandler#evt_auinotebook_page_changing(id, meth = nil, &block): The page selection is about to be changed. Processes a EVT_AUINOTEBOOK_PAGE_CHANGING event. This event can be vetoed.

• EvtHandler#evt_auinotebook_button(id, meth = nil, &block): The window list button has been pressed. Processes a EVT_AUINOTEBOOK_BUTTON event.

• EvtHandler#evt_auinotebook_begin_drag(id, meth = nil, &block): Dragging is about to begin. Processes a EVT_AUINOTEBOOK_BEGIN_DRAG event.

• EvtHandler#evt_auinotebook_end_drag(id, meth = nil, &block): Dragging has ended. Processes a EVT_AUINOTEBOOK_END_DRAG event.

• EvtHandler#evt_auinotebook_drag_motion(id, meth = nil, &block): Emitted during a drag and drop operation. Processes a EVT_AUINOTEBOOK_DRAG_MOTION event.

• EvtHandler#evt_auinotebook_allow_dnd(id, meth = nil, &block): Whether to allow a tab to be dropped. Processes a EVT_AUINOTEBOOK_ALLOW_DND event. This event must be specially allowed.

• EvtHandler#evt_auinotebook_drag_done(winid, meth = nil, &block): Notify that the tab has been dragged. Processes a EVT_AUINOTEBOOK_DRAG_DONE event.

• EvtHandler#evt_auinotebook_tab_middle_down(winid, meth = nil, &block): The middle mouse button is pressed on a tab. Processes a EVT_AUINOTEBOOK_TAB_MIDDLE_DOWN event.

• EvtHandler#evt_auinotebook_tab_middle_up(winid, meth = nil, &block): The middle mouse button is released on a tab. Processes a EVT_AUINOTEBOOK_TAB_MIDDLE_UP event.

• EvtHandler#evt_auinotebook_tab_right_down(winid, meth = nil, &block): The right mouse button is pressed on a tab. Processes a EVT_AUINOTEBOOK_TAB_RIGHT_DOWN event.

• EvtHandler#evt_auinotebook_tab_right_up(winid, meth = nil, &block): The right mouse button is released on a tab. Processes a EVT_AUINOTEBOOK_TAB_RIGHT_UP event.

• EvtHandler#evt_auinotebook_bg_dclick(winid, meth = nil, &block): Double clicked on the tabs background area. Processes a EVT_AUINOTEBOOK_BG_DCLICK event.

Category: Events, Book Controls

See Also:

• AuiNotebook
• BookCtrlEvent

Requires:

• USE_AUI

Instance Method Summary

• #clone ⇒ Wx::Event
• #initialize(command_type = Wx::EVT_NULL, win_id = 0) ⇒ Wx::AUI::AuiNotebookEvent constructor

  Constructor.

Methods inherited from BookCtrlEvent

#get_old_selection, #get_selection, #set_old_selection, #set_selection

Methods inherited from NotifyEvent

#allow, #is_allowed, #veto

Methods inherited from CommandEvent

#client_data, #client_data=, #get_client_data, #get_client_object, #get_int, #get_selection, #get_string, #is_checked, #is_selection, #set_client_data, #set_client_object, #set_extra_long, #set_int, #set_string

Methods inherited from Event

#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

#dup, #is_same_as, #un_share

Constructor Details

#initialize(command_type = Wx::EVT_NULL, win_id = 0) ⇒ Wx::AUI::AuiNotebookEvent

Constructor.

Parameters:

• command_type (Wx::GenericCollapsiblePane::EventType) (defaults to: Wx::EVT_NULL)
• win_id (Integer) (defaults to: 0)

# File 'lib/wx/doc/gen/aui/aui_notebook_event.rb', line 189

def initialize(command_type=Wx::EVT_NULL, win_id=0) end

Instance Method Details

#clone ⇒ Wx::Event

Returns:

• (Wx::Event)

# File 'lib/wx/doc/gen/aui/aui_notebook_event.rb', line 192

def clone; end