Class: Wx::WizardEvent

Inherits:

NotifyEvent

• Object
• Object
• Event
• CommandEvent
• NotifyEvent
• Wx::WizardEvent

Defined in:

lib/wx/doc/gen/wizard_event.rb

Overview

WizardEvent class represents an event generated by the Wizard: this event is first sent to the page itself and, if not processed there, goes up the window hierarchy as usual.

Events using this class

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

• EvtHandler#evt_wizard_page_changed(id, meth = nil, &block): The page has been just changed (this event cannot be vetoed).

• EvtHandler#evt_wizard_page_changing(id, meth = nil, &block): The page is being changed (this event can be vetoed).

• EvtHandler#evt_wizard_before_page_changed(id, meth = nil, &block): Called after Next is clicked but before GetNext is called. Unlike EVT_WIZARD_CHANGING, the handler for this function can change state that might affect the return value of GetNext. This event can be vetoed.

• EvtHandler#evt_wizard_page_shown(id, meth = nil, &block): The page was shown and laid out (this event cannot be vetoed).

• EvtHandler#evt_wizard_cancel(id, meth = nil, &block): The user attempted to cancel the wizard (this event may also be vetoed).

• EvtHandler#evt_wizard_help(id, meth = nil, &block): The wizard help button was pressed.

• EvtHandler#evt_wizard_finished(id, meth = nil, &block): The wizard finished button was pressed.

Category: Events

See Also:

• Wizard
• Sample

Requires:

• USE_WIZARDDLG

Instance Method Summary

• #get_direction ⇒ Boolean (also: #direction)

  Return the direction in which the page is changing: for EVT_WIZARD_PAGE_CHANGING, return true if we’re going forward or false otherwise and for EVT_WIZARD_PAGE_CHANGED return true if we came from the previous page and false if we returned from the next one.

• #get_page ⇒ Wx::WizardPage (also: #page)

  Returns the WizardPage which was active when this event was generated.

• #initialize(type = Wx::EVT_NULL, id = Wx::StandardID::ID_ANY, direction = true, page = 0) ⇒ Wx::WizardEvent constructor

  Constructor.

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

#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, id = Wx::StandardID::ID_ANY, direction = true, page = 0) ⇒ Wx::WizardEvent

Constructor.

It is not normally used by the user code as the objects of this type are constructed by Wx::Wizard.

Parameters:

• type (Wx::GenericCollapsiblePane::EventType) (defaults to: Wx::EVT_NULL)
• id (Integer) (defaults to: Wx::StandardID::ID_ANY)
• direction (Boolean) (defaults to: true)
• page (Wx::WizardPage) (defaults to: 0)

# File 'lib/wx/doc/gen/wizard_event.rb', line 98

def initialize(type=Wx::EVT_NULL, id=Wx::StandardID::ID_ANY, direction=true, page=0) end

Instance Method Details

#get_direction ⇒ Boolean Also known as: direction

Return the direction in which the page is changing: for EVT_WIZARD_PAGE_CHANGING, return true if we’re going forward or false otherwise and for EVT_WIZARD_PAGE_CHANGED return true if we came from the previous page and false if we returned from the next one.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/wizard_event.rb', line 102

def get_direction; end

#get_page ⇒ Wx::WizardPage Also known as: page

Returns the Wx::WizardPage which was active when this event was generated.

Returns:

• (Wx::WizardPage)

# File 'lib/wx/doc/gen/wizard_event.rb', line 107

def get_page; end