# :stopdoc: # This file is automatically generated by the WXRuby3 documentation # generator. Do not alter this file. # :startdoc: module Wx # WIZARD_EX_HELPBUTTON = 16 # WIZARD_VALIGN_TOP = 1 # WIZARD_VALIGN_CENTRE = 2 # WIZARD_VALIGN_BOTTOM = 4 # WIZARD_HALIGN_LEFT = 8 # WIZARD_HALIGN_CENTRE = 16 # WIZARD_HALIGN_RIGHT = 32 # WIZARD_TILE = 64 # # EVT_WIZARD_PAGE_CHANGED = 10013 # # EVT_WIZARD_PAGE_CHANGING = 10014 # # EVT_WIZARD_CANCEL = 10016 # # EVT_WIZARD_HELP = 10018 # # EVT_WIZARD_FINISHED = 10017 # # EVT_WIZARD_PAGE_SHOWN = 10019 # # EVT_WIZARD_BEFORE_PAGE_CHANGED = 10015 # {Wx::WizardEvent} class represents an event generated by the {Wx::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 {Wx::WizardEvent} events. # Event handler methods: # - {Wx::EvtHandler#evt_wizard_page_changed}(id, meth = nil, &block): The page has been just changed (this event cannot be vetoed). # - {Wx::EvtHandler#evt_wizard_page_changing}(id, meth = nil, &block): The page is being changed (this event can be vetoed). # - {Wx::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. # - {Wx::EvtHandler#evt_wizard_page_shown}(id, meth = nil, &block): The page was shown and laid out (this event cannot be vetoed). # - {Wx::EvtHandler#evt_wizard_cancel}(id, meth = nil, &block): The user attempted to cancel the wizard (this event may also be vetoed). # - {Wx::EvtHandler#evt_wizard_help}(id, meth = nil, &block): The wizard help button was pressed. # - {Wx::EvtHandler#evt_wizard_finished}(id, meth = nil, &block): The wizard finished button was pressed. # # === # # Category: {Wx::Events} # @see Wx::Wizard # @see Wizard Sample # # class WizardEvent < NotifyEvent # Constructor. # It is not normally used by the user code as the objects of this type are constructed by {Wx::Wizard}. # @param type [Integer] # @param id [Integer] # @param direction [true,false] # @param page [Wx::WizardPage] # @return [WizardEvent] def initialize(type=Wx::EVT_NULL, id=Wx::ID_ANY, direction=true, page=0) end # 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. # @return [true,false] def get_direction; end alias_method :direction, :get_direction # Returns the {Wx::WizardPage} which was active when this event was generated. # @return [Wx::WizardPage] def get_page; end alias_method :page, :get_page end # WizardEvent end