wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -10,6 +10,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_TOOLBAR
   class ToolBarToolStyle < Wx::Enum
   
     # 
@@ -91,11 +92,12 @@ module Wx
   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>wxMSW note</b>: Note that under wxMSW 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: 
+  # <b>WXMSW note</b>: Note that under WXMSW 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: 
   # ```ruby
   #   Wx::SystemOptions.set_option('msw.remap', 0)
   # ```
@@ -104,7 +106,7 @@ module Wx
   #   Wx::SystemOptions.set_option('msw.remap', 2)
   # ```
   #  Then colour remapping is switched off, and a transparent background used.  
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -136,8 +138,8 @@ module Wx
   # 
   # - {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 wxMSW 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
+  # See also Window Styles. Note that the WXMSW 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:
@@ -150,28 +152,33 @@ module Wx
   # 
   # - {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 wxOSX.) 
+  # - {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 WXOSX.) 
   # 
-  # - {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 wxOSX.) 
+  # - {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 WXOSX.) 
   # 
-  # - {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 wxOSX.) 
+  # - {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 WXOSX.) 
   # 
   # - {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 
   # 
   # 
+  # @wxrb_require USE_TOOLBAR
   class ToolBar < Control
   
     # @overload add_tool(toolId, label, bitmap, shortHelp=(''), kind=Wx::ItemKind::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.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>After you have added tools to a toolbar, you must call {Wx::ToolBar#realize} in order to have the tools appear.
+    #   </p>
+    #   </div>
     #   @see Wx::ToolBar#add_separator
     #   @see  Wx::ToolBar#add_check_tool
     #   @see  Wx::ToolBar#add_radio_tool
@@ -187,7 +194,12 @@ module Wx
     #   @return [Wx::ToolBarToolBase]
     # @overload add_tool(toolId, label, bitmap, bmpDisabled, kind=Wx::ItemKind::ITEM_NORMAL, shortHelp=(''), longHelp=(''), 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.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>After you have added tools to a toolbar, you must call {Wx::ToolBar#realize} in order to have the tools appear.
+    #   </p>
+    #   </div>
     #   @see Wx::ToolBar#add_separator
     #   @see  Wx::ToolBar#add_check_tool
     #   @see  Wx::ToolBar#add_radio_tool
@@ -207,6 +219,7 @@ module Wx
     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.
@@ -227,14 +240,24 @@ module Wx
     
     # @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.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>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.
+    #   </p>
+    #   </div>
     #   @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.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>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.
+    #   </p>
+    #   </div>
     #   @see Wx::ToolBar#get_margins
     #   @see  Wx::Size 
     #   @param size [Array(Integer, Integer), Wx::Size]  Margin size.
@@ -247,7 +270,12 @@ module Wx
     #   @return [Wx::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.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>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. 
+    #   </p>
+    #   </div>
     #   @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.
@@ -258,6 +286,7 @@ module Wx
     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] 
@@ -271,13 +300,19 @@ module Wx
     def add_check_tool(toolId, label, bitmap1, bmpDisabled=Wx::NULL_BITMAP, shortHelp=(''), longHelp=(''), clientData=nil) end
     
     # Adds any control to the toolbar, typically e.g. a {Wx::ComboBox}.
-    # wxMac: labels are only displayed if wxWidgets is built with {Wx::MAC_USE_NATIVE_TOOLBAR} set to 1
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>WXOSX: labels are only displayed if wxWidgets is built with {Wx::MAC_USE_NATIVE_TOOLBAR} set to 1 
+    # </p>
+    # </div>
     # @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=('')) 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 
@@ -292,6 +327,7 @@ module Wx
     def add_radio_tool(toolId, label, bitmap1, bmpDisabled=Wx::NULL_BITMAP, shortHelp=(''), longHelp=(''), 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
@@ -300,6 +336,7 @@ module Wx
     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
@@ -312,8 +349,14 @@ module Wx
     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.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>It is unnecessary to call {Wx::ToolBar#realize} for the change to take place, it will happen immediately.
+    # </p>
+    # </div>
     # 
     # true if the tool was deleted, false otherwise.
     # @see Wx::ToolBar#delete_tool_by_pos 
@@ -327,7 +370,12 @@ module Wx
     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.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Some implementations will change the visible state of the tool to indicate that it is disabled.
+    # </p>
+    # </div>
     # @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}.
@@ -346,9 +394,14 @@ module Wx
     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 wxGTK (always returns NULL there).
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Currently not implemented in WXGTK (always returns NULL there). 
+    # </p>
+    # </div>
     # @param x [Integer]  X position.
     # @param y [Integer]  Y position.
     # @return [Wx::ToolBarToolBase]
@@ -356,15 +409,22 @@ module Wx
     
     # 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.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>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.
+    # </p>
+    # </div>
     # @see Wx::ToolBar#set_tool_bitmap_size
     # @see  Wx::ToolBar#get_tool_size 
     # @return [Wx::Size]
@@ -377,6 +437,7 @@ module Wx
     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]
@@ -384,6 +445,7 @@ module Wx
     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}.
@@ -393,6 +455,7 @@ module Wx
     
     # 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}.
@@ -402,6 +465,7 @@ module Wx
     
     # Returns the value used for packing tools.
     # 
+    # 
     # @see Wx::ToolBar#set_tool_packing 
     # @return [Integer]
     def get_tool_packing; end
@@ -415,6 +479,7 @@ module Wx
     
     # Returns the default separator size.
     # 
+    # 
     # @see Wx::ToolBar#set_tool_separation 
     # @return [Integer]
     def get_tool_separation; end
@@ -422,6 +487,7 @@ module Wx
     
     # 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}.
@@ -431,6 +497,7 @@ module Wx
     
     # 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]
@@ -438,6 +505,7 @@ module Wx
     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}.
@@ -451,6 +519,7 @@ module Wx
     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 
@@ -461,6 +530,7 @@ module Wx
     def insert_control(pos, control, label=('')) 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 
@@ -469,6 +539,7 @@ module Wx
     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
@@ -477,6 +548,7 @@ module Wx
     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.
@@ -488,9 +560,14 @@ module Wx
     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.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>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. 
+    # </p>
+    # </div>
     # @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
@@ -500,14 +577,21 @@ module Wx
     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.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>It is unnecessary to call {Wx::ToolBar#realize} for the change to take place, it will happen immediately.
+    # </p>
+    # </div>
     # @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] 
@@ -516,6 +600,7 @@ module Wx
     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): 
@@ -539,16 +624,26 @@ module Wx
     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.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>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. 
+    # </p>
+    # </div>
     # @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.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>You might use the long help for displaying the tool purpose on the status line.
+    # </p>
+    # </div>
     # @see Wx::ToolBar#get_tool_long_help
     # @see  Wx::ToolBar#set_tool_short_help
     # @see  
@@ -558,6 +653,7 @@ module Wx
     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.
@@ -565,9 +661,14 @@ module Wx
     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.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>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.
+    # </p>
+    # </div>
     # @see Wx::ToolBar#get_tool_packing 
     # @param packing [Integer]  The value for packing.
     # @return [void]
@@ -575,6 +676,7 @@ module Wx
     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.
@@ -583,7 +685,12 @@ module Wx
     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.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>An application might use short help for identifying the tool purpose in a tooltip.
+    # </p>
+    # </div>
     # @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}.
@@ -592,9 +699,14 @@ module Wx
     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.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Only applies to a tool that has been specified as a toggle tool. 
+    # </p>
+    # </div>
     # @param toolId [Integer]  ID of the tool in question, as passed to {Wx::ToolBar#add_tool}.
     # @param toggle [Boolean]  If true, toggles the tool on, otherwise toggles it off.
     # @return [void]
@@ -625,9 +737,11 @@ module Wx
   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.
   # 
+  # @wxrb_require USE_TOOLBAR
   class ToolBarToolBase < Object
   
     # @overload initialize(tbar=nil, toolid=Wx::StandardID::ID_SEPARATOR, label=(''), bmpNormal=Wx::NULL_BITMAP, bmpDisabled=Wx::NULL_BITMAP, kind=Wx::ItemKind::ITEM_NORMAL, clientData=nil, shortHelpString=(''), longHelpString=(''))
@@ -704,12 +818,14 @@ module Wx
     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

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

@@ -7,11 +7,12 @@
 module Wx
 
   # This class holds information about a tooltip associated with a window (see {Wx::Window#set_tool_tip}).
+  # 
   # The four static methods, {Wx::ToolTip.enable}, {Wx::ToolTip.set_delay} {Wx::ToolTip.set_auto_pop} and {Wx::ToolTip.set_reshow} can be used to globally alter tooltips behaviour.
-  # === 
   # 
   # Category:  {Wx::HELP}
   # 
+  # @wxrb_require USE_TOOLTIPS
   class ToolTip < Object
   
     # Constructor.
@@ -36,25 +37,60 @@ module Wx
     alias_method :tip=, :set_tip
     
     # Enable or disable tooltips globally.
-    # May not be supported on all platforms (eg. {Wx::Cocoa}).
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>May not be supported on all platforms (eg. {Wx::Cocoa}). 
+    # </p>
+    # </div>
     # @param flag [Boolean] 
     # @return [void]
     def self.enable(flag) end
     
     # Set the delay after which the tooltip disappears or how long a tooltip remains visible.
-    # May not be supported on all platforms (eg. {Wx::Cocoa}, GTK).
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>May not be supported on all platforms (eg. {Wx::Cocoa}, GTK). 
+    # </p>
+    # </div>
     # @param msecs [Integer] 
     # @return [void]
     def self.set_auto_pop(msecs) end
     
     # Set the delay after which the tooltip appears.
-    # May not be supported on all platforms.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>May not be supported on all platforms. 
+    # </p>
+    # </div>
     # @param msecs [Integer] 
     # @return [void]
     def self.set_delay(msecs) end
     
+    # Set tooltip maximal width in pixels.
+    # 
+    # By default, tooltips are wrapped at a suitably chosen width. You can pass -1 as width to disable wrapping them completely, 0 to restore the default behaviour or an arbitrary positive value to wrap them at the given width.
+    # Notice that this function does not change the width of the tooltips created before calling it.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Currently this function is WXMSW-only. 
+    # </p>
+    # </div>
+    # @param width [Integer] 
+    # @return [void]
+    # @wxrb_require WXMSW
+    def self.set_max_width(width) end
+    
     # Set the delay between subsequent tooltips to appear.
-    # May not be supported on all platforms (eg. {Wx::Cocoa}, GTK).
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>May not be supported on all platforms (eg. {Wx::Cocoa}, GTK). 
+    # </p>
+    # </div>
     # @param msecs [Integer] 
     # @return [void]
     def self.set_reshow(msecs) end

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

@@ -21,9 +21,10 @@ module Wx
   EVT_TOOLBOOK_PAGE_CHANGING = 10090
   
   # {Wx::Toolbook} is a class similar to {Wx::Notebook} but which uses a {Wx::ToolBar} to show the labels instead of the tabs.
+  # 
   # There is no documentation for this class yet but its usage is identical to {Wx::Notebook} (except for the features clearly related to tabs only), so please refer to that class documentation for now. You can also use the Notebook Sample to see {Wx::Toolbook} in action.
   # One feature of this class not supported by {Wx::BookCtrlBase} is the support for disabling some of the pages, see {Wx::Toolbook#enable_page}.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -32,7 +33,7 @@ module Wx
   # - {Wx::TBK_HORZ_LAYOUT}: Shows the text and the icons alongside, not vertically stacked (only implement under Windows and GTK 2 platforms as it relies on {Wx::TB_HORZ_LAYOUT} flag support). 
   # 
   # The common {Wx::BookCtrl} styles described in the wxBookCtrl Overview are also supported.
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::BookCtrlEvent} events.
   # Event handler methods for events emitted by this class:
@@ -41,8 +42,6 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_toolbook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_TOOLBOOK_PAGE_CHANGING} event. This event can be vetoed (using {Wx::NotifyEvent#veto}). 
   # 
-  # === 
-  # 
   # Category:  Book Controls
   # @see wxBookCtrl Overview
   # @see  Wx::BookCtrlBase
@@ -50,6 +49,7 @@ module Wx
   # @see  Notebook Sample 
   # 
   # 
+  # @wxrb_require USE_TOOLBOOK
   class Toolbook < BookCtrlBase
   
     # @overload initialize()
@@ -83,6 +83,7 @@ module Wx
     
     # @overload enable_page(page, enable)
     #   Enables or disables the specified page.
+    #   
     #   Using this function, a page can be disabled when it can't be used, while still remaining present to let the users know that more functionality is available, even if currently inaccessible.
     #   Icons for disabled pages are created by {Wx::Bitmap#convert_to_disabled}.
     #   
@@ -92,6 +93,7 @@ module Wx
     #   @return [Boolean]
     # @overload enable_page(page, enable)
     #   Enables or disables the specified page.
+    #   
     #   This is similar to the overload above, but finds the index of the specified page.
     #   
     #   true if successful, false otherwise, e.g. if page is not one of the pages of this control.