wxruby3 0.9.2-x64-mingw-ucrt → 0.9.4-x64-mingw-ucrt

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

@@ -660,6 +660,7 @@ module Wx::RBN
   EVT_RIBBONBAR_HELP_CLICK = 10450
   
   # {Wx::RBN::RibbonArtProvider} is responsible for drawing all the components of the ribbon interface.
+  # 
   # This allows a ribbon bar to have a pluggable look-and-feel, while retaining the same underlying behaviour. As a single art provider is used for all ribbon components, a ribbon bar usually has a consistent (though unique) appearance.
   # By default, a {Wx::RBN::RibbonBar} uses an instance of this class called {Wx::RBN::RibbonDefaultArtProvider}, which resolves to {Wx::RBN::RibbonAUIArtProvider}, {Wx::RBN::RibbonMSWArtProvider}, or {Wx::RibbonOSXArtProvider} - whichever is most appropriate to the current platform. These art providers are all slightly configurable with regard to colours and fonts, but for larger modifications, you can derive from one of these classes, or write a completely new art provider class. Call {Wx::RBN::RibbonBar#set_art_provider} to change the art provider being used.
   # 
@@ -679,6 +680,7 @@ module Wx::RBN
     def clone; end
     
     # Set the style flags.
+    # 
     # Normally called automatically by {Wx::RBN::RibbonBar#set_art_provider} with the ribbon bar's style flags, so that the art provider has the same flags as the bar which it is serving.
     # @param flags [Integer] 
     # @return [void]
@@ -691,6 +693,7 @@ module Wx::RBN
     alias_method :flags, :get_flags
     
     # Get the value of a certain integer setting.
+    # 
     # id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
     # @param id [Integer] 
     # @return [Integer]
@@ -698,6 +701,7 @@ module Wx::RBN
     alias_method :metric, :get_metric
     
     # Set the value of a certain integer setting to the value new_val.
+    # 
     # id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
     # @param id [Integer] 
     # @param new_val [Integer] 
@@ -705,6 +709,7 @@ module Wx::RBN
     def set_metric(id, new_val) end
     
     # Set the value of a certain font setting to the value font.
+    # 
     # id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
     # @param id [Integer] 
     # @param font [Wx::Font,Wx::FontInfo] 
@@ -712,6 +717,7 @@ module Wx::RBN
     def set_font(id, font) end
     
     # Get the value of a certain font setting.
+    # 
     # id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
     # @param id [Integer] 
     # @return [Wx::Font]
@@ -719,6 +725,7 @@ module Wx::RBN
     alias_method :font, :get_font
     
     # Get the value of a certain colour setting.
+    # 
     # id can be one of the colour values of {Wx::RBN::RibbonArtSetting}.
     # @param id [Integer] 
     # @return [Wx::Colour]
@@ -726,6 +733,7 @@ module Wx::RBN
     alias_method :colour, :get_colour
     
     # Set the value of a certain colour setting to the value colour.
+    # 
     # id can be one of the colour values of {Wx::RBN::RibbonArtSetting}, though not all colour settings will have an effect on every art provider.
     # @see Wx::RBN::RibbonArtProvider#set_colour_scheme 
     # @param id [Integer] 
@@ -733,6 +741,7 @@ module Wx::RBN
     # @return [void]
     def set_colour(id, colour) end
     
+    # 
     # 
     # 
     # @see Wx::RBN::RibbonArtProvider#get_colour 
@@ -741,6 +750,7 @@ module Wx::RBN
     def get_color(id) end
     alias_method :color, :get_color
     
+    # 
     # 
     # 
     # @see Wx::RBN::RibbonArtProvider#set_colour 
@@ -750,6 +760,7 @@ module Wx::RBN
     def set_color(id, color) end
     
     # Get the current colour scheme.
+    # 
     # Returns three colours such that if {Wx::RBN::RibbonArtProvider#set_colour_scheme} were called with them, the colour scheme would be restored to what it was when {Wx::RBN::RibbonArtProvider#set_colour_scheme} was last called. In practice, this usually means that the returned values are the three colours given in the last call to {Wx::RBN::RibbonArtProvider#set_colour_scheme}, however if {Wx::RBN::RibbonArtProvider#set_colour_scheme} performs an idempotent operation upon the colours it is given (like clamping a component of the colour), then the returned values may not be the three colours given in the last call to {Wx::RBN::RibbonArtProvider#set_colour_scheme}. If {Wx::RBN::RibbonArtProvider#set_colour_scheme} has not been called, then the returned values should result in a colour scheme similar to, if not identical to, the default colours of the art provider. Note that if {Wx::RBN::RibbonArtProvider#set_colour} is called, then {Wx::RBN::RibbonArtProvider#get_colour_scheme} does not try and return a colour scheme similar to colours being used - it's return values are dependent upon the last values given to {Wx::RBN::RibbonArtProvider#set_colour_scheme}, as described above.
     # @param primary [Wx::Colour]  Pointer to a location to store the primary colour, or NULL.
     # @param secondary [Wx::Colour]  Pointer to a location to store the secondary colour, or NULL.
@@ -759,6 +770,7 @@ module Wx::RBN
     alias_method :colour_scheme, :get_colour_scheme
     
     # Set all applicable colour settings from a few base colours.
+    # 
     # Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.
     # @see Wx::RBN::RibbonArtProvider#set_colour 
     # 
@@ -793,6 +805,7 @@ module Wx::RBN
     
     # Draw the background of a ribbon page.
     # 
+    # 
     # @see Wx::RBN::RibbonArtProvider#get_page_background_redraw_area 
     # @param dc [Wx::DC]  The device context to draw onto.
     # @param wnd [Wx::Window]  The window which is being drawn onto (which is commonly the {Wx::RBN::RibbonPage} whose background is being drawn, but doesn't have to be).
@@ -809,6 +822,7 @@ module Wx::RBN
     def draw_scroll_button(dc, wnd, rect, style) end
     
     # Draw the background and chrome for a ribbon panel.
+    # 
     # This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel.
     # Note that when a panel is minimised, this function is not called - only {Wx::RBN::RibbonArtProvider#draw_minimised_panel} is called, so a background should be explicitly painted by that if required.
     # @param dc [Wx::DC]  The device context to draw onto.
@@ -818,6 +832,7 @@ module Wx::RBN
     def draw_panel_background(dc, wnd, rect) end
     
     # Draw the background and chrome for a {Wx::RBN::RibbonGallery} control.
+    # 
     # This should draw the border, background, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item.
     # @param dc [Wx::DC]  The device context to draw onto.
     # @param wnd [Wx::RBN::RibbonGallery]  The window which is being drawn onto, which is always the gallery whose background and chrome is being drawn. Attributes used during drawing like the gallery hover state and individual button states can be queried from this parameter by {Wx::RBN::RibbonGallery#is_hovered}, {Wx::RBN::RibbonGallery#get_extension_button_state}, {Wx::RBN::RibbonGallery#get_up_button_state}, and {Wx::RBN::RibbonGallery#get_down_button_state}.
@@ -826,6 +841,7 @@ module Wx::RBN
     def draw_gallery_background(dc, wnd, rect) end
     
     # Draw the background of a single item in a {Wx::RBN::RibbonGallery} control.
+    # 
     # This is painted on top of a gallery background, and behind the items bitmap. Unlike {Wx::RBN::RibbonArtProvider#draw_button_bar_button} and {Wx::RBN::RibbonArtProvider#draw_tool}, it is not expected to draw the item bitmap - that is done by the gallery control itself.
     # @param dc [Wx::DC]  The device context to draw onto.
     # @param wnd [Wx::RBN::RibbonGallery]  The window which is being drawn onto, which is always the gallery which contains the item being drawn.
@@ -886,6 +902,7 @@ module Wx::RBN
     def draw_tool(dc, wnd, rect, bitmap, kind, state) end
     
     # Draw toggle button on {Wx::RBN::RibbonBar}.
+    # 
     # This should draw a small toggle button at top right corner of ribbon bar.
     # @param dc [Wx::DC]  The device context to draw onto.
     # @param wnd [Wx::RBN::RibbonBar]  The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
@@ -895,6 +912,7 @@ module Wx::RBN
     def draw_toggle_button(dc, wnd, rect, mode) end
     
     # Draw help button on {Wx::RBN::RibbonBar}.
+    # 
     # This should draw a help button at top right corner of ribbon bar.
     # @param dc [Wx::DC]  The device context to draw onto.
     # @param wnd [Wx::RBN::RibbonBar]  The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
@@ -912,6 +930,7 @@ module Wx::RBN
     alias_method :bar_tab_width, :get_bar_tab_width
     
     # Calculate the height (in pixels) of the tab region of a ribbon bar.
+    # 
     # Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button.
     # @param dc [Wx::DC]  A device context to use when one is required for size calculations.
     # @param wnd [Wx::Window]  The window onto which the tabs will eventually be drawn.
@@ -929,6 +948,7 @@ module Wx::RBN
     alias_method :scroll_button_minimum_size, :get_scroll_button_minimum_size
     
     # Calculate the size of a panel for a given client size.
+    # 
     # This should increment the given size by enough to fit the panel label and other chrome.
     # @see Wx::RBN::RibbonArtProvider#get_panel_client_size 
     # @param dc [Wx::DC]  A device context to use if one is required for size calculations.
@@ -940,6 +960,7 @@ module Wx::RBN
     alias_method :panel_size, :get_panel_size
     
     # Calculate the client size of a panel for a given overall size.
+    # 
     # This should act as the inverse to {Wx::RBN::RibbonArtProvider#get_panel_size}, and decrement the given size by enough to fit the panel label and other chrome.
     # @see Wx::RBN::RibbonArtProvider#get_panel_size 
     # @param dc [Wx::DC]  A device context to use if one is required for size calculations.
@@ -959,6 +980,7 @@ module Wx::RBN
     alias_method :panel_ext_button_area, :get_panel_ext_button_area
     
     # Calculate the size of a {Wx::RBN::RibbonGallery} control for a given client size.
+    # 
     # This should increment the given size by enough to fit the gallery border, buttons, and any other chrome.
     # @see Wx::RBN::RibbonArtProvider#get_gallery_client_size 
     # @param dc [Wx::DC]  A device context to use if one is required for size calculations.
@@ -969,6 +991,7 @@ module Wx::RBN
     alias_method :gallery_size, :get_gallery_size
     
     # Calculate the client size of a {Wx::RBN::RibbonGallery} control for a given size.
+    # 
     # This should act as the inverse to {Wx::RBN::RibbonArtProvider#get_gallery_size}, and decrement the given size by enough to fit the gallery border, buttons, and other chrome.
     # @param dc [Wx::DC]  A device context to use if one is required for size calculations.
     # @param wnd [Wx::RBN::RibbonGallery]  The gallery in question.
@@ -982,6 +1005,7 @@ module Wx::RBN
     alias_method :gallery_client_size, :get_gallery_client_size
     
     # Calculate the portion of a page background which needs to be redrawn when a page is resized.
+    # 
     # To optimise the drawing of page backgrounds, as small an area as possible should be returned. Of course, if the way in which a background is drawn means that the entire background needs to be repainted on resize, then the entire new size should be returned.
     # @param dc [Wx::DC]  A device context to use when one is required for size calculations.
     # @param wnd [Wx::RBN::RibbonPage]  The page which is being resized.
@@ -992,6 +1016,7 @@ module Wx::RBN
     alias_method :page_background_redraw_area, :get_page_background_redraw_area
     
     # Calculate the size of a button within a {Wx::RBN::RibbonButtonBar}.
+    # 
     # true if a size exists for the button, false otherwise.
     # @param dc [Wx::DC]  A device context to use when one is required for size calculations.
     # @param wnd [Wx::Window]  The window onto which the button will eventually be drawn (which is normally a {Wx::RBN::RibbonButtonBar}, though this is not guaranteed).
@@ -1009,6 +1034,7 @@ module Wx::RBN
     alias_method :button_bar_button_size, :get_button_bar_button_size
     
     # Gets the width of the string if it is used as a {Wx::RBN::RibbonButtonBar} button label.
+    # 
     # Width of the given label text in pixel.
     # 
     # <div class="wxrb-note">
@@ -1062,6 +1088,7 @@ module Wx::RBN
   # 
   # 
   # 
+  # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   # @wxrb_require USE_RIBBON
   class RibbonPageTabInfo < ::Object
@@ -1072,6 +1099,7 @@ module Wx::RBN
   # 
   # 
   # 
+  # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   # @wxrb_require USE_RIBBON
   class RibbonMSWArtProvider < RibbonArtProvider
@@ -1085,6 +1113,7 @@ module Wx::RBN
     def clone; end
     
     # Set the style flags.
+    # 
     # Normally called automatically by {Wx::RBN::RibbonBar#set_art_provider} with the ribbon bar's style flags, so that the art provider has the same flags as the bar which it is serving.
     # @param flags [Integer] 
     # @return [void]
@@ -1097,6 +1126,7 @@ module Wx::RBN
     alias_method :flags, :get_flags
     
     # Get the value of a certain integer setting.
+    # 
     # id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
     # @param id [Integer] 
     # @return [Integer]
@@ -1104,6 +1134,7 @@ module Wx::RBN
     alias_method :metric, :get_metric
     
     # Set the value of a certain integer setting to the value new_val.
+    # 
     # id can be one of the size values of {Wx::RBN::RibbonArtSetting}.
     # @param id [Integer] 
     # @param new_val [Integer] 
@@ -1111,6 +1142,7 @@ module Wx::RBN
     def set_metric(id, new_val) end
     
     # Set the value of a certain font setting to the value font.
+    # 
     # id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
     # @param id [Integer] 
     # @param font [Wx::Font,Wx::FontInfo] 
@@ -1118,6 +1150,7 @@ module Wx::RBN
     def set_font(id, font) end
     
     # Get the value of a certain font setting.
+    # 
     # id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
     # @param id [Integer] 
     # @return [Wx::Font]
@@ -1125,6 +1158,7 @@ module Wx::RBN
     alias_method :font, :get_font
     
     # Get the value of a certain colour setting.
+    # 
     # id can be one of the colour values of {Wx::RBN::RibbonArtSetting}.
     # @param id [Integer] 
     # @return [Wx::Colour]
@@ -1132,6 +1166,7 @@ module Wx::RBN
     alias_method :colour, :get_colour
     
     # Set the value of a certain colour setting to the value colour.
+    # 
     # id can be one of the colour values of {Wx::RBN::RibbonArtSetting}, though not all colour settings will have an effect on every art provider.
     # @see Wx::RBN::RibbonMSWArtProvider#set_colour_scheme 
     # @param id [Integer] 
@@ -1140,6 +1175,7 @@ module Wx::RBN
     def set_colour(id, colour) end
     
     # Get the current colour scheme.
+    # 
     # Returns three colours such that if {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} were called with them, the colour scheme would be restored to what it was when {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} was last called. In practice, this usually means that the returned values are the three colours given in the last call to {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme}, however if {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} performs an idempotent operation upon the colours it is given (like clamping a component of the colour), then the returned values may not be the three colours given in the last call to {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme}. If {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme} has not been called, then the returned values should result in a colour scheme similar to, if not identical to, the default colours of the art provider. Note that if {Wx::RBN::RibbonMSWArtProvider#set_colour} is called, then {Wx::RBN::RibbonMSWArtProvider#get_colour_scheme} does not try and return a colour scheme similar to colours being used - it's return values are dependent upon the last values given to {Wx::RBN::RibbonMSWArtProvider#set_colour_scheme}, as described above.
     # @param primary [Wx::Colour]  Pointer to a location to store the primary colour, or NULL.
     # @param secondary [Wx::Colour]  Pointer to a location to store the secondary colour, or NULL.
@@ -1149,6 +1185,7 @@ module Wx::RBN
     alias_method :colour_scheme, :get_colour_scheme
     
     # Set all applicable colour settings from a few base colours.
+    # 
     # Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.
     # @see Wx::RBN::RibbonMSWArtProvider#set_colour 
     # 
@@ -1160,6 +1197,7 @@ module Wx::RBN
     def set_colour_scheme(primary, secondary, tertiary) end
     
     # Calculate the height (in pixels) of the tab region of a ribbon bar.
+    # 
     # Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button.
     # @param dc [Wx::DC]  A device context to use when one is required for size calculations.
     # @param wnd [Wx::Window]  The window onto which the tabs will eventually be drawn.
@@ -1192,6 +1230,7 @@ module Wx::RBN
     
     # Draw the background of a ribbon page.
     # 
+    # 
     # @see Wx::RBN::RibbonMSWArtProvider#get_page_background_redraw_area 
     # @param dc [Wx::DC]  The device context to draw onto.
     # @param wnd [Wx::Window]  The window which is being drawn onto (which is commonly the {Wx::RBN::RibbonPage} whose background is being drawn, but doesn't have to be).
@@ -1208,6 +1247,7 @@ module Wx::RBN
     def draw_scroll_button(dc, wnd, rect, style) end
     
     # Draw the background and chrome for a ribbon panel.
+    # 
     # This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel.
     # Note that when a panel is minimised, this function is not called - only {Wx::RBN::RibbonMSWArtProvider#draw_minimised_panel} is called, so a background should be explicitly painted by that if required.
     # @param dc [Wx::DC]  The device context to draw onto.
@@ -1217,6 +1257,7 @@ module Wx::RBN
     def draw_panel_background(dc, wnd, rect) end
     
     # Draw the background and chrome for a {Wx::RBN::RibbonGallery} control.
+    # 
     # This should draw the border, background, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item.
     # @param dc [Wx::DC]  The device context to draw onto.
     # @param wnd [Wx::RBN::RibbonGallery]  The window which is being drawn onto, which is always the gallery whose background and chrome is being drawn. Attributes used during drawing like the gallery hover state and individual button states can be queried from this parameter by {Wx::RBN::RibbonGallery#is_hovered}, {Wx::RBN::RibbonGallery#get_extension_button_state}, {Wx::RBN::RibbonGallery#get_up_button_state}, and {Wx::RBN::RibbonGallery#get_down_button_state}.
@@ -1225,6 +1266,7 @@ module Wx::RBN
     def draw_gallery_background(dc, wnd, rect) end
     
     # Draw the background of a single item in a {Wx::RBN::RibbonGallery} control.
+    # 
     # This is painted on top of a gallery background, and behind the items bitmap. Unlike {Wx::RBN::RibbonMSWArtProvider#draw_button_bar_button} and {Wx::RBN::RibbonMSWArtProvider#draw_tool}, it is not expected to draw the item bitmap - that is done by the gallery control itself.
     # @param dc [Wx::DC]  The device context to draw onto.
     # @param wnd [Wx::RBN::RibbonGallery]  The window which is being drawn onto, which is always the gallery which contains the item being drawn.
@@ -1285,6 +1327,7 @@ module Wx::RBN
     def draw_tool(dc, wnd, rect, bitmap, kind, state) end
     
     # Draw toggle button on {Wx::RBN::RibbonBar}.
+    # 
     # This should draw a small toggle button at top right corner of ribbon bar.
     # @param dc [Wx::DC]  The device context to draw onto.
     # @param wnd [Wx::RBN::RibbonBar]  The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
@@ -1294,6 +1337,7 @@ module Wx::RBN
     def draw_toggle_button(dc, wnd, rect, mode) end
     
     # Draw help button on {Wx::RBN::RibbonBar}.
+    # 
     # This should draw a help button at top right corner of ribbon bar.
     # @param dc [Wx::DC]  The device context to draw onto.
     # @param wnd [Wx::RBN::RibbonBar]  The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.
@@ -1319,6 +1363,7 @@ module Wx::RBN
     alias_method :scroll_button_minimum_size, :get_scroll_button_minimum_size
     
     # Calculate the size of a panel for a given client size.
+    # 
     # This should increment the given size by enough to fit the panel label and other chrome.
     # @see Wx::RBN::RibbonMSWArtProvider#get_panel_client_size 
     # @param dc [Wx::DC]  A device context to use if one is required for size calculations.
@@ -1330,6 +1375,7 @@ module Wx::RBN
     alias_method :panel_size, :get_panel_size
     
     # Calculate the client size of a panel for a given overall size.
+    # 
     # This should act as the inverse to {Wx::RBN::RibbonMSWArtProvider#get_panel_size}, and decrement the given size by enough to fit the panel label and other chrome.
     # @see Wx::RBN::RibbonMSWArtProvider#get_panel_size 
     # @param dc [Wx::DC]  A device context to use if one is required for size calculations.
@@ -1349,6 +1395,7 @@ module Wx::RBN
     alias_method :panel_ext_button_area, :get_panel_ext_button_area
     
     # Calculate the size of a {Wx::RBN::RibbonGallery} control for a given client size.
+    # 
     # This should increment the given size by enough to fit the gallery border, buttons, and any other chrome.
     # @see Wx::RBN::RibbonMSWArtProvider#get_gallery_client_size 
     # @param dc [Wx::DC]  A device context to use if one is required for size calculations.
@@ -1359,6 +1406,7 @@ module Wx::RBN
     alias_method :gallery_size, :get_gallery_size
     
     # Calculate the client size of a {Wx::RBN::RibbonGallery} control for a given size.
+    # 
     # This should act as the inverse to {Wx::RBN::RibbonMSWArtProvider#get_gallery_size}, and decrement the given size by enough to fit the gallery border, buttons, and other chrome.
     # @param dc [Wx::DC]  A device context to use if one is required for size calculations.
     # @param wnd [Wx::RBN::RibbonGallery]  The gallery in question.
@@ -1372,6 +1420,7 @@ module Wx::RBN
     alias_method :gallery_client_size, :get_gallery_client_size
     
     # Calculate the portion of a page background which needs to be redrawn when a page is resized.
+    # 
     # To optimise the drawing of page backgrounds, as small an area as possible should be returned. Of course, if the way in which a background is drawn means that the entire background needs to be repainted on resize, then the entire new size should be returned.
     # @param dc [Wx::DC]  A device context to use when one is required for size calculations.
     # @param wnd [Wx::RBN::RibbonPage]  The page which is being resized.
@@ -1382,6 +1431,7 @@ module Wx::RBN
     alias_method :page_background_redraw_area, :get_page_background_redraw_area
     
     # Calculate the size of a button within a {Wx::RBN::RibbonButtonBar}.
+    # 
     # true if a size exists for the button, false otherwise.
     # @param dc [Wx::DC]  A device context to use when one is required for size calculations.
     # @param wnd [Wx::Window]  The window onto which the button will eventually be drawn (which is normally a {Wx::RBN::RibbonButtonBar}, though this is not guaranteed).
@@ -1399,6 +1449,7 @@ module Wx::RBN
     alias_method :button_bar_button_size, :get_button_bar_button_size
     
     # Gets the width of the string if it is used as a {Wx::RBN::RibbonButtonBar} button label.
+    # 
     # Width of the given label text in pixel.
     # 
     # <div class="wxrb-note">
@@ -1452,6 +1503,7 @@ module Wx::RBN
   # 
   # 
   # 
+  # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   # @wxrb_require USE_RIBBON
   class RibbonAUIArtProvider < RibbonMSWArtProvider
@@ -1464,6 +1516,7 @@ module Wx::RBN
     def clone; end
     
     # Get the value of a certain colour setting.
+    # 
     # id can be one of the colour values of {Wx::RBN::RibbonArtSetting}.
     # @param id [Integer] 
     # @return [Wx::Colour]
@@ -1471,6 +1524,7 @@ module Wx::RBN
     alias_method :colour, :get_colour
     
     # Set the value of a certain colour setting to the value colour.
+    # 
     # id can be one of the colour values of {Wx::RBN::RibbonArtSetting}, though not all colour settings will have an effect on every art provider.
     # @see Wx::RBN::RibbonAUIArtProvider#set_colour_scheme 
     # @param id [Integer] 
@@ -1479,6 +1533,7 @@ module Wx::RBN
     def set_colour(id, colour) end
     
     # Set all applicable colour settings from a few base colours.
+    # 
     # Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.
     # @see Wx::RBN::RibbonAUIArtProvider#set_colour 
     # 
@@ -1490,6 +1545,7 @@ module Wx::RBN
     def set_colour_scheme(primary, secondary, tertiary) end
     
     # Set the value of a certain font setting to the value font.
+    # 
     # id can be one of the font values of {Wx::RBN::RibbonArtSetting}.
     # @param id [Integer] 
     # @param font [Wx::Font,Wx::FontInfo] 
@@ -1513,6 +1569,7 @@ module Wx::RBN
     def draw_scroll_button(dc, wnd, rect, style) end
     
     # Calculate the size of a panel for a given client size.
+    # 
     # This should increment the given size by enough to fit the panel label and other chrome.
     # @see Wx::RBN::RibbonAUIArtProvider#get_panel_client_size 
     # @param dc [Wx::DC]  A device context to use if one is required for size calculations.
@@ -1524,6 +1581,7 @@ module Wx::RBN
     alias_method :panel_size, :get_panel_size
     
     # Calculate the client size of a panel for a given overall size.
+    # 
     # This should act as the inverse to {Wx::RBN::RibbonAUIArtProvider#get_panel_size}, and decrement the given size by enough to fit the panel label and other chrome.
     # @see Wx::RBN::RibbonAUIArtProvider#get_panel_size 
     # @param dc [Wx::DC]  A device context to use if one is required for size calculations.
@@ -1550,6 +1608,7 @@ module Wx::RBN
     def draw_tab_ctrl_background(dc, wnd, rect) end
     
     # Calculate the height (in pixels) of the tab region of a ribbon bar.
+    # 
     # Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button.
     # @param dc [Wx::DC]  A device context to use when one is required for size calculations.
     # @param wnd [Wx::Window]  The window onto which the tabs will eventually be drawn.
@@ -1584,6 +1643,7 @@ module Wx::RBN
     
     # Draw the background of a ribbon page.
     # 
+    # 
     # @see Wx::GetPageBackgroundRedrawArea 
     # @param dc [Wx::DC]  The device context to draw onto.
     # @param wnd [Wx::Window]  The window which is being drawn onto (which is commonly the {Wx::RBN::RibbonPage} whose background is being drawn, but doesn't have to be).
@@ -1592,6 +1652,7 @@ module Wx::RBN
     def draw_page_background(dc, wnd, rect) end
     
     # Draw the background and chrome for a ribbon panel.
+    # 
     # This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel.
     # Note that when a panel is minimised, this function is not called - only {Wx::RBN::RibbonAUIArtProvider#draw_minimised_panel} is called, so a background should be explicitly painted by that if required.
     # @param dc [Wx::DC]  The device context to draw onto.
@@ -1609,6 +1670,7 @@ module Wx::RBN
     def draw_minimised_panel(dc, wnd, rect, bitmap) end
     
     # Draw the background and chrome for a {Wx::RBN::RibbonGallery} control.
+    # 
     # This should draw the border, background, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item.
     # @param dc [Wx::DC]  The device context to draw onto.
     # @param wnd [Wx::RBN::RibbonGallery]  The window which is being drawn onto, which is always the gallery whose background and chrome is being drawn. Attributes used during drawing like the gallery hover state and individual button states can be queried from this parameter by {Wx::RBN::RibbonGallery#is_hovered}, {Wx::RBN::RibbonGallery#get_extension_button_state}, {Wx::RBN::RibbonGallery#get_up_button_state}, and {Wx::RBN::RibbonGallery#get_down_button_state}.
@@ -1617,6 +1679,7 @@ module Wx::RBN
     def draw_gallery_background(dc, wnd, rect) end
     
     # Draw the background of a single item in a {Wx::RBN::RibbonGallery} control.
+    # 
     # This is painted on top of a gallery background, and behind the items bitmap. Unlike {Wx::RBN::RibbonAUIArtProvider#draw_button_bar_button} and {Wx::RBN::RibbonAUIArtProvider#draw_tool}, it is not expected to draw the item bitmap - that is done by the gallery control itself.
     # @param dc [Wx::DC]  The device context to draw onto.
     # @param wnd [Wx::RBN::RibbonGallery]  The window which is being drawn onto, which is always the gallery which contains the item being drawn.

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

@@ -7,6 +7,7 @@
 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.
@@ -69,6 +70,7 @@ module Wx::RBN
   
     # @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)
@@ -82,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] 
@@ -92,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] 
@@ -100,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] 
@@ -109,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]
@@ -121,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]
@@ -139,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]
@@ -151,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]
@@ -161,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]
@@ -168,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] 
@@ -175,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]
@@ -182,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]
@@ -189,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] 
@@ -197,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]
@@ -208,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] 
@@ -215,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,6 +7,7 @@
 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
@@ -17,7 +18,7 @@ module Wx::RBN
   class RibbonBarEvent < NotifyEvent
   
     # Constructor.
-    # @param command_type [Wx::Slider::EventType] 
+    # @param command_type [Wx::Notebook::EventType] 
     # @param win_id [Integer] 
     # @param page [Wx::RBN::RibbonPage] 
     # @return [Wx::RBN::RibbonBarEvent]