wxruby3 0.9.2-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -77,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. 
@@ -105,6 +106,7 @@ module Wx::RBN
   
     # @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,11 +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.
+    # 
     # <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>>
+    # </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.
@@ -347,13 +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.
     #   
     #   <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>>
+    #   </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.
@@ -361,13 +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.
     #   
     #   <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>>
+    #   </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.
@@ -375,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}.
@@ -382,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}.
@@ -389,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]
@@ -408,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,6 +7,7 @@
 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.
   # 
@@ -18,7 +19,7 @@ module Wx::RBN
   class RibbonButtonBarEvent < CommandEvent
   
     # Constructor.
-    # @param command_type [Wx::Slider::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,6 +7,7 @@
 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.
   # 
@@ -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]

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

@@ -44,6 +44,7 @@ module Wx::RBN
   EVT_RIBBONGALLERY_CLICKED = 10439
   
   # A ribbon gallery is like a {Wx::ListBox}, but for bitmaps rather than strings.
+  # 
   # It displays a collection of bitmaps arranged in a grid and allows the user to choose one. As there are typically more bitmaps in a gallery than can be displayed in the space used for a ribbon, a gallery always has scroll buttons to allow the user to navigate through the entire gallery. It also has an "extension" button, the behaviour of which is outside the scope of the gallery control itself, though it typically displays some kind of dialog related to the gallery.
   # ### Events emitted by this class
   # 
@@ -70,6 +71,7 @@ module Wx::RBN
   
     # @overload initialize()
     #   Default constructor.
+    #   
     #   With this constructor, {Wx::RBN::RibbonGallery#create} should be called in order to create the gallery.
     #   @return [Wx::RBN::RibbonGallery]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0)
@@ -83,6 +85,7 @@ module Wx::RBN
     def initialize(*args) end
     
     # Create a gallery in two-step gallery 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] 
@@ -118,26 +121,27 @@ module Wx::RBN
     #   @param id [Integer]  ID number to associate with the item. Not currently used for anything important.
     #   @return [Integer]
     # @overload append(bitmap, id, clientData)
-    #   Add an item to the gallery (with simple client data).
+    #   Add an item to the gallery (with complex client data)
     #   @param bitmap [Wx::Bitmap]  The bitmap to display for the item. Note that all items must have equally sized bitmaps.
     #   @param id [Integer]  ID number to associate with the item. Not currently used for anything important.
-    #   @param clientData [Object]  An opaque pointer to associate with the item.
+    #   @param clientData [Object]  An object which contains data to associate with the item. The item takes ownership of this pointer, and will delete it when the item client data is changed to something else, or when the item is destroyed.
     #   @return [Integer]
     def append(*args) end
     
-    # Set the client data associated with a gallery item.
+    # Set the client object associated with a gallery item.
     # @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 gallery item.
+    # Get the client object associated with a gallery item.
     # @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
     
     # Set the selection to the given item, or removes the selection if item == NULL.
+    # 
     # Note that this not cause any events to be emitted.
     # @param item [Integer] 
     # @return [void]
@@ -145,18 +149,21 @@ module Wx::RBN
     alias_method :selection=, :set_selection
     
     # Get the currently selected item, or NULL if there is none.
+    # 
     # The selected item is set by {Wx::RBN::RibbonGallery#set_selection}, or by the user clicking on an item.
     # @return [Integer]
     def get_selection; end
     alias_method :selection, :get_selection
     
     # Get the currently hovered item, or NULL if there is none.
+    # 
     # The hovered item is the item underneath the mouse cursor.
     # @return [Integer]
     def get_hovered_item; end
     alias_method :hovered_item, :get_hovered_item
     
     # Get the currently active item, or NULL if there is none.
+    # 
     # The active item is the item being pressed by the user, and will thus become the selected item if the user releases the mouse button.
     # @return [Integer]
     def get_active_item; end
@@ -178,18 +185,21 @@ module Wx::RBN
     alias_method :extension_button_state, :get_extension_button_state
     
     # Query is the mouse is currently hovered over the gallery.
+    # 
     # true if the cursor is within the bounds of the gallery (not just hovering over an item), false otherwise.
     # @return [Boolean]
     def is_hovered; end
     alias_method :hovered?, :is_hovered
     
     # Scroll the gallery contents by some amount.
+    # 
     # true if the gallery scrolled at least one pixel in the given direction, false if it did not scroll.
     # @param lines [Integer]  Positive values scroll toward the end of the gallery, while negative values scroll toward the start.
     # @return [Boolean]
     def scroll_lines(lines) end
     
     # Scroll the gallery contents by some fine-grained amount.
+    # 
     # true if the gallery scrolled at least one pixel in the given direction, false if it did not scroll.
     # @param pixels [Integer]  Positive values scroll toward the end of the gallery, while negative values scroll toward the start.
     # @return [Boolean]

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

@@ -6,6 +6,7 @@
 
 module Wx::RBN
 
+  # 
   # 
   # Category:  {Wx::Events}, Ribbon User Interface
   # @see Wx::RBN::RibbonBar 
@@ -15,7 +16,7 @@ module Wx::RBN
   class RibbonGalleryEvent < CommandEvent
   
     # Constructor.
-    # @param command_type [Wx::Slider::EventType] 
+    # @param command_type [Wx::StaticLine::EventType] 
     # @param win_id [Integer] 
     # @param gallery [Wx::RBN::RibbonGallery] 
     # @param item [Integer] 

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

@@ -7,6 +7,7 @@
 module Wx::RBN
 
   # Container for related ribbon panels, and a tab within a ribbon bar.
+  # 
   # Category:  Ribbon User Interface
   # @see Wx::RBN::RibbonBar 
   # 
@@ -18,6 +19,7 @@ module Wx::RBN
   
     # @overload initialize()
     #   Default constructor.
+    #   
     #   With this constructor, {Wx::RBN::RibbonPage#create} should be called in order to create the ribbon page.
     #   @return [Wx::RBN::RibbonPage]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, label=(''), icon=Wx::NULL_BITMAP, style=0)
@@ -31,6 +33,7 @@ module Wx::RBN
     def initialize(*args) end
     
     # Create a ribbon page in two-step ribbon page 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::RBN::RibbonBar] 
     # @param id [Integer] 
@@ -41,6 +44,7 @@ module Wx::RBN
     def create(parent, id=Wx::StandardID::ID_ANY, label=(''), icon=Wx::NULL_BITMAP, style=0) end
     
     # Set the art provider to be used.
+    # 
     # Normally called automatically by {Wx::RBN::RibbonBar} when the page is created, or the art provider changed on the bar.
     # The new art provider will be propagated to the children of the page.
     # @param art [Wx::RBN::RibbonArtProvider] 
@@ -54,6 +58,7 @@ module Wx::RBN
     alias_method :icon, :get_icon
     
     # Set the size of the page and the external scroll buttons (if any).
+    # 
     # When a page is too small to display all of its children, scroll buttons will appear (and if the page is sized up enough, they will disappear again). Slightly counter-intuitively, these buttons are created as siblings of the page rather than children of the page (to achieve correct cropping and paint ordering of the children and the buttons). When there are no scroll buttons, this function behaves the same as {Wx::RBN::RibbonPage#set_size}, however when there are scroll buttons, it positions them at the edges of the given area, and then calls {Wx::RBN::RibbonPage#set_size} with the remaining area.
     # This is provided as a separate function to {Wx::RBN::RibbonPage#set_size} rather than within the implementation of {Wx::RBN::RibbonPage#set_size}, as interacting algorithms may not expect {Wx::RBN::RibbonPage#set_size} to also set the size of siblings.
     # @param x [Integer] 
@@ -64,24 +69,28 @@ module Wx::RBN
     def set_size_with_scroll_button_adjustment(x, y, width, height) end
     
     # Expand a rectangle of the page to include external scroll buttons (if any).
+    # 
     # When no scroll buttons are shown, has no effect.
     # @param rect [Wx::Rect]  The rectangle to adjust. The width and height will not be reduced, and the x and y will not be increased.
     # @return [void]
     def adjust_rect_to_include_scroll_buttons(rect) end
     
     # Dismiss the current externally expanded panel, if there is one.
+    # 
     # When a ribbon panel automatically minimises, it can be externally expanded into a floating window. When the user clicks a button in such a panel, the panel should generally re-minimise. Event handlers for buttons on ribbon panels should call this method to achieve this behaviour.
     # true if a panel was minimised, false otherwise.
     # @return [Boolean]
     def dismiss_expanded_panel; end
     
     # Perform a full re-layout of all panels on the page.
+    # 
     # Should be called after panels are added to the page, or the sizing behaviour of a panel on the page changes (i.e. due to children being added to it). Usually called automatically when {Wx::RBN::RibbonBar#realize} is called.
     # Will invoke {Wx::RBN::RibbonPanel#realize} for all child panels.
     # @return [Boolean]
     def realize; end
     
     # Scroll the page by some amount up / down / left / right.
+    # 
     # When the page's children are too big to fit in the onscreen area given to the page, scroll buttons will appear, and the page can be programmatically scrolled. Positive values of lines will scroll right or down, while negative values will scroll up or left (depending on the direction in which panels are stacked). A line is equivalent to a constant number of pixels.
     # true if the page scrolled at least one pixel in the given direction, false if it did not scroll.
     # @see Wx::RBN::RibbonPage#get_major_axis 
@@ -94,6 +103,7 @@ module Wx::RBN
     def scroll_lines(lines) end
     
     # Scroll the page by a set number of pixels up / down / left / right.
+    # 
     # When the page's children are too big to fit in the onscreen area given to the page, scroll buttons will appear, and the page can be programmatically scrolled. Positive values of lines will scroll right or down, while negative values will scroll up or left (depending on the direction in which panels are stacked).
     # true if the page scrolled at least one pixel in the given direction, false if it did not scroll.
     # @see Wx::RBN::RibbonPage#get_major_axis 
@@ -106,6 +116,7 @@ module Wx::RBN
     def scroll_pixels(pixels) end
     
     # Scroll the page by an entire child section.
+    # 
     # The sections parameter value should be 1 or -1. This will scroll enough to uncover a partially visible child section or totally uncover the next child section that may not be visible at all.
     # true if the page scrolled at least one pixel in the given direction, false if it did not scroll.
     # @see Wx::RBN::RibbonPage#scroll_pixels 
@@ -116,6 +127,7 @@ module Wx::RBN
     def scroll_sections(sections) end
     
     # Get the direction in which ribbon panels are stacked within the page.
+    # 
     # This is controlled by the style of the containing {Wx::RBN::RibbonBar}, meaning that all pages within a bar will have the same major axis. As well as being the direction in which panels are stacked, it is also the axis in which scrolling will occur (when required).
     # {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::VERTICAL} (never {Wx::Orientation::BOTH}).
     # @return [Wx::Orientation]

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

@@ -81,6 +81,7 @@ module Wx::RBN
   EVT_RIBBONPANEL_EXTBUTTON_ACTIVATED = 10436
   
   # Serves as a container for a group of (ribbon) controls.
+  # 
   # A {Wx::RBN::RibbonPage} will typically have panels for children, with the controls for that page placed on the panels.
   # A panel adds a border and label to a group of controls, and can be minimised (either automatically to conserve space, or manually by the user).
   # Non ribbon controls can be placed on a panel using {Wx::Sizers} to manage layout. Panel size is governed by the sizer's minimum calculated size and the parent {Wx::RBN::RibbonPage}'s dimensions. For functional and aesthetic reasons it is recommended that ribbon and non ribbon controls are not mixed in one panel.
@@ -117,6 +118,7 @@ module Wx::RBN
   
     # @overload initialize()
     #   Default constructor.
+    #   
     #   With this constructor, {Wx::RBN::RibbonPanel#create} should be called in order to create the ribbon panel.
     #   @return [Wx::RBN::RibbonPanel]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, label=(''), minimised_icon=Wx::NULL_BITMAP, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::RBN::RibbonPanelOption::RIBBON_PANEL_DEFAULT_STYLE)
@@ -132,6 +134,7 @@ module Wx::RBN
     def initialize(*args) end
     
     # Create a ribbon panel in two-step ribbon panel construction.
+    # 
     # Should only be called when the default constructor is used, and arguments have the same meaning as in the full constructor.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -148,6 +151,7 @@ module Wx::RBN
     alias_method :minimised_icon, :get_minimised_icon
     
     # Test if the panel has an extension button.
+    # 
     # Such button is shown in the top right corner of the panel if {Wx::RBN::RibbonPanelOption::RIBBON_PANEL_EXT_BUTTON} style is used for it.
     # 
     # true if the panel and its {Wx::RBN::RibbonBar} allow it in their styles.
@@ -166,12 +170,14 @@ module Wx::RBN
     alias_method :minimised?, :is_minimised
     
     # Query is the mouse is currently hovered over the panel.
+    # 
     # true if the cursor is within the bounds of the panel (i.e. hovered over the panel or one of its children), false otherwise.
     # @return [Boolean]
     def is_hovered; end
     alias_method :hovered?, :is_hovered
     
     # Query if the mouse is currently hovered over the extension button.
+    # 
     # Extension button is only shown for panels with {Wx::RBN::RibbonPanelOption::RIBBON_PANEL_EXT_BUTTON} style.
     # @return [Boolean]
     def is_ext_button_hovered; end
@@ -183,6 +189,7 @@ module Wx::RBN
     alias_method :can_auto_minimise?, :can_auto_minimise
     
     # Show the panel externally expanded.
+    # 
     # When a panel is minimised, it can be shown full-size in a pop-out window, which is referred to as being (externally) expanded. Note that when a panel is expanded, there exist two panels - the original panel (which is referred to as the dummy panel) and the expanded panel. The original is termed a dummy as it sits in the ribbon bar doing nothing, while the expanded panel holds the panel children.
     # true if the panel was expanded, false if it was not (possibly due to it not being minimised, or already being expanded).
     # @see Wx::RBN::RibbonPanel#hide_expanded 
@@ -192,6 +199,7 @@ module Wx::RBN
     def show_expanded; end
     
     # Hide the panel's external expansion.
+    # 
     # true if the panel was un-expanded, false if it was not (normally due to it not being expanded in the first place).
     # @see Wx::RBN::RibbonPanel#hide_expanded 
     # 
@@ -200,6 +208,7 @@ module Wx::RBN
     def hide_expanded; end
     
     # Set the art provider to be used.
+    # 
     # Normally called automatically by {Wx::RBN::RibbonPage} when the panel is created, or the art provider changed on the page.
     # The new art provider will be propagated to the children of the panel.
     # @param art [Wx::RBN::RibbonArtProvider] 
@@ -212,6 +221,7 @@ module Wx::RBN
     def realize; end
     
     # Get the dummy panel of an expanded panel.
+    # 
     # Note that this should be called on an expanded panel to get the dummy associated with it - it will return NULL when called on the dummy itself.
     # @see Wx::RBN::RibbonPanel#show_expanded 
     # 
@@ -221,6 +231,7 @@ module Wx::RBN
     alias_method :expanded_dummy, :get_expanded_dummy
     
     # Get the expanded panel of a dummy panel.
+    # 
     # Note that this should be called on a dummy panel to get the expanded panel associated with it - it will return NULL when called on the expanded panel itself.
     # @see Wx::RBN::RibbonPanel#show_expanded 
     # 

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

@@ -7,6 +7,7 @@
 module Wx::RBN
 
   # Event used to indicate various actions relating to a {Wx::RBN::RibbonPanel}.
+  # 
   # See {Wx::RBN::RibbonPanel} for available event types.
   # 
   # Category:  {Wx::Events}, Ribbon User Interface
@@ -17,7 +18,7 @@ module Wx::RBN
   class RibbonPanelEvent < CommandEvent
   
     # Constructor.
-    # @param command_type [Wx::Slider::EventType] 
+    # @param command_type [Wx::StaticLine::EventType] 
     # @param win_id [Integer] 
     # @param panel [Wx::RBN::RibbonPanel] 
     # @return [Wx::RBN::RibbonPanelEvent]