Contents

# :stopdoc:
# This file is automatically generated by the WXRuby3 documentation 
# generator. Do not alter this file.
# :startdoc:


module Wx::RBN

  # Event used to indicate various actions relating to a button on a {Wx::RBN::RibbonButtonBar}.
  # 
  # For toggle buttons, {Wx::RBN::RibbonButtonBarEvent#is_checked} can be used to test the state of the button.
  # See {Wx::RBN::RibbonButtonBar} for available event types.
  # 
  # Category:  {Wx::Events}, Ribbon User Interface
  # @see Wx::RBN::RibbonBar 
  # 
  # 
  # @wxrb_require USE_RIBBON
  class RibbonButtonBarEvent < CommandEvent
  
    # Constructor.
    # @param command_type [Wx::Notebook::EventType] 
    # @param win_id [Integer] 
    # @param bar [Wx::RBN::RibbonButtonBar] 
    # @param button [Integer] 
    # @return [Wx::RBN::RibbonButtonBarEvent]
    def initialize(command_type=Wx::EVT_NULL, win_id=0, bar=nil, button=nil) end
    
    # Returns the bar which contains the button which the event relates to.
    # @return [Wx::RBN::RibbonButtonBar]
    def get_bar; end
    alias_method :bar, :get_bar
    
    # Sets the button bar relating to this event.
    # @param bar [Wx::RBN::RibbonButtonBar] 
    # @return [void]
    def set_bar(bar) end
    alias_method :bar=, :set_bar
    
    # Returns the button which the event relates to.
    # @return [Integer]
    def get_button; end
    alias_method :button, :get_button
    
    # Sets the button relating to this event.
    # @param bar [Integer] 
    # @return [void]
    def set_button(bar) end
    alias_method :button=, :set_button
    
    # Display a popup menu as a result of this (dropdown clicked) event.
    # @param menu [Wx::Menu] 
    # @return [Boolean]
    def popup_menu(menu) end
    
  end # RibbonButtonBarEvent
  

end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
wxruby3-0.9.5-x64-mingw-ucrt	lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb
wxruby3-0.9.4-x64-mingw-ucrt	lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb