Class: Wx::RBN::RibbonBarEvent

Inherits:
NotifyEvent show all
Defined in:
lib/wx/doc/gen/rbn/ribbon_bar_event.rb

Overview

Event used to indicate various actions relating to a RibbonBar.

See RibbonBar for available event types.

Category: Events, Ribbon User Interface

See Also:

Requires:

  • USE_RIBBON

Instance Method Summary collapse

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(command_type = Wx::EVT_NULL, win_id = 0, page = nil) ⇒ Wx::RBN::RibbonBarEvent

Constructor.

Parameters:

  • command_type (Wx::GenericCollapsiblePane::EventType) (defaults to: Wx::EVT_NULL)
  • win_id (Integer) (defaults to: 0)
  • page (Wx::RBN::RibbonPage) (defaults to: nil) 


27
 
# File 'lib/wx/doc/gen/rbn/ribbon_bar_event.rb', line 27

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

Instance Method Details

#get_page ⇒ Wx::RBN::RibbonPage Also known as: page

Returns the page being changed to, or being clicked on.

Returns:



31
 
# File 'lib/wx/doc/gen/rbn/ribbon_bar_event.rb', line 31

def get_page; end

#set_page(page) ⇒ void Also known as: page=

This method returns an undefined value.

Sets the page relating to this event.

Parameters:



37
 
# File 'lib/wx/doc/gen/rbn/ribbon_bar_event.rb', line 37

def set_page(page) end