Class: Wx::AUI::AuiManagerEvent

Inherits:

Event

• Object
• Object
• Event
• Wx::AUI::AuiManagerEvent

Defined in:

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

Overview

Event used to indicate various actions taken with AuiManager.

See AuiManager for available event types.

Events using this class

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

• EvtHandler#evt_aui_pane_button(meth = nil, &block): Triggered when any button is pressed for any docked panes.

• EvtHandler#evt_aui_pane_close(meth = nil, &block): Triggered when a docked or floating pane is closed.

• EvtHandler#evt_aui_pane_maximize(meth = nil, &block): Triggered when a pane is maximized.

• EvtHandler#evt_aui_pane_restore(meth = nil, &block): Triggered when a pane is restored.

• EvtHandler#evt_aui_pane_activated(meth = nil, &block): Triggered when a pane is made 'active'. This event is new since wxWidgets 2.9.4.

• EvtHandler#evt_aui_render(meth = nil, &block): This event can be caught to override the default renderer in order to custom draw your AuiManager window (not recommended).

Category: Events, Window Docking (wxAUI)

See Also:

• AuiManager
• AuiPaneInfo

Requires:

• USE_AUI

Instance Method Summary

• #can_veto ⇒ Boolean (also: #can_veto?)

  true if this event can be vetoed.

• #get_button ⇒ Integer (also: #button)

  The ID of the button that was clicked.

• #get_dc ⇒ Wx::DC (also: #dc)

  TodoWhat is this?.

• #get_manager ⇒ Wx::AUI::AuiManager (also: #manager)

  The AuiManager this event is associated with.

• #get_pane ⇒ Wx::AUI::AuiPaneInfo (also: #pane)

  The pane this event is associated with.

• #get_veto ⇒ Boolean

  true if this event was vetoed.

• #initialize(type = Wx::EVT_NULL) ⇒ Wx::AUI::AuiManagerEvent constructor

  Constructor.

• #set_button(button) ⇒ void (also: #button=)

  Sets the ID of the button clicked that triggered this event.

• #set_can_veto(can_veto) ⇒ void (also: #can_veto=)

  Sets whether or not this event can be vetoed.

• #set_dc(pdc) ⇒ void (also: #dc=)

  TodoWhat is this?.

• #set_manager(manager) ⇒ void (also: #manager=)

  Sets the AuiManager this event is associated with.

• #set_pane(pane) ⇒ void (also: #pane=)

  Sets the pane this event is associated with.

• #veto(veto = true) ⇒ void

  Cancels the action indicated by this event if #can_veto is true.

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(type = Wx::EVT_NULL) ⇒ Wx::AUI::AuiManagerEvent

Constructor.

Parameters:

• type (Wx::GenericCollapsiblePane::EventType) (defaults to: Wx::EVT_NULL)

# File 'lib/wx/doc/gen/aui/aui_manager_event.rb', line 42

def initialize(type=Wx::EVT_NULL) end

Instance Method Details

#can_veto ⇒ Boolean Also known as: can_veto?

true if this event can be vetoed.

Returns:

• (Boolean)

See Also:

• #veto

# File 'lib/wx/doc/gen/aui/aui_manager_event.rb', line 49

def can_veto; end

#get_button ⇒ Integer Also known as: button

The ID of the button that was clicked.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/aui/aui_manager_event.rb', line 56

def get_button; end

#get_dc ⇒ Wx::DC Also known as: dc

TodoWhat is this?

Returns:

• (Wx::DC)

# File 'lib/wx/doc/gen/aui/aui_manager_event.rb', line 63

def get_dc; end

#get_manager ⇒ Wx::AUI::AuiManager Also known as: manager

The Wx::AUI::AuiManager this event is associated with.

Returns:

• (Wx::AUI::AuiManager)

# File 'lib/wx/doc/gen/aui/aui_manager_event.rb', line 77

def get_manager; end

#get_pane ⇒ Wx::AUI::AuiPaneInfo Also known as: pane

The pane this event is associated with.

Returns:

• (Wx::AUI::AuiPaneInfo)

# File 'lib/wx/doc/gen/aui/aui_manager_event.rb', line 84

def get_pane; end

#get_veto ⇒ Boolean

true if this event was vetoed.

Returns:

• (Boolean)

See Also:

• #veto

# File 'lib/wx/doc/gen/aui/aui_manager_event.rb', line 71

def get_veto; end

#set_button(button) ⇒ void Also known as: button=

This method returns an undefined value.

Sets the ID of the button clicked that triggered this event.

Parameters:

• button (Integer)

# File 'lib/wx/doc/gen/aui/aui_manager_event.rb', line 90

def set_button(button) end

#set_can_veto(can_veto) ⇒ void Also known as: can_veto=

This method returns an undefined value.

Sets whether or not this event can be vetoed.

Parameters:

• can_veto (Boolean)

# File 'lib/wx/doc/gen/aui/aui_manager_event.rb', line 96

def set_can_veto(can_veto) end

#set_dc(pdc) ⇒ void Also known as: dc=

This method returns an undefined value.

TodoWhat is this?

Parameters:

• pdc (Wx::DC)

# File 'lib/wx/doc/gen/aui/aui_manager_event.rb', line 104

def set_dc(pdc) end

#set_manager(manager) ⇒ void Also known as: manager=

This method returns an undefined value.

Sets the Wx::AUI::AuiManager this event is associated with.

Parameters:

• manager (Wx::AUI::AuiManager)

# File 'lib/wx/doc/gen/aui/aui_manager_event.rb', line 110

def set_manager(manager) end

#set_pane(pane) ⇒ void Also known as: pane=

This method returns an undefined value.

Sets the pane this event is associated with.

Parameters:

• pane (Wx::AUI::AuiPaneInfo)

# File 'lib/wx/doc/gen/aui/aui_manager_event.rb', line 116

def set_pane(pane) end

#veto(veto = true) ⇒ void

This method returns an undefined value.

Cancels the action indicated by this event if #can_veto is true.

Parameters:

• veto (Boolean) (defaults to: true)

# File 'lib/wx/doc/gen/aui/aui_manager_event.rb', line 122

def veto(veto=true) end