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

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

@@ -7,11 +7,12 @@
 module Wx::RBN
 
   # Top-level control in a ribbon user interface.
+  # 
   # Serves as a tabbed container for {Wx::RBN::RibbonPage} - a ribbon user interface typically has a ribbon bar, which contains one or more {Wx::RibbonPages}, which in turn each contain one or more {Wx::RibbonPanels}, which in turn contain controls.
   # While a {Wx::RBN::RibbonBar} has tabs similar to a {Wx::Notebook}, it does not follow the same API for adding pages. Containers like {Wx::Notebook} can contain any type of window as a page, hence the normal procedure is to create the sub-window and then call {Wx::BookCtrlBase#add_page}. As {Wx::RBN::RibbonBar} can only have {Wx::RBN::RibbonPage} as children (and a {Wx::RBN::RibbonPage} can only have a {Wx::RBN::RibbonBar} as parent), when a page is created, it is automatically added to the bar - there is no AddPage equivalent to call.
   # After all pages have been created, and all controls and panels placed on those pages, {Wx::RBN::RibbonBar#realize} must be called.
   # 
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -35,7 +36,7 @@ module Wx::RBN
   # 
   # - {Wx::RBN::RibbonBarOption::RIBBON_BAR_SHOW_HELP_BUTTON}: Causes a help button to appear on the ribbon bar at the top-right corner. This style is new since wxWidgets 2.9.5. 
   # 
-  # === 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::RBN::RibbonBarEvent} events.
   # Event handler methods for events emitted by this class:
@@ -58,18 +59,18 @@ module Wx::RBN
   # 
   # - {Wx::EvtHandler#evt_ribbonbar_help_click}(id, meth = nil, &block): Triggered when the help button is clicked. This even is new since wxWidgets 2.9.5. 
   # 
-  # === 
-  # 
   # Category:  Ribbon User Interface
   # @see Wx::RBN::RibbonPage 
   # 
   # @see Wx::RBN::RibbonPanel
   # 
   # 
+  # @wxrb_require USE_RIBBON
   class RibbonBar < RibbonControl
   
     # @overload initialize()
     #   Default constructor.
+    #   
     #   With this constructor, {Wx::RBN::RibbonBar#create} should be called in order to create the ribbon bar.
     #   @return [Wx::RBN::RibbonBar]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::RBN::RibbonBarOption::RIBBON_BAR_DEFAULT_STYLE)
@@ -83,6 +84,7 @@ module Wx::RBN
     def initialize(*args) end
     
     # Create a ribbon bar in two-step ribbon 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] 
@@ -93,6 +95,7 @@ module Wx::RBN
     def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::RBN::RibbonBarOption::RIBBON_BAR_DEFAULT_STYLE) end
     
     # Set the margin widths (in pixels) on the left and right sides of the tab bar region of the ribbon bar.
+    # 
     # These margins will be painted with the tab background, but tabs and scroll buttons will never be painted in the margins.
     # The left margin could be used for rendering something equivalent to the "Office Button", though this is not currently implemented. The right margin could be used for rendering a help button, and/or MDI buttons, but again, this is not currently implemented.
     # @param left [Integer] 
@@ -101,6 +104,7 @@ module Wx::RBN
     def set_tab_ctrl_margins(left, right) end
     
     # Set the art provider to be used be the ribbon bar.
+    # 
     # Also sets the art provider on all current {Wx::RBN::RibbonPage} children, and any {Wx::RBN::RibbonPage} children added in the future.
     # Note that unlike most other ribbon controls, the ribbon bar creates a default art provider when initialised, so an explicit call to {Wx::RBN::RibbonBar#set_art_provider} is not required if the default art provider is sufficient. Also, unlike other ribbon controls, the ribbon bar takes ownership of the given pointer, and will delete it when the art provider is changed or the bar is destroyed. If this behaviour is not desired, then clone the art provider before setting it.
     # @param art [Wx::RBN::RibbonArtProvider] 
@@ -110,11 +114,13 @@ module Wx::RBN
     
     # @overload set_active_page(page)
     #   Set the active page by index, without triggering any events.
+    #   
     #   true if the specified page is now active, false if it could not be activated (for example because the page index is invalid).
     #   @param page [Integer]  The zero-based index of the page to activate.
     #   @return [Boolean]
     # @overload set_active_page(page)
     #   Set the active page, without triggering any events.
+    #   
     #   true if the specified page is now active, false if it could not be activated (for example because the given page is not a child of the ribbon bar).
     #   @param page [Wx::RBN::RibbonPage]  The page to activate.
     #   @return [Boolean]
@@ -122,12 +128,14 @@ module Wx::RBN
     alias_method :active_page=, :set_active_page
     
     # Get the index of the active page.
+    # 
     # In the rare case of no page being active, -1 is returned.
     # @return [Integer]
     def get_active_page; end
     alias_method :active_page, :get_active_page
     
     # Get a page by index.
+    # 
     # NULL will be returned if the given index is out of range.
     # @param n [Integer] 
     # @return [Wx::RBN::RibbonPage]
@@ -140,11 +148,13 @@ module Wx::RBN
     alias_method :page_count, :get_page_count
     
     # Dismiss the expanded panel of the currently active page.
+    # 
     # Calls and returns the value from {Wx::RBN::RibbonPage#dismiss_expanded_panel} for the currently active page, or false if there is no active page.
     # @return [Boolean]
     def dismiss_expanded_panel; end
     
     # Returns the number for a given ribbon bar page.
+    # 
     # The number can be used in other ribbon bar calls.
     # @param page [Wx::RBN::RibbonPage] 
     # @return [Integer]
@@ -152,6 +162,7 @@ module Wx::RBN
     alias_method :page_number, :get_page_number
     
     # Delete a single page from this ribbon bar.
+    # 
     # The user must call {Wx::RBN::RibbonBar#realize} after one (or more) calls to this function.
     # @param n [Integer] 
     # @return [void]
@@ -162,6 +173,7 @@ module Wx::RBN
     def clear_pages; end
     
     # Indicates whether the tab for the given page is shown to the user or not.
+    # 
     # By default all page tabs are shown.
     # @param page [Integer] 
     # @return [Boolean]
@@ -169,6 +181,7 @@ module Wx::RBN
     alias_method :page_shown?, :is_page_shown
     
     # Show or hide the tab for a given page.
+    # 
     # After showing or hiding a tab, you need to call {Wx::RBN::RibbonBar#realize}. If you hide the tab for the currently active page (GetActivePage) then you should call SetActivePage to activate a different page.
     # @param page [Integer] 
     # @param show_tab [Boolean] 
@@ -176,6 +189,7 @@ module Wx::RBN
     def show_page(page, show_tab=true) end
     
     # Hides the tab for a given page.
+    # 
     # Equivalent to <code>ShowPage(page, false)</code>.
     # @param page [Integer] 
     # @return [void]
@@ -183,6 +197,7 @@ module Wx::RBN
     
     # Indicates whether a tab is currently highlighted.
     # 
+    # 
     # @see Wx::RBN::RibbonBar#add_page_highlight
     # @param page [Integer] 
     # @return [Boolean]
@@ -190,6 +205,7 @@ module Wx::RBN
     alias_method :page_highlighted?, :is_page_highlighted
     
     # Highlight the specified tab.
+    # 
     # Highlighted tabs have a colour between that of the active tab and a tab over which the mouse is hovering. This can be used to make a tab (usually temporarily) more noticeable to the user.
     # @param page [Integer] 
     # @param highlight [Boolean] 
@@ -198,6 +214,7 @@ module Wx::RBN
     
     # Changes a tab to not be highlighted.
     # 
+    # 
     # @see Wx::RBN::RibbonBar#add_page_highlight
     # @param page [Integer] 
     # @return [void]
@@ -209,6 +226,7 @@ module Wx::RBN
     #   @return [void]
     # @overload show_panels(show=true)
     #   Shows or hides the panel area of the ribbon bar.
+    #   
     #   If the panel area is hidden, then only the tab of the ribbon bar will be shown. This is useful for giving the user more screen space to work with when he/she doesn't need to see the ribbon's options.
     #   If the panel is currently shown, this method pins it, use the other overload of this method to specify the exact panel display mode to avoid it.
     #   @param show [Boolean] 
@@ -216,24 +234,28 @@ module Wx::RBN
     def show_panels(*args) end
     
     # Hides the panel area of the ribbon bar.
+    # 
     # This method behaves like {Wx::RBN::RibbonBar#show_panels} with false argument.
     # @return [void]
     def hide_panels; end
     
     # Indicates whether the panel area of the ribbon bar is shown.
     # 
+    # 
     # @see Wx::RBN::RibbonBar#show_panels
     # @return [Boolean]
     def are_panels_shown; end
     
     # Returns the current display mode of the panel area.
     # 
+    # 
     # @see Wx::RBN::RibbonBar#show_panels
     # @return [Wx::RibbonDisplayMode]
     def get_display_mode; end
     alias_method :display_mode, :get_display_mode
     
     # Perform initial layout and size calculations of the bar and its children.
+    # 
     # This must be called after all of the bar's children have been created (and their children created, etc.) - if it is not, then windows may not be laid out or sized correctly.
     # Also calls {Wx::RBN::RibbonPage#realize} on each child page.
     # @return [Boolean]

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

@@ -7,17 +7,18 @@
 module Wx::RBN
 
   # Event used to indicate various actions relating to a {Wx::RBN::RibbonBar}.
+  # 
   # See {Wx::RBN::RibbonBar} for available event types.
-  # === 
   # 
   # Category:  {Wx::Events}, Ribbon User Interface
   # @see Wx::RBN::RibbonBar 
   # 
   # 
+  # @wxrb_require USE_RIBBON
   class RibbonBarEvent < NotifyEvent
   
     # Constructor.
-    # @param command_type [Wx::CommandLinkButton::EventType] 
+    # @param command_type [Wx::StaticLine::EventType] 
     # @param win_id [Integer] 
     # @param page [Wx::RBN::RibbonPage] 
     # @return [Wx::RBN::RibbonBarEvent]

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

@@ -11,6 +11,7 @@ module Wx::RBN
   # Buttons on a ribbon button bar can each come in three sizes: small, medium, and large. In some places this is called the size class, and the term size used for the pixel width and height associated with a particular size class.
   # A button can also be in zero or more hovered or active states, or in the disabled state.
   # 
+  # @wxrb_require USE_RIBBON
   class RibbonButtonBarButtonState < Wx::Enum
   
     # Button is small (the interpretation of small is dependent upon the art provider, but it will be smaller than medium).
@@ -76,6 +77,7 @@ module Wx::RBN
   EVT_RIBBONBUTTONBAR_DROPDOWN_CLICKED = 10441
   
   # A ribbon button bar is similar to a traditional toolbar.
+  # 
   # It contains one or more buttons (button bar buttons, not {Wx::Buttons}), each of which has a label and an icon. It differs from a {Wx::RBN::RibbonToolBar} in several ways: 
   # 
   # - Individual buttons can grow and contract. 
@@ -88,7 +90,7 @@ module Wx::RBN
   # 
   # - A button bar typically has a border around each individual button, whereas a tool bar typically has a border around each group of buttons.
   # 
-  # === 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::RBN::RibbonButtonBarEvent} events.
   # Event handler methods for events emitted by this class:
@@ -97,14 +99,14 @@ module Wx::RBN
   # 
   # - {Wx::EvtHandler#evt_ribbonbuttonbar_dropdown_clicked}(id, meth = nil, &block): Triggered when the dropdown region of a button on the button bar is clicked. {Wx::RBN::RibbonButtonBarEvent#popup_menu} should be called by the event handler if it wants to display a popup menu (which is what most dropdown buttons should be doing). 
   # 
-  # === 
-  # 
   # Category:  Ribbon User Interface
   # 
+  # @wxrb_require USE_RIBBON
   class RibbonButtonBar < RibbonControl
   
     # @overload initialize()
     #   Default constructor.
+    #   
     #   With this constructor, {Wx::RBN::RibbonButtonBar#create} should be called in order to create the button bar.
     #   @return [Wx::RBN::RibbonButtonBar]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0)
@@ -118,6 +120,7 @@ module Wx::RBN
     def initialize(*args) end
     
     # Create a button bar in two-step button 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] 
@@ -137,6 +140,7 @@ module Wx::RBN
     #   @return [Integer]
     # @overload add_button(button_id, label, bitmap, bitmap_small=Wx::NULL_BITMAP, bitmap_disabled=Wx::NULL_BITMAP, bitmap_small_disabled=Wx::NULL_BITMAP, kind=Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL, help_string=(''))
     #   Add a button to the button bar.
+    #   
     #   An opaque pointer which can be used only with other button bar methods.
     #   @see Wx::RBN::RibbonButtonBar#add_dropdown_button 
     #   
@@ -156,6 +160,7 @@ module Wx::RBN
     
     # Add a dropdown button to the button bar (simple version).
     # 
+    # 
     # @see Wx::RBN::RibbonButtonBar#add_button 
     # @param button_id [Integer] 
     # @param label [String] 
@@ -166,6 +171,7 @@ module Wx::RBN
     
     # Add a hybrid button to the button bar (simple version).
     # 
+    # 
     # @see Wx::RBN::RibbonButtonBar#add_button 
     # @param button_id [Integer] 
     # @param label [String] 
@@ -176,6 +182,7 @@ module Wx::RBN
     
     # Add a toggle button to the button bar (simple version).
     # 
+    # 
     # @see Wx::RBN::RibbonButtonBar#add_button 
     # @param button_id [Integer] 
     # @param label [String] 
@@ -187,6 +194,7 @@ module Wx::RBN
     # @overload insert_button(pos, button_id, label, bitmap, help_string, kind=Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL)
     #   Inserts a button to the button bar (simple version) at the given position.
     #   
+    #   
     #   @see Wx::RBN::RibbonButtonBar#add_button
     #   @param pos [Integer] 
     #   @param button_id [Integer] 
@@ -197,6 +205,7 @@ module Wx::RBN
     #   @return [Integer]
     # @overload insert_button(pos, button_id, label, bitmap, bitmap_small=Wx::NULL_BITMAP, bitmap_disabled=Wx::NULL_BITMAP, bitmap_small_disabled=Wx::NULL_BITMAP, kind=Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL, help_string=(''))
     #   Insert a button to the button bar at the given position.
+    #   
     #   An opaque pointer which can be used only with other button bar methods.
     #   @see Wx::RBN::RibbonButtonBar#insert_dropdown_button 
     #   
@@ -219,6 +228,7 @@ module Wx::RBN
     
     # Inserts a dropdown button to the button bar (simple version) at the given position.
     # 
+    # 
     # @see Wx::RBN::RibbonButtonBar#insert_button 
     # 
     # @see Wx::RBN::RibbonButtonBar#add_dropdown_button 
@@ -234,6 +244,7 @@ module Wx::RBN
     
     # Inserts a hybrid button to the button bar (simple version) at the given position.
     # 
+    # 
     # @see Wx::RBN::RibbonButtonBar#insert_button 
     # 
     # @see Wx::RBN::RibbonButtonBar#add_hybrid_button 
@@ -249,6 +260,7 @@ module Wx::RBN
     
     # Inserts a toggle button to the button bar (simple version) at the given position.
     # 
+    # 
     # @see Wx::RBN::RibbonButtonBar#insert_button 
     # 
     # @see Wx::RBN::RibbonButtonBar#add_toggle_button 
@@ -267,21 +279,23 @@ module Wx::RBN
     def get_button_count; end
     alias_method :button_count, :get_button_count
     
-    # Set the client data associated with a button.
-    # Please, note that you cannot use both client object and client data.
+    # Set the client object associated with a button.
+    # 
+    # The button bar owns the given object and takes care of its deletion. Please, note that you cannot use both client object and client data.
     # @param item [Integer] 
     # @param data [Object] 
     # @return [void]
-    def set_item_client_data(item, data) end
+    def set_item_client_object(item, data) end
     
-    # Get the client data associated with a button.
+    # Get the client object associated with a button.
     # @param item [Integer] 
     # @return [Object]
-    def get_item_client_data(item) end
-    alias_method :item_client_data, :get_item_client_data
+    def get_item_client_object(item) end
+    alias_method :item_client_object, :get_item_client_object
     
     # Returns the N-th button of the bar.
     # 
+    # 
     # @see Wx::RBN::RibbonButtonBar#get_button_count
     # @param n [Integer] 
     # @return [Integer]
@@ -295,17 +309,20 @@ module Wx::RBN
     alias_method :item_rect, :get_item_rect
     
     # Calculate button layouts and positions.
+    # 
     # Must be called after buttons are added to the button bar, as otherwise the newly added buttons will not be displayed. In normal situations, it will be called automatically when {Wx::RBN::RibbonBar#realize} is called.
     # @return [Boolean]
     def realize; end
     
     # Delete all buttons from the button bar.
     # 
+    # 
     # @see Wx::RBN::RibbonButtonBar#delete_button 
     # @return [void]
     def clear_buttons; end
     
     # Delete a single button from the button bar.
+    # 
     # The corresponding button is deleted by this function, so any pointers to it previously obtained by {Wx::RBN::RibbonButtonBar#get_item} or {Wx::RBN::RibbonButtonBar#get_item_by_id} become invalid.
     # @see Wx::RBN::RibbonButtonBar#clear_buttons 
     # @param button_id [Integer] 
@@ -334,7 +351,12 @@ module Wx::RBN
     def set_button_icon(button_id, bitmap, bitmap_small=Wx::NULL_BITMAP, bitmap_disabled=Wx::NULL_BITMAP, bitmap_small_disabled=Wx::NULL_BITMAP) end
     
     # Changes the label text of an existing button.
-    # If text size has changed, {Wx::RBN::RibbonButtonBar#realize} must be called on the top level {Wx::RBN::RibbonBar} object to recalculate panel sizes. Use {Wx::RBN::RibbonButtonBar#set_button_text_min_width} to avoid calling {Wx::RBN::RibbonButtonBar#realize} after every change.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>If text size has changed, {Wx::RBN::RibbonButtonBar#realize} must be called on the top level {Wx::RBN::RibbonBar} object to recalculate panel sizes. Use {Wx::RBN::RibbonButtonBar#set_button_text_min_width} to avoid calling {Wx::RBN::RibbonButtonBar#realize} after every change.
+    # </p>
+    # </div>
     # @see Wx::RBN::RibbonButtonBar#set_button_text_min_width
     # @param button_id [Integer]  ID of the button to manipulate.
     # @param label [String]  New label of the button.
@@ -343,9 +365,14 @@ module Wx::RBN
     
     # @overload set_button_text_min_width(button_id, min_width_medium, min_width_large)
     #   Sets the minimum width of the button label, to indicate to the {Wx::RBN::RibbonArtProvider} layout mechanism that this is the minimum required size.
+    #   
     #   You have to call {Wx::RBN::RibbonButtonBar#realize} after calling this function to apply the given minimum width.
     #   
-    #   This function is used together with {Wx::RBN::RibbonButtonBar#set_button_text} to change button labels on the fly without modifying the button bar layout.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This function is used together with {Wx::RBN::RibbonButtonBar#set_button_text} to change button labels on the fly without modifying the button bar layout.
+    #   </p>
+    #   </div>
     #   @see Wx::RBN::RibbonButtonBar#set_button_text
     #   @param button_id [Integer]  ID of the button to manipulate.
     #   @param min_width_medium [Integer]  Requested minimum width of the button text in pixel if the button is medium size.
@@ -353,9 +380,14 @@ module Wx::RBN
     #   @return [void]
     # @overload set_button_text_min_width(button_id, label)
     #   Sets the minimum width of the button label, to indicate to the {Wx::RBN::RibbonArtProvider} layout mechanism that this is the minimum required size.
+    #   
     #   You have to call {Wx::RBN::RibbonButtonBar#realize} after calling this function to apply the given minimum width.
     #   
-    #   This function is used together with {Wx::RBN::RibbonButtonBar#set_button_text} to change button labels on the fly without modifying the button bar layout.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This function is used together with {Wx::RBN::RibbonButtonBar#set_button_text} to change button labels on the fly without modifying the button bar layout.
+    #   </p>
+    #   </div>
     #   @see Wx::RBN::RibbonButtonBar#set_button_text
     #   @param button_id [Integer]  ID of the button to manipulate.
     #   @param label [String]  The minimum width is set to the width of this label.
@@ -363,6 +395,7 @@ module Wx::RBN
     def set_button_text_min_width(*args) end
     
     # Sets the minimum size class of a ribbon button.
+    # 
     # You have to call {Wx::RBN::RibbonButtonBar#realize} after calling this function to apply the given minimum size.
     # @param button_id [Integer]  ID of the button to manipulate.
     # @param min_size_class [Wx::RibbonButtonBarButtonState]  The minimum size-class of the button. Buttons on a button bar can have three distinct sizes: {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_SMALL}, {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_MEDIUM}, and {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_LARGE}.
@@ -370,6 +403,7 @@ module Wx::RBN
     def set_button_min_size_class(button_id, min_size_class) end
     
     # Sets the maximum size class of a ribbon button.
+    # 
     # You have to call {Wx::RBN::RibbonButtonBar#realize} after calling this function to apply the given maximum size.
     # @param button_id [Integer]  ID of the button to manipulate.
     # @param max_size_class [Wx::RibbonButtonBarButtonState]  The maximum size-class of the button. Buttons on a button bar can have three distinct sizes: {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_SMALL}, {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_MEDIUM}, and {Wx::RBN::RibbonButtonBarButtonState::RIBBON_BUTTONBAR_BUTTON_LARGE}.
@@ -377,18 +411,21 @@ module Wx::RBN
     def set_button_max_size_class(button_id, max_size_class) end
     
     # Returns the active item of the button bar or NULL if there is none.
+    # 
     # The active button is the one being clicked.
     # @return [Integer]
     def get_active_item; end
     alias_method :active_item, :get_active_item
     
     # Returns the hovered item of the button bar or NULL if there is none.
+    # 
     # The hovered button is the one the mouse is over.
     # @return [Integer]
     def get_hovered_item; end
     alias_method :hovered_item, :get_hovered_item
     
     # Indicates whether tooltips are shown for disabled buttons.
+    # 
     # By default they are not shown.
     # @param show [Boolean] 
     # @return [void]
@@ -396,6 +433,7 @@ module Wx::RBN
     alias_method :show_tool_tips_for_disabled=, :set_show_tool_tips_for_disabled
     
     # Sets whether tooltips should be shown for disabled buttons or not.
+    # 
     # You may wish to show it to explain why a button is disabled or what it normally does when enabled.
     # @return [Boolean]
     def get_show_tool_tips_for_disabled; end

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

@@ -7,18 +7,19 @@
 module Wx::RBN
 
   # Event used to indicate various actions relating to a button on a {Wx::RBN::RibbonButtonBar}.
+  # 
   # For toggle buttons, {Wx::RBN::RibbonButtonBarEvent#is_checked} can be used to test the state of the button.
   # See {Wx::RBN::RibbonButtonBar} for available event types.
-  # === 
   # 
   # Category:  {Wx::Events}, Ribbon User Interface
   # @see Wx::RBN::RibbonBar 
   # 
   # 
+  # @wxrb_require USE_RIBBON
   class RibbonButtonBarEvent < CommandEvent
   
     # Constructor.
-    # @param command_type [Wx::CommandLinkButton::EventType] 
+    # @param command_type [Wx::StaticLine::EventType] 
     # @param win_id [Integer] 
     # @param bar [Wx::RBN::RibbonButtonBar] 
     # @param button [Integer] 

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

@@ -7,12 +7,13 @@
 module Wx::RBN
 
   # {Wx::RBN::RibbonControl} serves as a base class for all controls which share the ribbon characteristics of having a ribbon art provider, and (optionally) non-continuous resizing.
+  # 
   # Despite what the name may imply, it is not the top-level control for creating a ribbon interface - that is {Wx::RBN::RibbonBar}.
   # Ribbon controls often have a region which is "transparent", and shows the contents of the ribbon page or panel behind it. If implementing a new ribbon control, then it may be useful to realise that this effect is done by the art provider when painting the background of the control, and hence in the paint handler for the new control, you should call a draw background method on the art provider ({Wx::RBN::RibbonArtProvider#draw_button_bar_background} and {Wx::RBN::RibbonArtProvider#draw_tool_bar_background} typically just redraw what is behind the rectangle being painted) if you want transparent regions.
-  # === 
   # 
   # Category:  Ribbon User Interface
   # 
+  # @wxrb_require USE_RIBBON
   class RibbonControl < Control
   
     # @overload initialize()
@@ -20,6 +21,7 @@ module Wx::RBN
     #   @return [Wx::RBN::RibbonControl]
     # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::CONTROL_NAME_STR)
     #   Constructor.
+    #   
     #   If parent is a {Wx::RBN::RibbonControl} with a non-NULL art provider, then the art provider of new control is set to that of parent.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -32,6 +34,7 @@ module Wx::RBN
     def initialize(*args) end
     
     # Set the art provider to be used.
+    # 
     # In many cases, setting the art provider will also set the art provider on all child windows which extend {Wx::RBN::RibbonControl}.
     # In most cases, controls will not take ownership of the given pointer, with the notable exception being {Wx::RBN::RibbonBar#set_art_provider}.
     # @param art [Wx::RBN::RibbonArtProvider] 
@@ -40,11 +43,13 @@ module Wx::RBN
     alias_method :art_provider=, :set_art_provider
     
     # Get the art provider to be used.
+    # 
     # Note that until an art provider has been set in some way, this function may return NULL.
     # @return [Wx::RBN::RibbonArtProvider]
     def get_art_provider; end
     alias_method :art_provider, :get_art_provider
     
+    # 
     # 
     # true if this window can take any size (greater than its minimum size), false if it can only take certain sizes.
     # @see Wx::RBN::RibbonControl#get_next_smaller_size 
@@ -56,12 +61,14 @@ module Wx::RBN
     
     # @overload get_next_smaller_size(direction)
     #   If sizing is not continuous, then return a suitable size for the control which is smaller than the current size.
+    #   
     #   The current size if there is no smaller size, otherwise a suitable size which is smaller in the given direction(s), and the same as the current size in the other direction (if any).
     #   @see Wx::RBN::RibbonControl#is_sizing_continuous 
     #   @param direction [Wx::Orientation]  The direction(s) in which the size should reduce.
     #   @return [Wx::Size]
     # @overload get_next_smaller_size(direction, relative_to)
     #   If sizing is not continuous, then return a suitable size for the control which is smaller than the given size.
+    #   
     #   relative_to if there is no smaller size, otherwise a suitable size which is smaller in the given direction(s), and the same as relative_to in the other direction (if any).
     #   @see Wx::RBN::RibbonControl#is_sizing_continuous 
     #   
@@ -74,12 +81,14 @@ module Wx::RBN
     
     # @overload get_next_larger_size(direction)
     #   If sizing is not continuous, then return a suitable size for the control which is larger than the current size.
+    #   
     #   The current size if there is no larger size, otherwise a suitable size which is larger in the given direction(s), and the same as the current size in the other direction (if any).
     #   @see Wx::RBN::RibbonControl#is_sizing_continuous 
     #   @param direction [Wx::Orientation]  The direction(s) in which the size should increase.
     #   @return [Wx::Size]
     # @overload get_next_larger_size(direction, relative_to)
     #   If sizing is not continuous, then return a suitable size for the control which is larger than the given size.
+    #   
     #   relative_to if there is no larger size, otherwise a suitable size which is larger in the given direction(s), and the same as relative_to in the other direction (if any).
     #   @see Wx::RBN::RibbonControl#is_sizing_continuous 
     #   
@@ -104,6 +113,7 @@ module Wx::RBN
     alias_method :ancestor_ribbon_bar, :get_ancestor_ribbon_bar
     
     # Finds the best width and height given the parent's width and height.
+    # 
     # Used to implement the {Wx::RBN::RibbonPanelOption::RIBBON_PANEL_FLEXIBLE} panel style.
     # @param parentSize [Array(Integer, Integer), Wx::Size] 
     # @return [Wx::Size]