wxruby3 0.9.5-x64-mingw-ucrt → 0.9.7-x64-mingw-ucrt

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

@@ -6,342 +6,346 @@
 
 module Wx::RBN
 
-  # 
-  # 
-  EVT_RIBBONTOOLBAR_CLICKED = 10434
-  
-  # 
-  # 
-  EVT_RIBBONTOOLBAR_DROPDOWN_CLICKED = 10435
-  
-  # 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]
-    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.
+  module Wx::RBN
+
     # 
-    # 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, NULL 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, NULL 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
+    EVT_RIBBONTOOLBAR_CLICKED = 10434
     
-    # Returns the active item of the tool bar or NULL 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 NULL 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
+    EVT_RIBBONTOOLBAR_DROPDOWN_CLICKED = 10435
     
-    # Called to determine whether a tool is enabled (responds to user input).
+    # A ribbon tool bar is similar to a traditional toolbar which has no labels.
     # 
-    # 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.
+    # 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
     # 
-    # 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.
+    # 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:
     # 
-    # 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.
+    # - {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. 
     # 
-    # 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.
+    # - {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
     # 
-    # @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
+    # @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]
+      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, NULL 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, NULL 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 NULL 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 NULL 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
     
-    # 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
+
+  end