Class: Wx::RBN::RibbonGalleryEvent

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

Overview

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, gallery = nil, item = nil) ⇒ Wx::RBN::RibbonGalleryEvent

Constructor.

Parameters:

  • command_type (Wx::GenericCollapsiblePane::EventType) (defaults to: Wx::EVT_NULL)
  • win_id (Integer) (defaults to: 0)
  • gallery (Wx::RBN::RibbonGallery) (defaults to: nil)
  • item (Integer) (defaults to: nil) 


26
 
# File 'lib/wx/doc/gen/rbn/ribbon_gallery_event.rb', line 26

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

Instance Method Details

Returns the gallery which the event relates to.

Returns:



30
 
# File 'lib/wx/doc/gen/rbn/ribbon_gallery_event.rb', line 30

def get_gallery; end

#get_gallery_item ⇒ Integer Also known as: gallery_item

Returns the gallery item which the event relates to, or NULL if it does not relate to an item.

Returns:

  • (Integer) 


35
 
# File 'lib/wx/doc/gen/rbn/ribbon_gallery_event.rb', line 35

def get_gallery_item; end

#set_gallery(gallery) ⇒ void Also known as: gallery=

This method returns an undefined value.

Sets the gallery relating to this event.

Parameters:



41
 
# File 'lib/wx/doc/gen/rbn/ribbon_gallery_event.rb', line 41

def set_gallery(gallery) end

#set_gallery_item(item) ⇒ void Also known as: gallery_item=

This method returns an undefined value.

Sets the gallery item relating to this event.

Parameters:

  • item (Integer) 


47
 
# File 'lib/wx/doc/gen/rbn/ribbon_gallery_event.rb', line 47

def set_gallery_item(item) end