wxRuby Documentation Home

# Wx::WizardEvent

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.

## Derived from

NotifyEvent

CommandEvent

Event

Object

## Event table macros

To process input from a wizard dialog, use these event handler macros to
direct input to member functions that take a WizardEvent argument.

evt_wizard_page_changed(id) { | event | … } | The page has been justchanged (this event can not be vetoed).
evt_wizard_page_changing(id) { | event | … } | The page is beingchanged (this event can be vetoed).
evt_wizard_cancel(id) { | event | … } | The user attempted to cancelthe wizard (this event may also be vetoed).
evt_wizard_help(id) { | event | … } | The wizard help button was pressed.
evt_wizard_finished(id) { | event | … } | The wizard finished button was pressed.

## See also

Wizard, Wizard sample

## Methods

- WizardEvent.new
- WizardEvent#get_direction
- WizardEvent#get_page

### WizardEvent.new

WizardEvent.new(%(arg-type)EventType% type = EVT_NULL, Integer id = -1, Boolean direction = true)

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

### WizardEvent#get_direction

Boolean get_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.

### WizardEvent#get_page

WizardPage get_page()

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

[This page automatically generated from the Textile source at 2023-06-09 00:45:33 +0000]