Class: Wx::RBN::RibbonButtonBarEvent

Inherits:
CommandEvent show all
Defined in:
lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb

Overview

Event used to indicate various actions relating to a button on a RibbonButtonBar.

For toggle buttons, CommandEvent#is_checked can be used to test the state of the button. See RibbonButtonBar for available event types.

Category: Events, Ribbon User Interface

See Also:

Requires:

  • USE_RIBBON

Instance Method Summary collapse

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, bar = nil, button = nil) ⇒ Wx::RBN::RibbonButtonBarEvent

Constructor.

Parameters:

  • command_type (Wx::GenericCollapsiblePane::EventType) (defaults to: Wx::EVT_NULL)
  • win_id (Integer) (defaults to: 0)
  • bar (Wx::RBN::RibbonButtonBar) (defaults to: nil)
  • button (Integer) (defaults to: nil) 


29
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb', line 29

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

Instance Method Details

#get_bar ⇒ Wx::RBN::RibbonButtonBar Also known as: bar

Returns the bar which contains the button which the event relates to.

Returns:



33
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb', line 33

def get_bar; end

#get_button ⇒ Integer Also known as: button

Returns the button which the event relates to.

Returns:

  • (Integer) 


44
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb', line 44

def get_button; end

#popup_menu(menu) ⇒ Boolean

Display a popup menu as a result of this (dropdown clicked) event.

Parameters:

Returns:

  • (Boolean) 


56
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb', line 56

def popup_menu(menu) end

#set_bar(bar) ⇒ void Also known as: bar=

This method returns an undefined value.

Sets the button bar relating to this event.

Parameters:



39
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb', line 39

def set_bar(bar) end

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

This method returns an undefined value.

Sets the button relating to this event.

Parameters:

  • bar (Integer) 


50
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb', line 50

def set_button(bar) end