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

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

@@ -7,10 +7,16 @@
 module Wx
 
   # A combobox that displays bitmap in front of the list items.
+  # 
   # It currently only allows using bitmaps of one size, and resizes itself so that a bitmap can be shown next to the text field.
-  # While {Wx::BitmapComboBox} contains the {Wx::ComboBox} API, but it might not actually be derived from that class. In fact, if the platform does not have a native implementation, {Wx::BitmapComboBox} will inherit from {Wx::OwnerDrawnComboBox}. You can determine if the implementation is generic by checking whether {Wx::GENERIC_BITMAPCOMBOBOX} is defined. Currently {Wx::BitmapComboBox} is implemented natively for MSW and GTK+.
   # 
-  # === Styles
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>While {Wx::BitmapComboBox} contains the {Wx::ComboBox} API, but it might not actually be derived from that class. In fact, if the platform does not have a native implementation, {Wx::BitmapComboBox} will inherit from {Wx::OwnerDrawnComboBox}. You can determine if the implementation is generic by checking whether {Wx::GENERIC_BITMAPCOMBOBOX} is defined. Currently {Wx::BitmapComboBox} is implemented natively for MSW and GTK+.
+  # </p>
+  # </div>
+  # 
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -22,7 +28,7 @@ module Wx
   # 
   # Todocreate {Wx::CB_PROCESS_ENTER} rather than reusing {Wx::TE_PROCESS_ENTER}!
   # 
-  # === 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::CommandEvent} events.
   # Event handler methods for events emitted by this class:
@@ -33,11 +39,9 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_text_enter}(id, meth = nil, &block): Process a {Wx::EVT_TEXT_ENTER} event, when RETURN is pressed in the combobox. 
   # 
-  # === 
-  # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
   #   </td></tr></table></div>
   # @see Wx::ComboBox
   # @see  Wx::Choice
@@ -45,6 +49,7 @@ module Wx
   # @see  Wx::CommandEvent 
   # 
   # 
+  # @wxrb_require USE_BITMAPCOMBOBOX
   class BitmapComboBox < ComboBox
   
     # @overload initialize()
@@ -53,6 +58,7 @@ module Wx
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BITMAP_COMBO_BOX_NAME_STR)
     #   Constructor, creating and showing a combobox.
     #   
+    #   
     #   @see Wx::BitmapComboBox#create
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -68,6 +74,7 @@ module Wx
     # @overload initialize(parent, id, value, pos, size, choices, style, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BITMAP_COMBO_BOX_NAME_STR)
     #   Constructor, creating and showing a combobox.
     #   
+    #   
     #   @see Wx::BitmapComboBox#create
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -88,7 +95,7 @@ module Wx
     #   @param bitmap [Wx::Bitmap] 
     #   @return [Integer]
     # @overload append(item, bitmap, clientData)
-    #   Adds the item to the end of the combo box, associating the given untyped, client data pointer clientData with the item.
+    #   Adds the item to the end of the combo box, associating the given typed client data pointer clientData with the item.
     #   @param item [String] 
     #   @param bitmap [Wx::Bitmap] 
     #   @param clientData [Object] 
@@ -122,6 +129,7 @@ module Wx
     def create(*args) end
     
     # Returns the size of the bitmaps used in the combo box.
+    # 
     # If the combo box is empty, then {Wx::DEFAULT_SIZE} is returned.
     # @return [Wx::Size]
     def get_bitmap_size; end
@@ -135,13 +143,15 @@ module Wx
     
     # @overload insert(item, bitmap, pos)
     #   Inserts the item into the list before pos.
+    #   
     #   Not valid for {Wx::CB_SORT} style, use {Wx::BitmapComboBox#append} instead.
     #   @param item [String] 
     #   @param bitmap [Wx::Bitmap] 
     #   @param pos [Integer] 
     #   @return [Integer]
     # @overload insert(item, bitmap, pos, clientData)
-    #   Inserts the item into the list before pos, associating the given untyped, client data pointer with the item.
+    #   Inserts the item into the list before pos, associating the given typed client data pointer with the item.
+    #   
     #   Not valid for {Wx::CB_SORT} style, use {Wx::BitmapComboBox#append} instead.
     #   @param item [String] 
     #   @param bitmap [Wx::Bitmap] 

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

@@ -45,6 +45,7 @@ module Wx
   BK_HITTEST_ONPAGE = 8
   
   # A book control is a convenient way of displaying multiple pages of information, displayed one page at a time.
+  # 
   # wxWidgets has five variants of this control:
   # 
   # - {Wx::Choicebook}: controlled by a {Wx::Choice} 
@@ -58,12 +59,12 @@ module Wx
   # - {Wx::Toolbook}: controlled by a {Wx::ToolBar}
   # 
   # This abstract class is the parent of all these book controls, and provides their basic interface. This is a pure virtual class so you cannot allocate it directly.
-  # === 
   # 
   # Category:  Book Controls
   # @see wxBookCtrl Overview 
   # 
   # 
+  # @wxrb_require USE_AUI|USE_NOTEBOOK|USE_LISTBOOK|USE_CHOICEBOOK|USE_TOOLBOOK|USE_TREEBOOK
   class BookCtrlBase < Control
   
     include Wx::WithImages
@@ -79,6 +80,7 @@ module Wx
     alias_method :page_image, :get_page_image
     
     # Sets the image index for the given page.
+    # 
     # image is an index into the image list which was set with {Wx::BookCtrlBase#set_image_list}.
     # @param page [Integer] 
     # @param image [Integer] 
@@ -98,6 +100,7 @@ module Wx
     def set_page_text(page, text) end
     
     # Returns the currently selected page, or {Wx::NOT_FOUND} if none was selected.
+    # 
     # Note that this method may return either the previously or newly selected page when called from the EVT_BOOKCTRL_PAGE_CHANGED handler depending on the platform and so {Wx::BookCtrlEvent#get_selection} should be used instead in this case.
     # @return [Integer]
     def get_selection; end
@@ -109,6 +112,7 @@ module Wx
     alias_method :current_page, :get_current_page
     
     # Sets the selection to the given page, returning the previous selection.
+    # 
     # Notice that the call to this function generates the page changing events, use the {Wx::BookCtrlBase#change_selection} function if you don't want these events to be generated.
     # @see Wx::BookCtrlBase#get_selection 
     # @param page [Integer] 
@@ -117,12 +121,14 @@ module Wx
     alias_method :selection=, :set_selection
     
     # Cycles through the tabs.
+    # 
     # The call to this function generates the page changing events.
     # @param forward [Boolean] 
     # @return [void]
     def advance_selection(forward=true) end
     
     # Changes the selection to the given page, returning the previous selection.
+    # 
     # This function behaves as {Wx::BookCtrlBase#set_selection} but does not generate the page changing events.
     # See User Generated Events vs Programmatically Generated Events for more information.
     # @param page [Integer] 
@@ -130,18 +136,24 @@ module Wx
     def change_selection(page) end
     
     # Returns the index of the specified tab window or {Wx::NOT_FOUND} if not found.
+    # 
     # The zero-based tab index or {Wx::NOT_FOUND} if not found.
     # @param page [Wx::Window]  One of the control pages.
     # @return [Integer]
     def find_page(page) end
     
     # Adds a new page.
+    # 
     # The page must have the book control itself as the parent and must not have been added to this control previously.
     # The call to this function will generate the page changing and page changed events if select is true, but not when inserting the very first page (as there is no previous page selection to switch from in this case and so it wouldn't make sense to e.g. veto such event).
     # 
     # true if successful, false otherwise.
     # 
-    # Do not delete the page, it will be deleted by the book control.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Do not delete the page, it will be deleted by the book control.
+    # </p>
+    # </div>
     # @see Wx::BookCtrlBase#insert_page 
     # @param page [Wx::Window]  Specifies the new page.
     # @param text [String]  Specifies the text for the new page.
@@ -155,15 +167,21 @@ module Wx
     def delete_all_pages; end
     
     # Deletes the specified page, and the associated window.
+    # 
     # The call to this function generates the page changing events when deleting the currently selected page or a page preceding it in the index order, but it does not send any events when deleting the last page: while in this case the selection also changes, it becomes invalid and for compatibility reasons the control never generates events with the invalid selection index.
     # @param page [Integer] 
     # @return [Boolean]
     def delete_page(page) end
     
     # Inserts a new page at the specified position.
+    # 
     # true if successful, false otherwise.
     # 
-    # Do not delete the page, it will be deleted by the book control.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Do not delete the page, it will be deleted by the book control.
+    # </p>
+    # </div>
     # @see Wx::BookCtrlBase#add_page 
     # @param index [Integer]  Specifies the position for the new page.
     # @param page [Wx::Window]  Specifies the new page.
@@ -174,6 +192,7 @@ module Wx
     def insert_page(index, page, text, select=false, imageId=Wx::Notebook::NO_IMAGE) end
     
     # Deletes the specified page, without deleting the associated window.
+    # 
     # See {Wx::BookCtrlBase#delete_page} for a note about the events generated by this function.
     # @param page [Integer] 
     # @return [Boolean]
@@ -191,6 +210,7 @@ module Wx
     alias_method :page, :get_page
     
     # Returns the sizer containing the control for page selection, if any.
+    # 
     # Some derived classes, e.g. {Wx::Choicebook}, use a separate control for switching the currently selected page and this function returns the sizer used for positioning this control and the pages themselves inside the book control.
     # Note that many classes, notably {Wx::Notebook}, do not use any such control, and this function simply returns NULL for them.
     # Non-owning pointer to the sizer or NULL.
@@ -203,6 +223,7 @@ module Wx
     #   @return [Wx::BookCtrlBase]
     # @overload initialize(parent, winid, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=(''))
     #   Constructs the book control with the given parameters.
+    #   
     #   See {Wx::BookCtrlBase#create} for two-step construction.
     #   @param parent [Wx::Window] 
     #   @param winid [Integer] 
@@ -224,13 +245,19 @@ module Wx
     def create(parent, winid, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=('')) end
     
     # Sets the width and height of the pages.
-    # This method is currently not implemented for wxGTK.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This method is currently not implemented for WXGTK. 
+    # </p>
+    # </div>
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @return [void]
     def set_page_size(size) end
     alias_method :page_size=, :set_page_size
     
     # Returns the index of the tab at the specified position or {Wx::NOT_FOUND} if none.
+    # 
     # If flags parameter is non-NULL, the position of the point inside the tab is returned as well.
     # 
     # Returns the zero-based tab index or {Wx::NOT_FOUND} if there is no tab at the specified position.

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

@@ -7,10 +7,10 @@
 module Wx
 
   # This class represents the events generated by book controls ({Wx::Notebook}, {Wx::Listbook}, {Wx::Choicebook}, {Wx::Treebook}, {Wx::AUI::AuiNotebook}).
+  # 
   # The PAGE_CHANGING events are sent before the current page is changed. It allows the program to examine the current page (which can be retrieved with {Wx::BookCtrlEvent#get_old_selection}) and to veto the page change by calling {Wx::NotifyEvent#veto} if, for example, the current values in the controls of the old page are invalid.
   # The PAGE_CHANGED events are sent after the page has been changed and the program cannot veto it any more, it just informs it about the page change.
   # To summarize, if the program is interested in validating the page values before allowing the user to change it, it should process the PAGE_CHANGING event, otherwise PAGE_CHANGED is probably enough. In any case, it is probably unnecessary to process both events at once.
-  # === 
   # 
   # Category:  {Wx::Events}, Book Controls
   # @see Wx::Notebook
@@ -21,10 +21,11 @@ module Wx
   # @see  Wx::AUI::AuiNotebook 
   # 
   # 
+  # @wxrb_require USE_AUI|USE_NOTEBOOK|USE_LISTBOOK|USE_CHOICEBOOK|USE_TOOLBOOK|USE_TREEBOOK
   class BookCtrlEvent < NotifyEvent
   
     # Constructor (used internally by wxWidgets only).
-    # @param eventType [Wx::CommandLinkButton::EventType] 
+    # @param eventType [Wx::StaticLine::EventType] 
     # @param id [Integer] 
     # @param sel [Integer] 
     # @param oldSel [Integer] 
@@ -37,7 +38,12 @@ module Wx
     alias_method :old_selection, :get_old_selection
     
     # Returns the currently selected page, or {Wx::NOT_FOUND} if none was selected.
-    # under Windows, {Wx::BookCtrlEvent#get_selection} will return the same value as {Wx::BookCtrlEvent#get_old_selection} when called from the EVT_BOOKCTRL_PAGE_CHANGING handler and not the page which is going to be selected.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>under Windows, {Wx::BookCtrlEvent#get_selection} will return the same value as {Wx::BookCtrlEvent#get_old_selection} when called from the EVT_BOOKCTRL_PAGE_CHANGING handler and not the page which is going to be selected. 
+    # </p>
+    # </div>
     # @return [Integer]
     def get_selection; end
     alias_method :selection, :get_selection

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

@@ -7,8 +7,8 @@
 module Wx
 
   # The basic idea behind a box sizer is that windows will most often be laid out in rather simple basic geometry, typically in a row or a column or several hierarchies of either.
+  # 
   # For more information, please see {Wx::BoxSizer}.
-  # === 
   # 
   # Category:  Window Layout
   # @see Wx::Sizer
@@ -18,12 +18,14 @@ module Wx
   class BoxSizer < Sizer
   
     # Constructor for a {Wx::BoxSizer}.
+    # 
     # orient may be either of {Wx::Orientation::VERTICAL} or {Wx::Orientation::HORIZONTAL} for creating either a column sizer or a row sizer.
     # @param orient [Integer] 
     # @return [Wx::BoxSizer]
     def initialize(orient) end
     
     # Adds non-stretchable space to the main orientation of the sizer only.
+    # 
     # More readable way of calling: 
     # ```ruby
     #   if box_sizer.vertical?
@@ -37,6 +39,7 @@ module Wx
     def add_spacer(size) end
     
     # Implements the calculation of a box sizer's minimal.
+    # 
     # It is used internally only and must not be called by the user. Documented for information.
     # @return [Wx::Size]
     def calc_min; end
@@ -53,6 +56,7 @@ module Wx
     alias_method :orientation=, :set_orientation
     
     # Method which must be overridden in the derived sizer classes.
+    # 
     # The implementation should reposition the children using the current total size available to the sizer (m_size) and the size computed by the last call to {Wx::BoxSizer#calc_min}.
     # @param minSize [Array(Integer, Integer), Wx::Size] 
     # @return [void]

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

@@ -75,12 +75,12 @@ module Wx
   NULL_BRUSH = nil
   
   # A brush is a drawing tool for filling in areas.
+  # 
   # It is used for painting the background of rectangles, ellipses, etc. It has a colour and a style.
   # On a monochrome display, wxWidgets shows all brushes as white unless the colour is really black.
   # Do not initialize objects on the stack before the program commences, since other required structures may not have been set up yet. Instead, define global pointers to objects and create them in {Wx::App::OnInit} or when required.
   # An application may wish to create brushes with different characteristics dynamically, and there is the consequent danger that a large number of duplicate brushes will be created. Therefore an application may wish to get a pointer to a brush by using the global list of brushes {Wx::TheBrushList}, and calling the member function Wx::BrushList#find_or_create_brush.
   # This class uses reference counting and copy-on-write internally so that assignments between two instances of this class are very cheap. You can therefore use actual objects instead of pointers without efficiency problems. If an instance of this class is changed it will create its own data internally so that other instances, which previously shared the data using the reference counting, are not affected.
-  # === 
   # 
   # Category:  Graphics Device Interface (GDI)
   # Predefined objects/pointers: 
@@ -120,12 +120,14 @@ module Wx
     # @overload set_colour(colour)
     #   Sets the brush colour using red, green and blue values.
     #   
+    #   
     #   @see Wx::Brush#get_colour 
     #   @param colour [Wx::Colour,String,Symbol] 
     #   @return [void]
     # @overload set_colour(red, green, blue)
     #   Sets the brush colour using red, green and blue values.
     #   
+    #   
     #   @see Wx::Brush#get_colour 
     #   @param red [Integer] 
     #   @param green [Integer] 
@@ -136,6 +138,7 @@ module Wx
     
     # @overload initialize()
     #   Default constructor.
+    #   
     #   The brush will be uninitialised, and {Wx::Brush}:{Wx::Brush#is_ok} will return false.
     #   @return [Wx::Brush]
     # @overload initialize(colour, style=Wx::BrushStyle::BRUSHSTYLE_SOLID)
@@ -145,6 +148,7 @@ module Wx
     #   @return [Wx::Brush]
     # @overload initialize(stippleBitmap)
     #   Constructs a stippled brush using a bitmap.
+    #   
     #   The brush style will be set to {Wx::BrushStyle::BRUSHSTYLE_STIPPLE}.
     #   @param stippleBitmap [Wx::Bitmap] 
     #   @return [Wx::Brush]
@@ -156,12 +160,14 @@ module Wx
     
     # Returns a reference to the brush colour.
     # 
+    # 
     # @see Wx::Brush#set_colour 
     # @return [Wx::Colour]
     def get_colour; end
     alias_method :colour, :get_colour
     
     # Gets a pointer to the stipple bitmap.
+    # 
     # If the brush does not have a {Wx::BrushStyle::BRUSHSTYLE_STIPPLE} style, this bitmap may be non-NULL but uninitialised (i.e. {Wx::Bitmap}:{Wx::Brush#is_ok} returns false).
     # @see Wx::Brush#set_stipple 
     # @return [Wx::Bitmap]
@@ -170,6 +176,7 @@ module Wx
     
     # Returns the brush style, one of the {Wx::BrushStyle} values.
     # 
+    # 
     # @see Wx::Brush#set_style
     # @see  Wx::Brush#set_colour
     # @see  Wx::Brush#set_stipple 
@@ -179,18 +186,21 @@ module Wx
     
     # Returns true if the style of the brush is any of hatched fills.
     # 
+    # 
     # @see Wx::Brush#get_style 
     # @return [Boolean]
     def is_hatch; end
     alias_method :hatch?, :is_hatch
     
     # Returns true if the brush is initialised.
+    # 
     # Notice that an uninitialized brush object can't be queried for any brush properties and all calls to the accessor methods on it will result in an assert failure.
     # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok
     
     # Returns true if the brush is a valid non-transparent brush.
+    # 
     # This method returns true if the brush object is initialized and has a non-transparent style. Notice that this should be used instead of simply testing whether {Wx::Brush#get_style} returns a style different from {Wx::BrushStyle::BRUSHSTYLE_TRANSPARENT} if the brush may be invalid as {Wx::Brush#get_style} would assert in this case.
     # @see Wx::Brush#is_transparent
     # @return [Boolean]
@@ -198,6 +208,7 @@ module Wx
     alias_method :non_transparent?, :is_non_transparent
     
     # Returns true if the brush is transparent.
+    # 
     # A transparent brush is simply a brush with {Wx::BrushStyle::BRUSHSTYLE_TRANSPARENT} style.
     # Notice that this function works even for non-initialized brushes (for which it returns false) unlike tests of the form <code>Wx::Brush#get_style == wxBRUSHSTYLE_TRANSPARENT</code> which would assert if the brush is invalid.
     # @see Wx::Brush#is_non_transparent
@@ -206,7 +217,12 @@ module Wx
     alias_method :transparent?, :is_transparent
     
     # Sets the stipple bitmap.
-    # The style will be set to {Wx::BrushStyle::BRUSHSTYLE_STIPPLE}, unless the bitmap has a mask associated to it, in which case the style will be set to {Wx::BrushStyle::BRUSHSTYLE_STIPPLE_MASK_OPAQUE}.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>The style will be set to {Wx::BrushStyle::BRUSHSTYLE_STIPPLE}, unless the bitmap has a mask associated to it, in which case the style will be set to {Wx::BrushStyle::BRUSHSTYLE_STIPPLE_MASK_OPAQUE}.
+    # </p>
+    # </div>
     # @see Wx::Bitmap 
     # @param bitmap [Wx::Bitmap]  The bitmap to use for stippling.
     # @return [void]
@@ -215,6 +231,7 @@ module Wx
     
     # Sets the brush style.
     # 
+    # 
     # @see Wx::Brush#get_style 
     # @param style [Wx::BrushStyle]  One of the {Wx::BrushStyle} values.
     # @return [void]
@@ -222,6 +239,7 @@ module Wx
     alias_method :style=, :set_style
     
     # Equality operator.
+    # 
     # See Object Comparison for more info.
     # @param brush [Wx::Brush] 
     # @return [Boolean]

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

@@ -7,6 +7,7 @@
 module Wx
 
   # This class makes it easy to tell your user that the program is temporarily busy.
+  # 
   # Normally the main thread should always return to the main loop to continue dispatching events as quickly as possible,
   # hence this class shouldn't be needed. However if the main thread does need to block, this class provides a simple
   # way to at least show this to the user: just call {Wx::BusyInfo.busy} with a block and for the duration of the
@@ -50,15 +51,15 @@ module Wx
   # but take care to not cause undesirable re-entrance when doing it (see {Wx::App#yield} for more details). The simplest way to do it is to use {Wx::WindowDisabler} class as illustrated in the above example.
   # Note that a {Wx::BusyInfo} is always built with the {Wx::STAY_ON_TOP} window style (see {Wx::Frame} window styles for more info).
   # 
-  # ===
-  # 
   # Category:  Common Dialogs
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_BUSYINFO
   class BusyInfo < ::Object
   
     # Update the information text.
+    # 
     # The text string may contain markup as described in {Wx::Control#set_label_markup}.
     # @param str [String] 
     # @return [void]
@@ -72,6 +73,7 @@ module Wx
   end # BusyInfo
   
   # Parameters for {Wx::BusyInfo}.
+  # 
   # This class exists only in order to make passing attributes to {Wx::BusyInfo} constructor easier and the code doing it more readable.
   # All methods of this class return the reference to the object on which they are called, making it possible to chain them together, e.g. typically you would just create a temporary {Wx::BusyInfoFlags} object and then call the methods corresponding to the attributes you want to set, before finally passing the result to {Wx::BusyInfo} constructor, e.g.: 
   # ```ruby
@@ -89,9 +91,11 @@ module Wx
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_BUSYINFO
   class BusyInfoFlags < ::Object
   
     # Default constructor initializes all attributes to default values.
+    # 
     # Call the other methods to really fill in the object.
     # @return [Wx::BusyInfoFlags]
     def initialize; end
@@ -107,18 +111,21 @@ module Wx
     def icon(icon) end
     
     # Sets the title, shown prominently in {Wx::BusyInfo} window.
+    # 
     # The title string may contain markup as described in {Wx::Control#set_label_markup}.
     # @param title [String] 
     # @return [Wx::BusyInfoFlags]
     def title(title) end
     
     # Sets the more detailed text, shown under the title, if any.
+    # 
     # The text string may contain markup as described in {Wx::Control#set_label_markup}.
     # @param text [String] 
     # @return [Wx::BusyInfoFlags]
     def text(text) end
     
     # Same as {Wx::BusyInfoFlags#text} but doesn't interpret the string as containing markup.
+    # 
     # This method should be used if the text shown in {Wx::BusyInfo} comes from external source and so may contain characters having special meaning in simple markup, e.g. '<'.
     # @param label [String] 
     # @return [Wx::BusyInfoFlags]
@@ -136,6 +143,7 @@ module Wx
     
     # Sets the transparency of {Wx::BusyInfo} window.
     # 
+    # 
     # @see Wx::TopLevelWindow#set_transparent 
     # @param alpha [Integer]  Value in {Wx::ALPHA_TRANSPARENT} (0) to {Wx::ALPHA_OPAQUE} (255) range.
     # @return [Wx::BusyInfoFlags]

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

@@ -7,9 +7,10 @@
 module Wx
 
   # A button is a control that contains a text string, and is one of the most common elements of a GUI.
+  # 
   # It may be placed on a dialog box or on a {Wx::Panel} panel, or indeed on almost any other window.
   # By default, i.e. if none of the alignment styles are specified, the label is centered both horizontally and vertically. If the button has both a label and a bitmap, the alignment styles above specify the location of the rectangle combining both the label and the bitmap and the bitmap position set with {Wx::Button#set_bitmap_position} defines the relative position of the bitmap with respect to the label (however currently non-default alignment combinations are not implemented on all platforms).
-  # Since version 2.9.1 {Wx::Button} supports showing both text and an image (currently only when using wxMSW, wxGTK or wxOSX/Cocoa ports), see {Wx::Button#set_bitmap} and {Wx::Button#set_bitmap_label}, {Wx::Button#set_bitmap_disabled} &c methods. In the previous wxWidgets versions this functionality was only available in (the now trivial) {Wx::BitmapButton} class which was only capable of showing an image without text.
+  # Since version 2.9.1 {Wx::Button} supports showing both text and an image (currently only when using WXMSW, WXGTK or WXOSX/Cocoa ports), see {Wx::Button#set_bitmap} and {Wx::Button#set_bitmap_label}, {Wx::Button#set_bitmap_disabled} &c methods. In the previous wxWidgets versions this functionality was only available in (the now trivial) {Wx::BitmapButton} class which was only capable of showing an image without text.
   # A button may have either a single image for all states or different images for the following states (different images are not currently supported under macOS where the normal image is used for all states): 
   # 
   # - <b>normal:</b> the default state 
@@ -25,7 +26,7 @@ module Wx
   # All of the bitmaps must be of the same size and the normal bitmap must be set first (to a valid bitmap), before setting any other ones. Also, if the size of the bitmaps is changed later, you need to change the size of the normal bitmap before setting any other bitmaps with the new size (and you do need to reset all of them as their original values can be lost when the normal bitmap size changes).
   # The position of the image inside the button be configured using {Wx::Button#set_bitmap_position}. By default the image is on the left of the text.
   # Please also notice that GTK+ uses a global setting called <code>gtk-button-images</code> to determine if the images should be shown in the buttons at all. If it is off (which is the case in e.g. Gnome 2.28 by default), no images will be shown, consistently with the native behaviour.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -43,22 +44,21 @@ module Wx
   # 
   # - {Wx::Border::BORDER_NONE}: Creates a button without border. This is currently implemented in MSW, GTK2 and OSX/Cocoa. 
   # 
-  # === 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::CommandEvent} events.
   # Event handler methods for events emitted by this class:
   # 
   # - {Wx::EvtHandler#evt_button}(id, meth = nil, &block): Process a {Wx::EVT_BUTTON} event, when the button is clicked. 
   # 
-  # === 
-  # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
   #   </td></tr></table></div>
   # @see Wx::BitmapButton 
   # 
   # 
+  # @wxrb_require USE_BUTTON
   class Button < AnyButton
   
     # @overload initialize()
@@ -66,6 +66,7 @@ module Wx
     #   @return [Wx::Button]
     # @overload initialize(parent, id, label=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BUTTON_NAME_STR)
     #   Constructor, creating and showing a button.
+    #   
     #   The preferred way to create standard buttons is to use default value of label. If no label is supplied and id is one of standard IDs from this list, a standard label will be used. In other words, if you use a predefined {Wx::ID_XXX} constant, just omit the label completely rather than specifying it. In particular, help buttons (the ones with id of {Wx::StandardID::ID_HELP}) under macOS can't display any label at all and while {Wx::Button} will detect if the standard "Help" label is used and ignore it, using any other label will prevent the button from correctly appearing as a help button and so should be avoided.
     #   In addition to that, the button will be decorated with stock icons under GTK+ 2.
     #   @see Wx::Button#create
@@ -82,6 +83,7 @@ module Wx
     def initialize(*args) end
     
     # Button creation function for two-step creation.
+    # 
     # For more details, see {Wx::Button#initialize}.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -95,7 +97,12 @@ module Wx
     def create(parent, id, label=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BUTTON_NAME_STR) end
     
     # Returns true if an authentication needed symbol is displayed on the button.
-    # This method always returns false if the platform is not Windows Vista or newer.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This method always returns false if the platform is not Windows Vista or newer.
+    # </p>
+    # </div>
     # @see Wx::Button#set_auth_needed
     # @return [Boolean]
     def get_auth_needed; end
@@ -103,13 +110,19 @@ module Wx
     
     # Returns the string label for the button.
     # 
+    # 
     # @see Wx::Button#set_label 
     # @return [String]
     def get_label; end
     alias_method :label, :get_label
     
     # Sets whether an authentication needed symbol should be displayed on the button.
-    # This method doesn't do anything if the platform is not Windows Vista or newer.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This method doesn't do anything if the platform is not Windows Vista or newer.
+    # </p>
+    # </div>
     # @see Wx::Button#get_auth_needed
     # @param needed [Boolean] 
     # @return [void]
@@ -117,10 +130,16 @@ module Wx
     alias_method :auth_needed=, :set_auth_needed
     
     # This sets the button to be the default item in its top-level window (e.g.
+    # 
     # the panel or the dialog box containing it).
     # As normal, pressing return causes the default button to be depressed when the return key is pressed.
     # See also {Wx::Window#set_focus} which sets the keyboard focus for windows and text panel items, and {Wx::TopLevelWindow#set_default_item}.
-    # Under Windows, only dialog box buttons respond to this function.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Under Windows, only dialog box buttons respond to this function.
+    # </p>
+    # </div>
     # 
     # the old default item (possibly NULL)
     # @return [Wx::Window]
@@ -133,6 +152,7 @@ module Wx
     alias_method :label=, :set_label
     
     # Returns the default size for the buttons.
+    # 
     # It is advised to make all the dialog buttons of the same size and this function allows retrieving the (platform, and current font dependent) size which should be the best suited for this.
     # The optional win argument is new since wxWidgets 3.1.3 and allows to get a per-monitor DPI specific size.
     # @param win [Wx::Window]