wxruby3 0.9.0.pre.beta.2-x64-mingw-ucrt-3.2-3.2.2

data/lib/wx/doc/gen/tool_bar.rb

@@ -0,0 +1,744 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  # 
+  # 
+  class ToolBarToolStyle < Wx::Enum
+  
+    # 
+    # 
+    TOOL_STYLE_BUTTON = Wx::ToolBarToolStyle.new(1)
+    
+    # 
+    # 
+    TOOL_STYLE_SEPARATOR = Wx::ToolBarToolStyle.new(2)
+    
+    # 
+    # 
+    TOOL_STYLE_CONTROL = Wx::ToolBarToolStyle.new(3)
+    
+  end # ToolBarToolStyle
+  
+  # lay out the toolbar horizontally
+  # 
+  TB_HORIZONTAL = 4
+  
+  # 
+  # 
+  TB_TOP = 4
+  
+  # lay out the toolbar vertically
+  # 
+  TB_VERTICAL = 8
+  
+  # 
+  # 
+  TB_LEFT = 8
+  
+  # "flat" buttons (Win32/GTK only)
+  # 
+  TB_FLAT = 32
+  
+  # dockable toolbar (GTK only)
+  # 
+  TB_DOCKABLE = 64
+  
+  # don't show the icons (they're shown by default)
+  # 
+  TB_NOICONS = 128
+  
+  # show the text (not shown by default)
+  # 
+  TB_TEXT = 256
+  
+  # don't show the divider between toolbar and the window (Win32 only)
+  # 
+  TB_NODIVIDER = 512
+  
+  # no automatic alignment (Win32 only, useless)
+  # 
+  TB_NOALIGN = 1024
+  
+  # show the text and the icons alongside, not vertically stacked (Win32/GTK)
+  # 
+  TB_HORZ_LAYOUT = 2048
+  
+  # 
+  # 
+  TB_HORZ_TEXT = 2304
+  
+  # don't show the toolbar short help tooltips
+  # 
+  TB_NO_TOOLTIPS = 4096
+  
+  # lay out toolbar at the bottom of the window
+  # 
+  TB_BOTTOM = 8192
+  
+  # lay out toolbar at the right edge of the window
+  # 
+  TB_RIGHT = 16384
+  
+  # flags that are closest to the native look
+  # 
+  TB_DEFAULT_STYLE = 4
+  
+  # A toolbar is a bar of buttons and/or other controls usually placed below the menu bar in a {Wx::Frame}.
+  # You may create a toolbar that is managed by a frame calling {Wx::Frame#create_tool_bar}. Under Pocket PC, you should always use this function for creating the toolbar to be managed by the frame, so that wxWidgets can use a combined menubar and toolbar. Where you manage your own toolbars, create {Wx::ToolBar} as usual.
+  # There are several different types of tools you can add to a toolbar. These types are controlled by the {Wx::ItemKind} enumeration.
+  # Note that many methods in {Wx::ToolBar} such as {Wx::ToolBar#add_tool} return a <code>wxToolBarToolBase*</code> object. This should be regarded as an opaque handle representing the newly added toolbar item, providing access to its id and position within the toolbar. Changes to the item's state should be made through calls to {Wx::ToolBar} methods, for example {Wx::ToolBar#enable_tool}. Calls to {Wx::ToolBarToolBase} methods (undocumented by purpose) will not change the visible state of the item within the tool bar.
+  # After you have added all the tools you need, you must call {Wx::ToolBar#realize} to effectively construct and display the toolbar.
+  # <b>{Wx::MSW} note</b>: Note that under {Wx::MSW} toolbar paints tools to reflect system-wide colours. If you use more than 16 colours in your tool bitmaps, you may wish to suppress this behaviour, otherwise system colours in your bitmaps will inadvertently be mapped to system colours. To do this, set the msw.remap system option before creating the toolbar: 
+  # 
+  #   wxSystemOptions::SetOption("msw.remap", 0);
+  #  If you wish to use 32-bit images (which include an alpha channel for transparency) use: 
+  # 
+  #   wxSystemOptions::SetOption("msw.remap", 2);
+  #  Then colour remapping is switched off, and a transparent background used. But only use this option under Windows XP with true colour: 
+  # 
+  #   if (wxTheApp->GetComCtl32Version() >= 600 && ::wxDisplayDepth() >= 32)
+  # 
+  # === Styles
+  # 
+  # This class supports the following styles:
+  #  
+  # - {Wx::TB_FLAT}: Gives the toolbar a flat look (Windows and GTK only). 
+  # - {Wx::TB_DOCKABLE}: Makes the toolbar floatable and dockable (GTK only). 
+  # - {Wx::TB_HORIZONTAL}: Specifies horizontal layout (default). 
+  # - {Wx::TB_VERTICAL}: Specifies vertical layout. 
+  # - {Wx::TB_TEXT}: Shows the text in the toolbar buttons; by default only icons are shown. 
+  # - {Wx::TB_NOICONS}: Specifies no icons in the toolbar buttons; by default they are shown. 
+  # - {Wx::TB_NODIVIDER}: Specifies no divider (border) above the toolbar (Windows only) 
+  # - {Wx::TB_NOALIGN}: Specifies no alignment with the parent window (Windows only, not very useful). 
+  # - {Wx::TB_HORZ_LAYOUT}: Shows the text and the icons alongside, not vertically stacked (Windows and GTK 2 only). This style must be used with {Wx::TB_TEXT}. 
+  # - {Wx::TB_HORZ_TEXT}: Combination of {Wx::TB_HORZ_LAYOUT} and {Wx::TB_TEXT}. 
+  # - {Wx::TB_NO_TOOLTIPS}: Don't show the short help tooltips for the tools when the mouse hovers over them. 
+  # - {Wx::TB_BOTTOM}: Align the toolbar at the bottom of parent window. 
+  # - {Wx::TB_RIGHT}: Align the toolbar at the right side of parent window. 
+  # - {Wx::TB_DEFAULT_STYLE}: The {Wx::TB_HORIZONTAL} style. This style is new since wxWidgets 2.9.5. 
+  # 
+  # See also Window Styles. Note that the {Wx::MSW} native toolbar ignores {Wx::TB_NOICONS} style. Also, toggling the {Wx::TB_TEXT} works only if the style was initially on.
+  # === Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
+  # Event handler methods for events emitted by this class:
+  # - {Wx::EvtHandler#evt_tool}(id, meth = nil, &block): Process a {Wx::EVT_TOOL} event (a synonym for {Wx::EVT_MENU}). Pass the id of the tool. 
+  # - {Wx::EvtHandler#evt_menu}(id, meth = nil, &block): The same as EVT_TOOL(). 
+  # - {Wx::EvtHandler#evt_tool_range}(id1,  id2, meth = nil, &block): Process a {Wx::EVT_TOOL} event for a range of identifiers. Pass the ids of the tools. 
+  # - {Wx::EvtHandler#evt_menu_range}(id1,  id2, meth = nil, &block): The same as EVT_TOOL_RANGE(). 
+  # - {Wx::EvtHandler#evt_tool_rclicked}(id, meth = nil, &block): Process a {Wx::EVT_TOOL_RCLICKED} event. Pass the id of the tool. (Not available on {Wx::OSX}.) 
+  # - {Wx::EvtHandler#evt_tool_rclicked_range}(id1,  id2, meth = nil, &block): Process a {Wx::EVT_TOOL_RCLICKED} event for a range of ids. Pass the ids of the tools. (Not available on {Wx::OSX}.) 
+  # - {Wx::EvtHandler#evt_tool_enter}(id, meth = nil, &block): Process a {Wx::EVT_TOOL_ENTER} event. Pass the id of the toolbar itself. The value of {Wx::CommandEvent#get_selection} is the tool id, or -1 if the mouse cursor has moved off a tool. (Not available on {Wx::OSX}.) 
+  # - {Wx::EvtHandler#evt_tool_dropdown}(id, meth = nil, &block): Process a {Wx::EVT_TOOL_DROPDOWN} event. If unhandled, displays the default dropdown menu set using {Wx::ToolBar#set_dropdown_menu}. 
+  # 
+  # The toolbar class emits menu commands in the same way that a frame menubar does, so you can use one EVT_MENU() macro for both a menu item and a toolbar button. The event handler functions take a {Wx::CommandEvent} argument. For most event macros, the identifier of the tool is passed, but for EVT_TOOL_ENTER() the toolbar window identifier is passed and the tool identifier is retrieved from the {Wx::CommandEvent}. This is because the identifier may be {Wx::StandardID::ID_ANY} when the mouse moves off a tool, and {Wx::StandardID::ID_ANY} is not allowed as an identifier in the event system.
+  # === 
+  # 
+  # Category:  Miscellaneous Windows
+  # @see Toolbar Overview 
+  # 
+  # 
+  class ToolBar < Control
+  
+    # @overload add_tool(toolId, label, bitmap, shortHelp=Wx::EMPTY_STRING, kind=Wx::ITEM_NORMAL)
+    #   Adds a tool to the toolbar.
+    #   This most commonly used version has fewer parameters than the full version below which specifies the more rarely used button features.
+    #   
+    #   After you have added tools to a toolbar, you must call {Wx::ToolBar#realize} in order to have the tools appear.
+    #   @see Wx::ToolBar#add_separator
+    #   @see  Wx::ToolBar#add_check_tool
+    #   @see  Wx::ToolBar#add_radio_tool
+    #   @see  Wx::ToolBar#insert_tool
+    #   @see  Wx::ToolBar#delete_tool
+    #   @see  Wx::ToolBar#realize
+    #   @see  Wx::ToolBar#set_dropdown_menu 
+    #   @param toolId [Integer]  An integer by which the tool may be identified in subsequent operations.
+    #   @param label [String]  The string to be displayed with the tool. This string may include mnemonics, i.e. characters prefixed by an ampersand ("&"), but they are stripped from it and not actually shown in the toolbar as tools can't be activated from keyboard.
+    #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  The primary tool bitmap.
+    #   @param shortHelp [String]  This string is used for the tools tooltip.
+    #   @param kind [ItemKind]  May be {Wx::ItemKind::ITEM_NORMAL} for a normal button (default), {Wx::ItemKind::ITEM_CHECK} for a checkable tool (such tool stays pressed after it had been toggled) or {Wx::ItemKind::ITEM_RADIO} for a checkable tool which makes part of a radio group of tools each of which is automatically unchecked whenever another button in the group is checked. {Wx::ItemKind::ITEM_DROPDOWN} specifies that a drop-down menu button will appear next to the tool button (only GTK+ and MSW). Call {Wx::ToolBar#set_dropdown_menu} afterwards.
+    #   @return [Wx::ToolBarToolBase]
+    # @overload add_tool(toolId, label, bitmap, bmpDisabled, kind=Wx::ITEM_NORMAL, shortHelp=Wx::EMPTY_STRING, longHelp=Wx::EMPTY_STRING, clientData=nil)
+    #   Adds a tool to the toolbar.
+    #   After you have added tools to a toolbar, you must call {Wx::ToolBar#realize} in order to have the tools appear.
+    #   @see Wx::ToolBar#add_separator
+    #   @see  Wx::ToolBar#add_check_tool
+    #   @see  Wx::ToolBar#add_radio_tool
+    #   @see  Wx::ToolBar#insert_tool
+    #   @see  Wx::ToolBar#delete_tool
+    #   @see  Wx::ToolBar#realize
+    #   @see  Wx::ToolBar#set_dropdown_menu 
+    #   @param toolId [Integer]  An integer by which the tool may be identified in subsequent operations.
+    #   @param label [String]  The string to be displayed with the tool.
+    #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  The primary tool bitmap.
+    #   @param bmpDisabled [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  The bitmap used when the tool is disabled. If it is equal to {Wx::NULL_BITMAP} (default), the disabled bitmap is automatically generated by greying the normal one.
+    #   @param kind [ItemKind]  May be {Wx::ItemKind::ITEM_NORMAL} for a normal button (default), {Wx::ItemKind::ITEM_CHECK} for a checkable tool (such tool stays pressed after it had been toggled) or {Wx::ItemKind::ITEM_RADIO} for a checkable tool which makes part of a radio group of tools each of which is automatically unchecked whenever another button in the group is checked. {Wx::ItemKind::ITEM_DROPDOWN} specifies that a drop-down menu button will appear next to the tool button (only GTK+ and MSW). Call {Wx::ToolBar#set_dropdown_menu} afterwards.
+    #   @param shortHelp [String]  This string is used for the tools tooltip.
+    #   @param longHelp [String]  This string is shown in the statusbar (if any) of the parent frame when the mouse pointer is inside the tool.
+    #   @param clientData [Wx::Object]  An optional pointer to client data which can be retrieved later using {Wx::ToolBar#get_tool_client_data}.
+    #   @return [Wx::ToolBarToolBase]
+    def add_tool(*args) end
+    
+    # Inserts the tool with the specified attributes into the toolbar at the given position.
+    # You must call {Wx::ToolBar#realize} for the change to take place.
+    # 
+    # The newly inserted tool or NULL on failure. Notice that with the overload taking tool parameter the caller is responsible for deleting the tool in the latter case.
+    # @see Wx::ToolBar#add_tool
+    # @see  Wx::ToolBar#insert_control
+    # @see  Wx::ToolBar#insert_separator
+    # @param pos [Integer] 
+    # @param toolId [Integer] 
+    # @param label [String] 
+    # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @param bmpDisabled [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @param kind [ItemKind] 
+    # @param shortHelp [String] 
+    # @param longHelp [String] 
+    # @param clientData [Wx::Object] 
+    # @return [Wx::ToolBarToolBase]
+    def insert_tool(pos, toolId, label, bitmap, bmpDisabled=Wx::NULL_BITMAP, kind=Wx::ITEM_NORMAL, shortHelp=Wx::EMPTY_STRING, longHelp=Wx::EMPTY_STRING, clientData=nil) end
+    
+    # @overload set_margins(x, y)
+    #   Set the values to be used as margins for the toolbar.
+    #   This must be called before the tools are added if absolute positioning is to be used, and the default (zero-size) margins are to be overridden.
+    #   @see Wx::ToolBar#get_margins 
+    #   @param x [Integer]  Left margin, right margin and inter-tool separation value.
+    #   @param y [Integer]  Top margin, bottom margin and inter-tool separation value.
+    #   @return [void]
+    # @overload set_margins(size)
+    #   Set the margins for the toolbar.
+    #   This must be called before the tools are added if absolute positioning is to be used, and the default (zero-size) margins are to be overridden.
+    #   @see Wx::ToolBar#get_margins
+    #   @see  Wx::Size 
+    #   @param size [Array(Integer, Integer), Wx::Size]  Margin size.
+    #   @return [void]
+    def set_margins(*args) end
+    alias_method :margins=, :set_margins
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [ToolBar]
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TB_HORIZONTAL, name=Wx::TOOL_BAR_NAME_STR)
+    #   Constructs a toolbar.
+    #   After a toolbar is created, you use {Wx::ToolBar#add_tool} and perhaps {Wx::ToolBar#add_separator}, and then you must call {Wx::ToolBar#realize} to construct and display the toolbar tools.
+    #   @param parent [Wx::Window]  Pointer to a parent window.
+    #   @param id [Integer]  Window identifier. If -1, will automatically create an identifier.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position. {Wx::DEFAULT_POSITION} indicates that wxWidgets should generate a default position for the window. If using the {Wx::Window} class directly, supply an actual position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. {Wx::DEFAULT_SIZE} indicates that wxWidgets should generate a default size for the window.
+    #   @param style [Integer]  Window style. See {Wx::ToolBar} initial description for details.
+    #   @param name [String]  Window name.
+    #   @return [ToolBar]
+    def initialize(*args) end
+    
+    # Adds a new check (or toggle) tool to the toolbar.
+    # The parameters are the same as in {Wx::ToolBar#add_tool}.
+    # @see Wx::ToolBar#add_tool 
+    # @param toolId [Integer] 
+    # @param label [String] 
+    # @param bitmap1 [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @param bmpDisabled [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @param shortHelp [String] 
+    # @param longHelp [String] 
+    # @param clientData [Wx::Object] 
+    # @return [Wx::ToolBarToolBase]
+    def add_check_tool(toolId, label, bitmap1, bmpDisabled=Wx::NULL_BITMAP, shortHelp=Wx::EMPTY_STRING, longHelp=Wx::EMPTY_STRING, clientData=nil) end
+    
+    # Adds any control to the toolbar, typically e.g. a {Wx::ComboBox}.
+    # {Wx::Mac}: labels are only displayed if wxWidgets is built with {Wx::MAC_USE_NATIVE_TOOLBAR} set to 1
+    # @param control [Wx::Control]  The control to be added.
+    # @param label [String]  Text to be displayed near the control.
+    # @return [Wx::ToolBarToolBase]
+    def add_control(control, label=Wx::EMPTY_STRING) end
+    
+    # Adds a new radio tool to the toolbar.
+    # Consecutive radio tools form a radio group such that exactly one button in the group is pressed at any moment, in other words whenever a button in the group is pressed the previously pressed button is automatically released. You should avoid having the radio groups of only one element as it would be impossible for the user to use such button.
+    # By default, the first button in the radio group is initially pressed, the others are not.
+    # @see Wx::ToolBar#add_tool 
+    # @param toolId [Integer] 
+    # @param label [String] 
+    # @param bitmap1 [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @param bmpDisabled [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @param shortHelp [String] 
+    # @param longHelp [String] 
+    # @param clientData [Wx::Object] 
+    # @return [Wx::ToolBarToolBase]
+    def add_radio_tool(toolId, label, bitmap1, bmpDisabled=Wx::NULL_BITMAP, shortHelp=Wx::EMPTY_STRING, longHelp=Wx::EMPTY_STRING, clientData=nil) end
+    
+    # Adds a separator for spacing groups of tools.
+    # Notice that the separator uses the look appropriate for the current platform so it can be a vertical line (MSW, some versions of GTK) or just an empty space or something else.
+    # @see Wx::ToolBar#add_tool
+    # @see  Wx::ToolBar#set_tool_separation
+    # @see  Wx::ToolBar#add_stretchable_space 
+    # @return [Wx::ToolBarToolBase]
+    def add_separator; end
+    
+    # Adds a stretchable space to the toolbar.
+    # Any space not taken up by the fixed items (all items except for stretchable spaces) is distributed in equal measure between the stretchable spaces in the toolbar. The most common use for this method is to add a single stretchable space before the items which should be right-aligned in the toolbar, but more exotic possibilities are possible, e.g. a stretchable space may be added in the beginning and the end of the toolbar to centre all toolbar items.
+    # @see Wx::ToolBar#add_tool
+    # @see  Wx::ToolBar#add_separator
+    # @see  Wx::ToolBar#insert_stretchable_space
+    # @return [Wx::ToolBarToolBase]
+    def add_stretchable_space; end
+    
+    # Deletes all the tools in the toolbar.
+    # @return [void]
+    def clear_tools; end
+    
+    # Removes the specified tool from the toolbar and deletes it.
+    # If you don't want to delete the tool, but just to remove it from the toolbar (to possibly add it back later), you may use {Wx::ToolBar#remove_tool} instead.
+    # It is unnecessary to call {Wx::ToolBar#realize} for the change to take place, it will happen immediately.
+    # 
+    # true if the tool was deleted, false otherwise.
+    # @see Wx::ToolBar#delete_tool_by_pos 
+    # @param toolId [Integer] 
+    # @return [true,false]
+    def delete_tool(toolId) end
+    
+    # This function behaves like {Wx::ToolBar#delete_tool} but it deletes the tool at the specified position and not the one with the given id.
+    # @param pos [Integer] 
+    # @return [true,false]
+    def delete_tool_by_pos(pos) end
+    
+    # Enables or disables the tool.
+    # Some implementations will change the visible state of the tool to indicate that it is disabled.
+    # @see Wx::ToolBar#get_tool_enabled
+    # @see  Wx::ToolBar#toggle_tool 
+    # @param toolId [Integer]  ID of the tool to enable or disable, as passed to {Wx::ToolBar#add_tool}.
+    # @param enable [true,false]  If true, enables the tool, otherwise disables it.
+    # @return [void]
+    def enable_tool(toolId, enable) end
+    
+    # Returns a pointer to the tool identified by id or NULL if no corresponding tool is found.
+    # @param id [Integer] 
+    # @return [Wx::ToolBarToolBase]
+    def find_by_id(id) end
+    
+    # Returns a pointer to the control identified by id or NULL if no corresponding control is found.
+    # @param id [Integer] 
+    # @return [Wx::Control]
+    def find_control(id) end
+    
+    # Finds a tool for the given mouse position.
+    # A pointer to a tool if a tool is found, or NULL otherwise.
+    # 
+    # Currently not implemented in {Wx::GTK} (always returns NULL there).
+    # @param x [Integer]  X position.
+    # @param y [Integer]  Y position.
+    # @return [Wx::ToolBarToolBase]
+    def find_tool_for_position(x, y) end
+    
+    # Returns the left/right and top/bottom margins, which are also used for inter-toolspacing.
+    # 
+    # @see Wx::ToolBar#set_margins 
+    # @return [Wx::Size]
+    def get_margins; end
+    alias_method :margins, :get_margins
+    
+    # Returns the size of bitmap that the toolbar expects to have.
+    # The default bitmap size is platform-dependent: for example, it is 16*15 for MSW and 24*24 for GTK. This size does not necessarily indicate the best size to use for the toolbars on the given platform, for this you should use <code>wxArtProvider::GetNativeSizeHint(wxART_TOOLBAR)</code> but in any case, as the bitmap size is deduced automatically from the size of the bitmaps associated with the tools added to the toolbar, it is usually unnecessary to call either this function or {Wx::ToolBar#set_tool_bitmap_size} at all.
+    # This function returns the size in logical pixels, for consistency with {Wx::ToolBar#set_tool_bitmap_size} which takes size in logical pixels. See High DPI Support in wxWidgets for more information about the different pixel types and how to convert between them.
+    # Note that this is the size of the bitmap you pass to {Wx::ToolBar#add_tool}, and not the eventual size of the tool button.
+    # @see Wx::ToolBar#set_tool_bitmap_size
+    # @see  Wx::ToolBar#get_tool_size 
+    # @return [Wx::Size]
+    def get_tool_bitmap_size; end
+    alias_method :tool_bitmap_size, :get_tool_bitmap_size
+    
+    # @overload get_tool_by_pos(pos)
+    #   Returns a pointer to the tool at ordinal position pos.
+    #   Don't confuse this with {Wx::ToolBar#find_tool_for_position}.
+    #   @see Wx::ToolBar#get_tools_count 
+    #   @param pos [Integer] 
+    #   @return [Wx::ToolBarToolBase]
+    # @overload get_tool_by_pos(pos)
+    #   @param pos [Integer] 
+    #   @return [Wx::ToolBarToolBase]
+    def get_tool_by_pos(*args) end
+    alias_method :tool_by_pos, :get_tool_by_pos
+    
+    # Get any client data associated with the tool.
+    # Client data, or NULL if there is none.
+    # @param toolId [Integer]  ID of the tool in question, as passed to {Wx::ToolBar#add_tool}.
+    # @return [Wx::Object]
+    def get_tool_client_data(toolId) 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::ToolBar#enable_tool 
+    # @param toolId [Integer]  ID of the tool in question, as passed to {Wx::ToolBar#add_tool}.
+    # @return [true,false]
+    def get_tool_enabled(toolId) end
+    alias_method :tool_enabled, :get_tool_enabled
+    
+    # Returns the long help for the given tool.
+    # 
+    # @see Wx::ToolBar#set_tool_long_help
+    # @see  Wx::ToolBar#set_tool_short_help 
+    # @param toolId [Integer]  ID of the tool in question, as passed to {Wx::ToolBar#add_tool}.
+    # @return [String]
+    def get_tool_long_help(toolId) end
+    alias_method :tool_long_help, :get_tool_long_help
+    
+    # Returns the value used for packing tools.
+    # 
+    # @see Wx::ToolBar#set_tool_packing 
+    # @return [Integer]
+    def get_tool_packing; end
+    alias_method :tool_packing, :get_tool_packing
+    
+    # Returns the tool position in the toolbar, or {Wx::NOT_FOUND} if the tool is not found.
+    # @param toolId [Integer]  ID of the tool in question, as passed to {Wx::ToolBar#add_tool}.
+    # @return [Integer]
+    def get_tool_pos(toolId) end
+    alias_method :tool_pos, :get_tool_pos
+    
+    # Returns the default separator size.
+    # 
+    # @see Wx::ToolBar#set_tool_separation 
+    # @return [Integer]
+    def get_tool_separation; end
+    alias_method :tool_separation, :get_tool_separation
+    
+    # Returns the short help for the given tool.
+    # 
+    # @see Wx::ToolBar#get_tool_long_help
+    # @see  Wx::ToolBar#set_tool_short_help 
+    # @param toolId [Integer]  ID of the tool in question, as passed to {Wx::ToolBar#add_tool}.
+    # @return [String]
+    def get_tool_short_help(toolId) end
+    alias_method :tool_short_help, :get_tool_short_help
+    
+    # Returns the size of a whole button, which is usually larger than a tool bitmap because of added 3D effects.
+    # 
+    # @see Wx::ToolBar#set_tool_bitmap_size
+    # @see  Wx::ToolBar#get_tool_bitmap_size 
+    # @return [Wx::Size]
+    def get_tool_size; end
+    alias_method :tool_size, :get_tool_size
+    
+    # Gets the on/off state of a toggle tool.
+    # true if the tool is toggled on, false otherwise.
+    # @see Wx::ToolBar#toggle_tool 
+    # @param toolId [Integer]  ID of the tool in question, as passed to {Wx::ToolBar#add_tool}.
+    # @return [true,false]
+    def get_tool_state(toolId) end
+    alias_method :tool_state, :get_tool_state
+    
+    # Returns the number of tools in the toolbar.
+    # @return [Integer]
+    def get_tools_count; end
+    alias_method :tools_count, :get_tools_count
+    
+    # Inserts the control into the toolbar at the given position.
+    # You must call {Wx::ToolBar#realize} for the change to take place.
+    # @see Wx::ToolBar#add_control
+    # @see  Wx::ToolBar#insert_tool 
+    # @param pos [Integer] 
+    # @param control [Wx::Control] 
+    # @param label [String] 
+    # @return [Wx::ToolBarToolBase]
+    def insert_control(pos, control, label=Wx::EMPTY_STRING) end
+    
+    # Inserts the separator into the toolbar at the given position.
+    # You must call {Wx::ToolBar#realize} for the change to take place.
+    # @see Wx::ToolBar#add_separator
+    # @see  Wx::ToolBar#insert_tool 
+    # @param pos [Integer] 
+    # @return [Wx::ToolBarToolBase]
+    def insert_separator(pos) end
+    
+    # Inserts a stretchable space at the given position.
+    # See {Wx::ToolBar#add_stretchable_space} for details about stretchable spaces.
+    # @see Wx::ToolBar#insert_tool
+    # @see  Wx::ToolBar#insert_separator
+    # @param pos [Integer] 
+    # @return [Wx::ToolBarToolBase]
+    def insert_stretchable_space(pos) end
+    
+    # Called when the user clicks on a tool with the left mouse button.
+    # This is the old way of detecting tool clicks; although it will still work, you should use the EVT_MENU() or EVT_TOOL() macro instead.
+    # 
+    # If the tool is a toggle and this function returns false, the toggle state (internal and visual) will not be changed. This provides a way of specifying that toggle operations are not permitted in some circumstances.
+    # @see Wx::ToolBar#on_mouse_enter
+    # @see  Wx::ToolBar#on_right_click 
+    # @param toolId [Integer]  The identifier passed to {Wx::ToolBar#add_tool}.
+    # @param toggleDown [true,false]  true if the tool is a toggle and the toggle is down, otherwise is false.
+    # @return [true,false]
+    def on_left_click(toolId, toggleDown) end
+    
+    # This is called when the mouse cursor moves into a tool or out of the toolbar.
+    # This is the old way of detecting mouse enter events; although it will still work, you should use the EVT_TOOL_ENTER() macro instead.
+    # 
+    # With some derived toolbar classes, if the mouse moves quickly out of the toolbar, wxWidgets may not be able to detect it. Therefore this function may not always be called when expected.
+    # @param toolId [Integer]  Greater than -1 if the mouse cursor has moved into the tool, or -1 if the mouse cursor has moved. The programmer can override this to provide extra information about the tool, such as a short description on the status line.
+    # @return [void]
+    def on_mouse_enter(toolId) end
+    
+    # This function should be called after you have added tools.
+    # @return [true,false]
+    def realize; end
+    
+    # Removes the given tool from the toolbar but doesn't delete it.
+    # This allows inserting/adding this tool back to this (or another) toolbar later.
+    # It is unnecessary to call {Wx::ToolBar#realize} for the change to take place, it will happen immediately.
+    # @see Wx::ToolBar#delete_tool 
+    # @param id [Integer] 
+    # @return [Wx::ToolBarToolBase]
+    def remove_tool(id) end
+    
+    # Sets the dropdown menu for the tool given by its id.
+    # The tool itself will delete the menu when it's no longer needed. Only supported under GTK+ und MSW.
+    # If you define a EVT_TOOL_DROPDOWN() handler in your program, you must call {Wx::Event#skip} from it or the menu won't be displayed.
+    # @param id [Integer] 
+    # @param menu [Wx::Menu] 
+    # @return [true,false]
+    def set_dropdown_menu(id, menu) end
+    
+    # Sets the default size of each tool bitmap.
+    # It is usually unnecessary to call this function, as the tools will always be made big enough to fit the size of the bitmaps used in them. Moreover, calling it forces {Wx::ToolBar} to scale its images in high DPI using the provided size, instead of letting {Wx::BitmapBundle} used for the tool bitmaps determine the best suitable bitmap size, which may result in suboptimal appearance.
+    # If you do call it, it must be done before toolbar is {Wx::ToolBar#realize}'d.
+    # Example of using this function to force the bitmaps to be at least 32 pixels wide and tall (at normal DPI): 
+    # 
+    #   toolbar->SetToolBitmapSize(FromDIP(wxSize(32, 32)));
+    #   toolbar->AddTool(wxID_NEW, "New", wxBitmapBundle::FromXXX(...));
+    #   ...
+    #   toolbar->Realize();
+    # @see Wx::ToolBar#get_tool_bitmap_size
+    # @see  Wx::ToolBar#get_tool_size 
+    # @param size [Array(Integer, Integer), Wx::Size]  The size of the bitmaps in the toolbar in logical pixels.
+    # @return [void]
+    def set_tool_bitmap_size(size) end
+    alias_method :tool_bitmap_size=, :set_tool_bitmap_size
+    
+    # Sets the client data associated with the tool.
+    # @param id [Integer]  ID of the tool in question, as passed to {Wx::ToolBar#add_tool}.
+    # @param clientData [Wx::Object]  The client data to use.
+    # @return [void]
+    def set_tool_client_data(id, clientData) end
+    
+    # Sets the bitmap to be used by the tool with the given ID when the tool is in a disabled state.
+    # This can only be used on Button tools, not controls.
+    # 
+    # The native toolbar classes on the main platforms all synthesize the disabled bitmap from the normal bitmap, so this function will have no effect on those platforms.
+    # @param id [Integer]  ID of the tool in question, as passed to {Wx::ToolBar#add_tool}.
+    # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  Bitmap to use for disabled tools.
+    # @return [void]
+    def set_tool_disabled_bitmap(id, bitmap) end
+    
+    # Sets the long help for the given tool.
+    # You might use the long help for displaying the tool purpose on the status line.
+    # @see Wx::ToolBar#get_tool_long_help
+    # @see  Wx::ToolBar#set_tool_short_help
+    # @see  
+    # @param toolId [Integer]  ID of the tool in question, as passed to {Wx::ToolBar#add_tool}.
+    # @param helpString [String]  A string for the long help.
+    # @return [void]
+    def set_tool_long_help(toolId, helpString) end
+    
+    # Sets the bitmap to be used by the tool with the given ID.
+    # This can only be used on Button tools, not controls.
+    # @param id [Integer]  ID of the tool in question, as passed to {Wx::ToolBar#add_tool}.
+    # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  Bitmap to use for normals tools.
+    # @return [void]
+    def set_tool_normal_bitmap(id, bitmap) end
+    
+    # Sets the value used for spacing tools.
+    # The default value is 1.
+    # 
+    # The packing is used for spacing in the vertical direction if the toolbar is horizontal, and for spacing in the horizontal direction if the toolbar is vertical.
+    # @see Wx::ToolBar#get_tool_packing 
+    # @param packing [Integer]  The value for packing.
+    # @return [void]
+    def set_tool_packing(packing) end
+    alias_method :tool_packing=, :set_tool_packing
+    
+    # Sets the default separator size.
+    # The default value is 5.
+    # @see Wx::ToolBar#add_separator 
+    # @param separation [Integer]  The separator size.
+    # @return [void]
+    def set_tool_separation(separation) end
+    alias_method :tool_separation=, :set_tool_separation
+    
+    # Sets the short help for the given tool.
+    # An application might use short help for identifying the tool purpose in a tooltip.
+    # @see Wx::ToolBar#get_tool_short_help
+    # @see  Wx::ToolBar#set_tool_long_help 
+    # @param toolId [Integer]  ID of the tool in question, as passed to {Wx::ToolBar#add_tool}.
+    # @param helpString [String]  The string for the short help.
+    # @return [void]
+    def set_tool_short_help(toolId, helpString) end
+    
+    # Toggles a tool on or off.
+    # This does not cause any event to get emitted.
+    # 
+    # Only applies to a tool that has been specified as a toggle tool.
+    # @param toolId [Integer]  ID of the tool in question, as passed to {Wx::ToolBar#add_tool}.
+    # @param toggle [true,false]  If true, toggles the tool on, otherwise toggles it off.
+    # @return [void]
+    def toggle_tool(toolId, toggle) end
+    
+    # @overload create_tool(toolId, label, bmpNormal, bmpDisabled=Wx::NULL_BITMAP, kind=Wx::ITEM_NORMAL, clientData=nil, shortHelp=Wx::EMPTY_STRING, longHelp=Wx::EMPTY_STRING)
+    #   Factory function to create a new toolbar tool.
+    #   @param toolId [Integer] 
+    #   @param label [String] 
+    #   @param bmpNormal [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    #   @param bmpDisabled [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    #   @param kind [ItemKind] 
+    #   @param clientData [Wx::Object] 
+    #   @param shortHelp [String] 
+    #   @param longHelp [String] 
+    #   @return [Wx::ToolBarToolBase]
+    # @overload create_tool(control, label)
+    #   Factory function to create a new control toolbar tool.
+    #   @param control [Wx::Control] 
+    #   @param label [String] 
+    #   @return [Wx::ToolBarToolBase]
+    def create_tool(*args) end
+    
+    # Factory function to create a new separator toolbar tool.
+    # @return [Wx::ToolBarToolBase]
+    def create_separator; end
+    
+  end # ToolBar
+  
+  # A toolbar tool represents one item on the toolbar.
+  # It has a unique id (except for the separators), the style (telling whether it is a normal button, separator or a control), the state (toggled or not, enabled or not) and short and long help strings. The default implementations use the short help string for the tooltip text which is popped up when the mouse pointer enters the tool and the long help string for the applications status bar.
+  # Notice that the toolbar can not be modified by changing its tools via the (intentionally undocumented here) setter methods of this class, all the modifications must be done using the methods of {Wx::ToolBar} itself.
+  # 
+  class ToolBarToolBase < Object
+  
+    # @overload initialize(tbar=nil, toolid=Wx::ID_SEPARATOR, label=Wx::EMPTY_STRING, bmpNormal=Wx::NULL_BITMAP, bmpDisabled=Wx::NULL_BITMAP, kind=Wx::ITEM_NORMAL, clientData=nil, shortHelpString=Wx::EMPTY_STRING, longHelpString=Wx::EMPTY_STRING)
+    #   @param tbar [Wx::ToolBarBase] 
+    #   @param toolid [Integer] 
+    #   @param label [String] 
+    #   @param bmpNormal [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    #   @param bmpDisabled [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    #   @param kind [ItemKind] 
+    #   @param clientData [Wx::Object] 
+    #   @param shortHelpString [String] 
+    #   @param longHelpString [String] 
+    #   @return [ToolBarToolBase]
+    # @overload initialize(tbar, control, label)
+    #   @param tbar [Wx::ToolBarBase] 
+    #   @param control [Wx::Control] 
+    #   @param label [String] 
+    #   @return [ToolBarToolBase]
+    def initialize(*args) end
+    
+    # @return [Integer]
+    def get_id; end
+    alias_method :id, :get_id
+    
+    # @return [Wx::Control]
+    def get_control; end
+    alias_method :control, :get_control
+    
+    # @return [Wx::ToolBarBase]
+    def get_tool_bar; end
+    alias_method :tool_bar, :get_tool_bar
+    
+    # @return [true,false]
+    def is_stretchable; end
+    alias_method :stretchable?, :is_stretchable
+    
+    # @return [true,false]
+    def is_button; end
+    alias_method :button?, :is_button
+    
+    # @return [true,false]
+    def is_control; end
+    alias_method :control?, :is_control
+    
+    # @return [true,false]
+    def is_separator; end
+    alias_method :separator?, :is_separator
+    
+    # @return [true,false]
+    def is_stretchable_space; end
+    alias_method :stretchable_space?, :is_stretchable_space
+    
+    # @return [Integer]
+    def get_style; end
+    alias_method :style, :get_style
+    
+    # @return [ItemKind]
+    def get_kind; end
+    alias_method :kind, :get_kind
+    
+    # @return [void]
+    def make_stretchable; end
+    
+    # @return [true,false]
+    def is_enabled; end
+    alias_method :enabled?, :is_enabled
+    
+    # @return [true,false]
+    def is_toggled; end
+    alias_method :toggled?, :is_toggled
+    
+    # @return [true,false]
+    def can_be_toggled; end
+    alias_method :can_be_toggled?, :can_be_toggled
+    
+    # Return the bundle containing normal tool bitmaps.
+    # This bundle may be invalid if the tool doesn't show a bitmap.
+    # @return [Wx::BitmapBundle]
+    def get_normal_bitmap_bundle; end
+    alias_method :normal_bitmap_bundle, :get_normal_bitmap_bundle
+    
+    # Return the bundle containing disabled tool bitmaps.
+    # This bundle may be invalid if the tool doesn't show a bitmap or doesn't have a specific disabled bitmap creates one automatically from the normal bitmap.
+    # @return [Wx::BitmapBundle]
+    def get_disabled_bitmap_bundle; end
+    alias_method :disabled_bitmap_bundle, :get_disabled_bitmap_bundle
+    
+    # @return [Wx::Bitmap]
+    def get_normal_bitmap; end
+    alias_method :normal_bitmap, :get_normal_bitmap
+    
+    # @return [Wx::Bitmap]
+    def get_disabled_bitmap; end
+    alias_method :disabled_bitmap, :get_disabled_bitmap
+    
+    # @return [Wx::Bitmap]
+    def get_bitmap; end
+    alias_method :bitmap, :get_bitmap
+    
+    # @return [Wx::String]
+    def get_label; end
+    alias_method :label, :get_label
+    
+    # @return [Wx::String]
+    def get_short_help; end
+    alias_method :short_help, :get_short_help
+    
+    # @return [Wx::String]
+    def get_long_help; end
+    alias_method :long_help, :get_long_help
+    
+    # @return [Wx::Object]
+    def get_client_data; end
+    alias_method :client_data, :get_client_data
+    
+    # @param menu [Wx::Menu] 
+    # @return [void]
+    def set_dropdown_menu(menu) end
+    alias_method :dropdown_menu=, :set_dropdown_menu
+    
+    # @return [Wx::Menu]
+    def get_dropdown_menu; end
+    alias_method :dropdown_menu, :get_dropdown_menu
+    
+  end # ToolBarToolBase
+  
+
+end