wxruby3 1.6.1 → 1.7.0

data/lib/wx/doc/gen/rbn/ribbon_panel.rb

@@ -0,0 +1,270 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module RBN
+
+    # 
+    # 
+    # 
+    # 
+    # @wxrb_require USE_RIBBON
+    class RibbonPanelOption < Wx::Enum
+    
+      # 
+      # 
+      RIBBON_PANEL_NO_AUTO_MINIMISE = Wx::RBN::RibbonPanelOption.new(1)
+      
+      # 
+      # 
+      RIBBON_PANEL_EXT_BUTTON = Wx::RBN::RibbonPanelOption.new(8)
+      
+      # 
+      # 
+      RIBBON_PANEL_MINIMISE_BUTTON = Wx::RBN::RibbonPanelOption.new(16)
+      
+      # 
+      # 
+      RIBBON_PANEL_STRETCH = Wx::RBN::RibbonPanelOption.new(32)
+      
+      # 
+      # 
+      RIBBON_PANEL_FLEXIBLE = Wx::RBN::RibbonPanelOption.new(64)
+      
+      # 
+      # 
+      RIBBON_PANEL_DEFAULT_STYLE = Wx::RBN::RibbonPanelOption.new(0)
+      
+    end # RibbonPanelOption
+    
+    # 
+    # 
+    EVT_RIBBONPANEL_EXTBUTTON_ACTIVATED = 10403
+    
+    # 
+    # 
+    # 
+    # 
+    # @wxrb_require USE_RIBBON
+    class RibbonPanelOption < Wx::Enum
+    
+      # 
+      # 
+      RIBBON_PANEL_NO_AUTO_MINIMISE = Wx::RBN::RibbonPanelOption.new(1)
+      
+      # 
+      # 
+      RIBBON_PANEL_EXT_BUTTON = Wx::RBN::RibbonPanelOption.new(8)
+      
+      # 
+      # 
+      RIBBON_PANEL_MINIMISE_BUTTON = Wx::RBN::RibbonPanelOption.new(16)
+      
+      # 
+      # 
+      RIBBON_PANEL_STRETCH = Wx::RBN::RibbonPanelOption.new(32)
+      
+      # 
+      # 
+      RIBBON_PANEL_FLEXIBLE = Wx::RBN::RibbonPanelOption.new(64)
+      
+      # 
+      # 
+      RIBBON_PANEL_DEFAULT_STYLE = Wx::RBN::RibbonPanelOption.new(0)
+      
+    end # RibbonPanelOption
+    
+    # 
+    # 
+    EVT_RIBBONPANEL_EXTBUTTON_ACTIVATED = 10403
+    
+    # Serves as a container for a group of (ribbon) controls.
+    # 
+    # A {Wx::RBN::RibbonPage} will typically have panels for children, with the controls for that page placed on the panels.
+    # A panel adds a border and label to a group of controls, and can be minimised (either automatically to conserve space, or manually by the user).
+    # Non-ribbon controls can be placed on a panel using {Wx::Sizers} to manage layout. Panel size is governed by the sizer's minimum calculated size and the parent {Wx::RBN::RibbonPage}'s dimensions. For functional and aesthetic reasons, it is recommended that ribbon and non-ribbon controls are not mixed in one panel.
+    # A {Wx::RBN::RibbonPage} can show or hide its panels to offer a dynamic experience for the end user. For example, a page can hide certain panels and show others when the user interacts with other elements in the application. As an example of toggling the visibility of a panel:
+    # 
+    # ```ruby
+    #   panel = @ribbon.get_page(0).get_panel_by_id(ID_EDITOR_PANEL)
+    #   panel.show(!panel.is_shown) if panel
+    #   # Update the UI
+    #   @ribbon.realise
+    #   @ribbon.layout
+    # ```
+    # 
+    # ### Styles
+    # 
+    # This class supports the following styles:
+    # 
+    # - {Wx::RBN::RibbonPanelOption::RIBBON_PANEL_DEFAULT_STYLE}: Defined as no other flags set. 
+    # 
+    # - {Wx::RBN::RibbonPanelOption::RIBBON_PANEL_NO_AUTO_MINIMISE}: Prevents the panel from automatically minimising to conserve screen space. 
+    # 
+    # - {Wx::RBN::RibbonPanelOption::RIBBON_PANEL_EXT_BUTTON}: Causes an extension button to be shown in the panel's chrome (if the bar in which it is contained has {Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_PANEL_EXT_BUTTONS} set). The behaviour of this button is application controlled, but typically will show an extended drop-down menu relating to the panel. 
+    # 
+    # - {Wx::RBN::RibbonPanelOption::RIBBON_PANEL_MINIMISE_BUTTON}: Causes a (de)minimise button to be shown in the panel's chrome (if the bar in which it is contained has the {Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS} style set). This flag is typically combined with {Wx::RBN::RibbonPanelOption::RIBBON_PANEL_NO_AUTO_MINIMISE} to make a panel which the user always has manual control over when it minimises. 
+    # 
+    # - {Wx::RBN::RibbonPanelOption::RIBBON_PANEL_STRETCH}: Stretches a single panel to fit the parent page. 
+    # 
+    # - {Wx::RBN::RibbonPanelOption::RIBBON_PANEL_FLEXIBLE}: Allows the panel to size in both directions; currently only useful when a single {Wx::RBN::RibbonToolBar} is the child of the panel, particularly in vertical orientation where the number of rows is dependent on the amount of horizontal space available. Set the minimum and maximum toolbar rows to take full advantage of this wrapping behaviour. 
+    # 
+    # ### Events emitted by this class
+    # 
+    # The following event-handler methods redirect the events to member method or handler blocks for {Wx::RBN::RibbonPanelEvent} events.
+    # Event handler methods for events emitted by this class:
+    # 
+    # - {Wx::EvtHandler#evt_ribbonpanel_extbutton_activated}(id, meth = nil, &block): Triggered when the user activate the panel extension button. 
+    # 
+    # Category:  Ribbon User Interface
+    # @see Wx::RBN::RibbonPage
+    # 
+    # 
+    # @wxrb_require USE_RIBBON
+    class RibbonPanel < RibbonControl
+    
+      # @overload initialize()
+      #   Default constructor.
+      #   
+      #   With this constructor, {Wx::RBN::RibbonPanel#create} should be called in order to create the ribbon panel.
+      #   @return [Wx::RBN::RibbonPanel]
+      # @overload initialize(parent, id=Wx::StandardID::ID_ANY, label=(''), minimised_icon=Wx::NULL_BITMAP, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::RBN::RibbonPanelOption::RIBBON_PANEL_DEFAULT_STYLE)
+      #   Constructs a ribbon panel.
+      #   @param parent [Wx::Window]  Pointer to a parent window, which is typically a {Wx::RBN::RibbonPage}, though it can be any window.
+      #   @param id [Integer]  Window identifier.
+      #   @param label [String]  Label to be used in the {Wx::RBN::RibbonPanel}'s chrome.
+      #   @param minimised_icon [Wx::Bitmap]  Icon to be used in place of the panel's children when the panel is minimised.
+      #   @param pos [Array(Integer, Integer), Wx::Point]  The initial position of the panel. Not relevant when the parent is a ribbon page, as the position and size of the panel will be dictated by the page.
+      #   @param size [Array(Integer, Integer), Wx::Size]  The initial size of the panel. Not relevant when the parent is a ribbon page, as the position and size of the panel will be dictated by the page.
+      #   @param style [Integer]  Style flags for the panel.
+      #   @return [Wx::RBN::RibbonPanel]
+      # @overload initialize(parent, id=Wx::StandardID::ID_ANY, label=(''), minimised_icon=Wx::NULL_BITMAP, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::RBN::RibbonPanelOption::RIBBON_PANEL_DEFAULT_STYLE, &block)
+      #   Constructs a ribbon panel.
+      #   @param parent [Wx::Window]  Pointer to a parent window, which is typically a {Wx::RBN::RibbonPage}, though it can be any window.
+      #   @param id [Integer]  Window identifier.
+      #   @param label [String]  Label to be used in the {Wx::RBN::RibbonPanel}'s chrome.
+      #   @param minimised_icon [Wx::Bitmap]  Icon to be used in place of the panel's children when the panel is minimised.
+      #   @param pos [Array(Integer, Integer), Wx::Point]  The initial position of the panel. Not relevant when the parent is a ribbon page, as the position and size of the panel will be dictated by the page.
+      #   @param size [Array(Integer, Integer), Wx::Size]  The initial size of the panel. Not relevant when the parent is a ribbon page, as the position and size of the panel will be dictated by the page.
+      #   @param style [Integer]  Style flags for the panel.
+      #   @yieldparam [Wx::RBN::RibbonPanel] win new instance
+      #   @return [Wx::RBN::RibbonPanel]
+      def initialize(*args) end
+      
+      # Create a ribbon panel in two-step ribbon panel construction.
+      # 
+      # Should only be called when the default constructor is used, and arguments have the same meaning as in the full constructor.
+      # @param parent [Wx::Window] 
+      # @param id [Integer] 
+      # @param label [String] 
+      # @param icon [Wx::Bitmap] 
+      # @param pos [Array(Integer, Integer), Wx::Point] 
+      # @param size [Array(Integer, Integer), Wx::Size] 
+      # @param style [Integer] 
+      # @return [Boolean]
+      def create(parent, id=Wx::StandardID::ID_ANY, label=(''), icon=Wx::NULL_BITMAP, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::RBN::RibbonPanelOption::RIBBON_PANEL_DEFAULT_STYLE) end
+      
+      # @return [Wx::Bitmap]
+      def get_minimised_icon; end
+      alias_method :minimised_icon, :get_minimised_icon
+      
+      # Test if the panel has an extension button.
+      # 
+      # Such button is shown in the top right corner of the panel if {Wx::RBN::RibbonPanelOption::RIBBON_PANEL_EXT_BUTTON} style is used for it.
+      # 
+      # true if the panel and its {Wx::RBN::RibbonBar} allow it in their styles.
+      # @return [Boolean]
+      def has_ext_button; end
+      alias_method :has_ext_button?, :has_ext_button
+      
+      # @overload is_minimised()
+      #   Query if the panel is currently minimised.
+      #   @return [Boolean]
+      # @overload is_minimised(at_size)
+      #   Query if the panel would be minimised at a given size.
+      #   @param at_size [Wx::Size] 
+      #   @return [Boolean]
+      def is_minimised(*args) end
+      alias_method :minimised?, :is_minimised
+      
+      # Query is the mouse is currently hovered over the panel.
+      # 
+      # true if the cursor is within the bounds of the panel (i.e. hovered over the panel or one of its children), false otherwise.
+      # @return [Boolean]
+      def is_hovered; end
+      alias_method :hovered?, :is_hovered
+      
+      # Query if the mouse is currently hovered over the extension button.
+      # 
+      # Extension button is only shown for panels with {Wx::RBN::RibbonPanelOption::RIBBON_PANEL_EXT_BUTTON} style.
+      # @return [Boolean]
+      def is_ext_button_hovered; end
+      alias_method :ext_button_hovered?, :is_ext_button_hovered
+      
+      # Query if the panel can automatically minimise itself at small sizes.
+      # @return [Boolean]
+      def can_auto_minimise; end
+      alias_method :can_auto_minimise?, :can_auto_minimise
+      
+      # Show the panel externally expanded.
+      # 
+      # When a panel is minimised, it can be shown full-size in a pop-out window, which is referred to as being (externally) expanded. Note that when a panel is expanded, there exist two panels - the original panel (which is referred to as the dummy panel) and the expanded panel. The original is termed a dummy as it sits in the ribbon bar doing nothing, while the expanded panel holds the panel children.
+      # true if the panel was expanded, false if it was not (possibly due to it not being minimised, or already being expanded).
+      # @see Wx::RBN::RibbonPanel#hide_expanded 
+      # 
+      # @see Wx::RBN::RibbonPanel#get_expanded_panel 
+      # @return [Boolean]
+      def show_expanded; end
+      
+      # Hide the panel's external expansion.
+      # 
+      # true if the panel was un-expanded, false if it was not (normally due to it not being expanded in the first place).
+      # @see Wx::RBN::RibbonPanel#hide_expanded 
+      # 
+      # @see Wx::RBN::RibbonPanel#get_expanded_panel 
+      # @return [Boolean]
+      def hide_expanded; end
+      
+      # Set the art provider to be used.
+      # 
+      # Normally called automatically by {Wx::RBN::RibbonPage} when the panel is created, or the art provider changed on the page.
+      # The new art provider will be propagated to the children of the panel.
+      # @param art [Wx::RBN::RibbonArtProvider] 
+      # @return [void]
+      def set_art_provider(art) end
+      alias_method :art_provider=, :set_art_provider
+      
+      # Realize all children of the panel.
+      # @return [Boolean]
+      def realize; end
+      
+      # Get the dummy panel of an expanded panel.
+      # 
+      # Note that this should be called on an expanded panel to get the dummy associated with it - it will return nil when called on the dummy itself.
+      # @see Wx::RBN::RibbonPanel#show_expanded 
+      # 
+      # @see Wx::RBN::RibbonPanel#get_expanded_panel 
+      # @return [Wx::RBN::RibbonPanel]
+      def get_expanded_dummy; end
+      alias_method :expanded_dummy, :get_expanded_dummy
+      
+      # Get the expanded panel of a dummy panel.
+      # 
+      # Note that this should be called on a dummy panel to get the expanded panel associated with it - it will return nil when called on the expanded panel itself.
+      # @see Wx::RBN::RibbonPanel#show_expanded 
+      # 
+      # @see Wx::RBN::RibbonPanel#get_expanded_dummy 
+      # @return [Wx::RBN::RibbonPanel]
+      def get_expanded_panel; end
+      alias_method :expanded_panel, :get_expanded_panel
+      
+    end # RibbonPanel
+    
+
+  end
+
+end

data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb

@@ -0,0 +1,45 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module RBN
+
+    # Event used to indicate various actions relating to a {Wx::RBN::RibbonPanel}.
+    # 
+    # See {Wx::RBN::RibbonPanel} for available event types.
+    # 
+    # Category:  {Wx::Events}, Ribbon User Interface
+    # @see Wx::RBN::RibbonPanel 
+    # 
+    # 
+    # @wxrb_require USE_RIBBON
+    class RibbonPanelEvent < CommandEvent
+    
+      # Constructor.
+      # @param command_type [Wx::TipWindow::EventType] 
+      # @param win_id [Integer] 
+      # @param panel [Wx::RBN::RibbonPanel] 
+      # @return [Wx::RBN::RibbonPanelEvent]
+      def initialize(command_type=Wx::EVT_NULL, win_id=0, panel=nil) end
+      
+      # Returns the panel relating to this event.
+      # @return [Wx::RBN::RibbonPanel]
+      def get_panel; end
+      alias_method :panel, :get_panel
+      
+      # Sets the page relating to this event.
+      # @param page [Wx::RBN::RibbonPanel] 
+      # @return [void]
+      def set_panel(page) end
+      alias_method :panel=, :set_panel
+      
+    end # RibbonPanelEvent
+    
+
+  end
+
+end

data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb

@@ -0,0 +1,360 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module RBN
+
+    # 
+    # 
+    EVT_RIBBONTOOLBAR_CLICKED = 10404
+    
+    # 
+    # 
+    EVT_RIBBONTOOLBAR_DROPDOWN_CLICKED = 10405
+    
+    # A ribbon tool bar is similar to a traditional toolbar which has no labels.
+    # 
+    # It contains one or more tool groups, each of which contains one or more tools. Each tool is represented by a (generally small, i.e. 16x15) bitmap.
+    # ### Events emitted by this class
+    # 
+    # The following event-handler methods redirect the events to member method or handler blocks for {Wx::RBN::RibbonToolBarEvent} events.
+    # Event handler methods for events emitted by this class:
+    # 
+    # - {Wx::EvtHandler#evt_ribbontoolbar_clicked}(id, meth = nil, &block): Triggered when the normal (non-dropdown) region of a tool on the tool bar is clicked. 
+    # 
+    # - {Wx::EvtHandler#evt_ribbontoolbar_dropdown_clicked}(id, meth = nil, &block): Triggered when the dropdown region of a tool on the tool bar is clicked. {Wx::RBN::RibbonToolBarEvent#popup_menu} should be called by the event handler if it wants to display a popup menu (which is what most dropdown tools should be doing). 
+    # 
+    # Category:  Ribbon User Interface
+    # 
+    # @wxrb_require USE_RIBBON
+    class RibbonToolBar < RibbonControl
+    
+      # @overload initialize()
+      #   Default constructor.
+      #   
+      #   With this constructor, {Wx::RBN::RibbonToolBar#create} should be called in order to create the tool bar.
+      #   @return [Wx::RBN::RibbonToolBar]
+      # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0)
+      #   Construct a ribbon tool bar with the given parameters.
+      #   @param parent [Wx::Window]  Parent window for the tool bar (typically a {Wx::RBN::RibbonPanel}).
+      #   @param id [Integer]  An identifier for the toolbar. {Wx::StandardID::ID_ANY} is taken to mean a default.
+      #   @param pos [Array(Integer, Integer), Wx::Point]  Initial position of the tool bar.
+      #   @param size [Array(Integer, Integer), Wx::Size]  Initial size of the tool bar.
+      #   @param style [Integer]  Tool bar style, currently unused.
+      #   @return [Wx::RBN::RibbonToolBar]
+      # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, &block)
+      #   Construct a ribbon tool bar with the given parameters.
+      #   @param parent [Wx::Window]  Parent window for the tool bar (typically a {Wx::RBN::RibbonPanel}).
+      #   @param id [Integer]  An identifier for the toolbar. {Wx::StandardID::ID_ANY} is taken to mean a default.
+      #   @param pos [Array(Integer, Integer), Wx::Point]  Initial position of the tool bar.
+      #   @param size [Array(Integer, Integer), Wx::Size]  Initial size of the tool bar.
+      #   @param style [Integer]  Tool bar style, currently unused.
+      #   @yieldparam [Wx::RBN::RibbonToolBar] win new instance
+      #   @return [Wx::RBN::RibbonToolBar]
+      def initialize(*args) end
+      
+      # Create a tool bar in two-step tool bar construction.
+      # 
+      # Should only be called when the default constructor is used, and arguments have the same meaning as in the full constructor.
+      # @param parent [Wx::Window] 
+      # @param id [Integer] 
+      # @param pos [Array(Integer, Integer), Wx::Point] 
+      # @param size [Array(Integer, Integer), Wx::Size] 
+      # @param style [Integer] 
+      # @return [Boolean]
+      def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0) end
+      
+      # @overload add_tool(tool_id, bitmap, help_string, kind=Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL)
+      #   Add a tool to the tool bar (simple version).
+      #   @param tool_id [Integer] 
+      #   @param bitmap [Wx::Bitmap] 
+      #   @param help_string [String] 
+      #   @param kind [Wx::RibbonButtonKind] 
+      #   @return [Integer]
+      # @overload add_tool(tool_id, bitmap, bitmap_disabled=Wx::NULL_BITMAP, help_string=(''), kind=Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL, clientData=nil)
+      #   Add a tool to the tool bar.
+      #   
+      #   An opaque pointer which can be used only with other tool bar methods.
+      #   @see Wx::RBN::RibbonToolBar#add_dropdown_tool
+      #   @see  Wx::RBN::RibbonToolBar#add_hybrid_tool
+      #   @see  Wx::RBN::RibbonToolBar#add_separator
+      #   @see  Wx::RBN::RibbonToolBar#insert_tool 
+      #   @param tool_id [Integer]  ID of the new tool (used for event callbacks).
+      #   @param bitmap [Wx::Bitmap]  Bitmap to use as the foreground for the new tool. Does not have to be the same size as other tool bitmaps, but should be similar as otherwise it will look visually odd.
+      #   @param bitmap_disabled [Wx::Bitmap]  Bitmap to use when the tool is disabled. If left as {Wx::NULL_BITMAP}, then a bitmap will be automatically generated from bitmap.
+      #   @param help_string [String]  The UI help string to associate with the new tool.
+      #   @param kind [Wx::RibbonButtonKind]  The kind of tool to add.
+      #   @param clientData [Object]  Client data to associate with the new tool.
+      #   @return [Integer]
+      def add_tool(*args) end
+      
+      # Add a dropdown tool to the tool bar (simple version).
+      # 
+      # 
+      # @see Wx::RBN::RibbonToolBar#add_tool 
+      # @param tool_id [Integer] 
+      # @param bitmap [Wx::Bitmap] 
+      # @param help_string [String] 
+      # @return [Integer]
+      def add_dropdown_tool(tool_id, bitmap, help_string=('')) end
+      
+      # Add a hybrid tool to the tool bar (simple version).
+      # 
+      # 
+      # @see Wx::RBN::RibbonToolBar#add_tool 
+      # @param tool_id [Integer] 
+      # @param bitmap [Wx::Bitmap] 
+      # @param help_string [String] 
+      # @return [Integer]
+      def add_hybrid_tool(tool_id, bitmap, help_string=('')) end
+      
+      # Add a toggle tool to the tool bar (simple version).
+      # 
+      # 
+      # @see Wx::RBN::RibbonToolBar#add_tool 
+      # @param tool_id [Integer] 
+      # @param bitmap [Wx::Bitmap] 
+      # @param help_string [String] 
+      # @return [Integer]
+      def add_toggle_tool(tool_id, bitmap, help_string) end
+      
+      # Add a separator to the tool bar.
+      # 
+      # Separators are used to separate tools into groups. As such, a separator is not explicitly drawn, but is visually seen as the gap between tool groups.
+      # @return [Integer]
+      def add_separator; end
+      
+      # @overload insert_tool(pos, tool_id, bitmap, help_string, kind=Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL)
+      #   Insert a tool to the tool bar (simple version) as the specified position.
+      #   
+      #   
+      #   @see Wx::RBN::RibbonToolBar#insert_tool 
+      #   @param pos [Integer] 
+      #   @param tool_id [Integer] 
+      #   @param bitmap [Wx::Bitmap] 
+      #   @param help_string [String] 
+      #   @param kind [Wx::RibbonButtonKind] 
+      #   @return [Integer]
+      # @overload insert_tool(pos, tool_id, bitmap, bitmap_disabled=Wx::NULL_BITMAP, help_string=(''), kind=Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL, clientData=nil)
+      #   Insert a tool to the tool bar at the specified position.
+      #   
+      #   An opaque pointer which can be used only with other tool bar methods.
+      #   @see Wx::RBN::RibbonToolBar#insert_dropdown_tool
+      #   @see  Wx::RBN::RibbonToolBar#insert_hybrid_tool
+      #   @see  Wx::RBN::RibbonToolBar#insert_separator 
+      #   @param pos [Integer]  Position of the new tool (number of tools and separators from the beginning of the toolbar).
+      #   @param tool_id [Integer]  ID of the new tool (used for event callbacks).
+      #   @param bitmap [Wx::Bitmap]  Bitmap to use as the foreground for the new tool. Does not have to be the same size as other tool bitmaps, but should be similar as otherwise it will look visually odd.
+      #   @param bitmap_disabled [Wx::Bitmap]  Bitmap to use when the tool is disabled. If left as {Wx::NULL_BITMAP}, then a bitmap will be automatically generated from bitmap.
+      #   @param help_string [String]  The UI help string to associate with the new tool.
+      #   @param kind [Wx::RibbonButtonKind]  The kind of tool to add.
+      #   @param clientData [Object]  Client data to associate with the new tool.
+      #   @return [Integer]
+      def insert_tool(*args) end
+      
+      # Insert a dropdown tool to the tool bar (simple version) as the specified position.
+      # 
+      # 
+      # @see Wx::RBN::RibbonToolBar#add_dropdown_tool
+      # @see  Wx::RBN::RibbonToolBar#insert_tool 
+      # @param pos [Integer] 
+      # @param tool_id [Integer] 
+      # @param bitmap [Wx::Bitmap] 
+      # @param help_string [String] 
+      # @return [Integer]
+      def insert_dropdown_tool(pos, tool_id, bitmap, help_string=('')) end
+      
+      # Insert a hybrid tool to the tool bar (simple version) as the specified position.
+      # 
+      # 
+      # @see Wx::RBN::RibbonToolBar#add_hybrid_tool
+      # @see  Wx::RBN::RibbonToolBar#insert_tool 
+      # @param pos [Integer] 
+      # @param tool_id [Integer] 
+      # @param bitmap [Wx::Bitmap] 
+      # @param help_string [String] 
+      # @return [Integer]
+      def insert_hybrid_tool(pos, tool_id, bitmap, help_string=('')) end
+      
+      # Insert a toggle tool to the tool bar (simple version) as the specified position.
+      # 
+      # 
+      # @see Wx::RBN::RibbonToolBar#add_toggle_tool
+      # @see  Wx::RBN::RibbonToolBar#insert_tool 
+      # @param pos [Integer] 
+      # @param tool_id [Integer] 
+      # @param bitmap [Wx::Bitmap] 
+      # @param help_string [String] 
+      # @return [Integer]
+      def insert_toggle_tool(pos, tool_id, bitmap, help_string=('')) end
+      
+      # Insert a separator to the tool bar at the specified position.
+      # 
+      # 
+      # @see Wx::RBN::RibbonToolBar#add_separator
+      # @see  Wx::RBN::RibbonToolBar#insert_tool 
+      # @param pos [Integer] 
+      # @return [Integer]
+      def insert_separator(pos) end
+      
+      # Deletes all the tools in the toolbar.
+      # @return [void]
+      def clear_tools; end
+      
+      # Removes the specified tool from the toolbar and deletes it.
+      # 
+      # true if the tool was deleted, false otherwise.
+      # @see Wx::RBN::RibbonToolBar#delete_tool_by_pos 
+      # @param tool_id [Integer]  ID of the tool to delete.
+      # @return [Boolean]
+      def delete_tool(tool_id) end
+      
+      # This function behaves like {Wx::RBN::RibbonToolBar#delete_tool} but it deletes the tool at the specified position and not the one with the given id.
+      # 
+      # Useful to delete separators.
+      # @param pos [Integer] 
+      # @return [Boolean]
+      def delete_tool_by_pos(pos) end
+      
+      # @overload get_tool_by_pos(pos)
+      #   Return the opaque pointer corresponding to the given tool.
+      #   
+      #   an opaque pointer, nil if is a separator or not found.
+      #   @param pos [Integer] 
+      #   @return [Integer]
+      # @overload get_tool_by_pos(x, y)
+      #   Returns the opaque pointer for the tool at the given coordinates, which are relative to the toolbar's parent.
+      #   
+      #   an opaque pointer, nil if is not found.
+      #   @param x [Integer] 
+      #   @param y [Integer] 
+      #   @return [Integer]
+      def get_tool_by_pos(*args) end
+      alias_method :tool_by_pos, :get_tool_by_pos
+      
+      # Returns the number of tools in the toolbar.
+      # @return [Integer]
+      def get_tool_count; end
+      alias_method :tool_count, :get_tool_count
+      
+      # Returns the active item of the tool bar or nil if there is none.
+      # 
+      # The active tool is the one being clicked.
+      # @return [Integer]
+      def get_active_tool; end
+      alias_method :active_tool, :get_active_tool
+      
+      # Get any client data associated with the tool.
+      # 
+      # Client data, or nil if there is none.
+      # @param tool_id [Integer]  ID of the tool in question, as passed to {Wx::RBN::RibbonToolBar#add_tool}.
+      # @return [Object]
+      def get_tool_client_data(tool_id) end
+      alias_method :tool_client_data, :get_tool_client_data
+      
+      # Called to determine whether a tool is enabled (responds to user input).
+      # 
+      # true if the tool is enabled, false otherwise.
+      # @see Wx::RBN::RibbonToolBar#enable_tool 
+      # @param tool_id [Integer]  ID of the tool in question, as passed to {Wx::RBN::RibbonToolBar#add_tool}.
+      # @return [Boolean]
+      def get_tool_enabled(tool_id) end
+      alias_method :tool_enabled, :get_tool_enabled
+      
+      # Returns the help string for the given tool.
+      # @param tool_id [Integer]  ID of the tool in question, as passed to {Wx::RBN::RibbonToolBar#add_tool}.
+      # @return [String]
+      def get_tool_help_string(tool_id) end
+      alias_method :tool_help_string, :get_tool_help_string
+      
+      # Return the kind of the given tool.
+      # @param tool_id [Integer]  ID of the tool in question, as passed to {Wx::RBN::RibbonToolBar#add_tool}.
+      # @return [Wx::RibbonButtonKind]
+      def get_tool_kind(tool_id) end
+      alias_method :tool_kind, :get_tool_kind
+      
+      # Returns the tool position in the toolbar, or {Wx::NOT_FOUND} if the tool is not found.
+      # @param tool_id [Integer]  ID of the tool in question, as passed to {Wx::RBN::RibbonToolBar#add_tool}.
+      # @return [Integer]
+      def get_tool_pos(tool_id) end
+      alias_method :tool_pos, :get_tool_pos
+      
+      # Returns the tool's rect with coordinates relative to the toolbar's parent, or a default-constructed rect if the tool is not found.
+      # @param tool_id [Integer]  ID of the tool in question, as passed to {Wx::RBN::RibbonToolBar#add_tool}.
+      # @return [Wx::Rect]
+      def get_tool_rect(tool_id) end
+      alias_method :tool_rect, :get_tool_rect
+      
+      # Gets the on/off state of a toggle tool.
+      # 
+      # true if the tool is toggled on, false otherwise.
+      # @see Wx::RBN::RibbonToolBar#toggle_tool
+      # @param tool_id [Integer]  ID of the tool in question, as passed to {Wx::RBN::RibbonToolBar#add_tool}.
+      # @return [Boolean]
+      def get_tool_state(tool_id) end
+      alias_method :tool_state, :get_tool_state
+      
+      # Calculate tool layouts and positions.
+      # 
+      # Must be called after tools are added to the tool bar, as otherwise the newly added tools will not be displayed.
+      # @return [Boolean]
+      def realize; end
+      
+      # Set the number of rows to distribute tool groups over.
+      # 
+      # Tool groups can be distributed over a variable number of rows. The way in which groups are assigned to rows is not specified, and the order of groups may change, but they will be distributed in such a way as to minimise the overall size of the tool bar.
+      # @param nMin [Integer]  The minimum number of rows to use.
+      # @param nMax [Integer]  The maximum number of rows to use (defaults to nMin).
+      # @return [void]
+      def set_rows(nMin, nMax=-1) end
+      alias_method :rows=, :set_rows
+      
+      # Sets the client data associated with the tool.
+      # @param tool_id [Integer]  ID of the tool in question, as passed to {Wx::RBN::RibbonToolBar#add_tool}.
+      # @param clientData [Object]  The client data to use.
+      # @return [void]
+      def set_tool_client_data(tool_id, clientData) end
+      
+      # Sets the bitmap to be used by the tool with the given ID when the tool is in a disabled state.
+      # @param tool_id [Integer]  ID of the tool in question, as passed to {Wx::RBN::RibbonToolBar#add_tool}.
+      # @param bitmap [Wx::Bitmap]  Bitmap to use for disabled tools.
+      # @return [void]
+      def set_tool_disabled_bitmap(tool_id, bitmap) end
+      
+      # Sets the help string shown in tooltip for the given tool.
+      # 
+      # 
+      # @see Wx::RBN::RibbonToolBar#get_tool_help_string
+      # @param tool_id [Integer]  ID of the tool in question, as passed to {Wx::RBN::RibbonToolBar#add_tool}.
+      # @param helpString [String]  A string for the help.
+      # @return [void]
+      def set_tool_help_string(tool_id, helpString) end
+      
+      # Sets the bitmap to be used by the tool with the given ID.
+      # @param tool_id [Integer]  ID of the tool in question, as passed to {Wx::RBN::RibbonToolBar#add_tool}.
+      # @param bitmap [Wx::Bitmap]  Bitmap to use for normals tools.
+      # @return [void]
+      def set_tool_normal_bitmap(tool_id, bitmap) end
+      
+      # Enable or disable a single tool on the bar.
+      # @param tool_id [Integer]  ID of the tool to enable or disable.
+      # @param enable [Boolean]  true to enable the tool, false to disable it.
+      # @return [void]
+      def enable_tool(tool_id, enable=true) end
+      
+      # Set a toggle tool to the checked or unchecked state.
+      # @param tool_id [Integer]  ID of the toggle tool to manipulate.
+      # @param checked [Boolean]  true to set the tool to the toggled/pressed/checked state, false to set it to the untoggled/unpressed/unchecked state.
+      # @return [void]
+      def toggle_tool(tool_id, checked) end
+      
+    end # RibbonToolBar
+    
+
+  end
+
+end