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

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

@@ -7,11 +7,11 @@
 module Wx
 
   # A {Wx::WindowDC} must be constructed if an application wishes to paint on the whole area of a window (client and decorations).
+  # 
   # This should normally be constructed as a temporary stack object; don't store a {Wx::WindowDC} object.
   # To draw on a window from inside an EVT_PAINT() handler, construct a {Wx::PaintDC} object instead.
   # To draw on the client area of a window from outside an EVT_PAINT() handler, construct a {Wx::ClientDC} object.
   # A {Wx::WindowDC} object is initialized to use the same font and colours as the window it is associated with.
-  # === 
   # 
   # Category:  Device Contexts
   # @see Wx::DC
@@ -26,6 +26,7 @@ module Wx
   class WindowDC < DC
   
     # Constructor.
+    # 
     # Pass a pointer to the window on which you wish to paint.
     # @param window [Wx::Window] 
     # @return [Wx::WindowDC]

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

@@ -7,10 +7,14 @@
 module Wx
 
   # This class disables all top level windows of the application (maybe with the exception of one of them) in its constructor and enables them back in its destructor.
+  # 
   # This is useful when you want to indicate to the user that the application is currently busy and cannot respond to user input.
-  # When instantiated, this affects only windows shown on the screen and not already disabled.
   # 
-  # === 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>When instantiated, this affects only windows shown on the screen and not already disabled.
+  # </p>
+  # </div>
   # 
   # Category:  {Wx::Miscellaneous}
   # @see Wx::BusyCursor 

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

@@ -7,11 +7,17 @@
 module Wx
 
   # A mixin class to be used with other classes that use a {Wx::ImageList}.
+  # 
   # This class is used by classes such as {Wx::Notebook} and {Wx::TreeCtrl}, that use image indices to specify the icons used for their items (page icons for the former or the items inside the control for the latter).
   # The icon index can either be a special value NO_IMAGE to indicate that an item doesn't use an image at all or a small positive integer to specify the index of the icon in the list of images maintained by this class. Note that for many controls, either none of the items should have an icon or all of them should have one, i.e. mixing the items with and without an icon doesn't always work well and may result in less than ideal appearance.
   # To initialize the list of icons used, call {Wx::WithImages#set_images} method passing it a vector of {Wx::BitmapBundle} objects which can, in the simplest case, be just {Wx::Bitmap} or {Wx::Icon} objects  however, as always with {Wx::BitmapBundle}, either more than one bitmap or icon needs to be specified or the bitmap bundle needs to be created from SVG to obtain better appearance in high DPI.
   # Alternative, traditional API which was the only one available until wxWidgets 3.1.6, is based on the use of {Wx::ImageList} class. To use it, you need to create an object of this class and then call either {Wx::WithImages#assign_image_list} to set this image list and give the control its ownership or {Wx::WithImages#set_image_list} to retain the ownership of the image list, which can be useful if the same image list is shared by multiple controls, but requires deleting the image list later.
-  # {Wx::ImageList}-based API is not formally deprecated, but its use is discouraged because it is more complicated than simply providing a vector of bitmaps and it doesn't allow specifying multiple images or using SVG, which is required for good high DPI support. Please don't use {Wx::WithImages#assign_image_list} and {Wx::WithImages#set_image_list} in the new code and use {Wx::WithImages#set_images} instead.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>{Wx::ImageList}-based API is not formally deprecated, but its use is discouraged because it is more complicated than simply providing a vector of bitmaps and it doesn't allow specifying multiple images or using SVG, which is required for good high DPI support. Please don't use {Wx::WithImages#assign_image_list} and {Wx::WithImages#set_image_list} in the new code and use {Wx::WithImages#set_images} instead. 
+  # </p>
+  # </div>
   # 
   # 
   # @note  In wxRuby this is a mixin module instead of a (base) class.
@@ -21,6 +27,7 @@ module Wx
     def initialize; end
     
     # Return the number of images in this control.
+    # 
     # The returned value may be 0 if there are no images associated with the control.
     # @see Wx::WithImages#has_images
     # @return [Integer]
@@ -29,19 +36,21 @@ module Wx
     
     # Return true if the control has any images associated with it.
     # 
+    # 
     # @see Wx::WithImages#get_image_count
     # @return [Boolean]
     def has_images; end
     alias_method :has_images?, :has_images
     
     # Set the images to use for the items in the control.
+    # 
     # This function allows to specify the images to use in multiple different resolutions, letting the control to select the appropriate one for its DPI scaling. For this reason, it should be preferred to using the functions taking {Wx::ImageList}, which has a fixed size, in the new code.
     # @param images [Array<Wx::Image>]  Non empty vector of bitmap bundles. Valid image indexes for the items in this control are determined by the size of this vector.
     # @return [void]
     def set_images(images) end
-    alias_method :images=, :set_images
     
     # Sets the image list for the page control and takes ownership of the list.
+    # 
     # This function exists for compatibility only, please use {Wx::WithImages#set_images} in the new code.
     # @see Wx::ImageList
     # @see  Wx::WithImages#set_image_list 
@@ -51,6 +60,7 @@ module Wx
     alias_method :image_list=, :set_image_list
     
     # Returns the associated image list, may be NULL.
+    # 
     # Note that the new code should use {Wx::WithImages#get_updated_image_list_for} instead.
     # @see Wx::ImageList
     # @see  Wx::WithImages#set_image_list 
@@ -59,6 +69,7 @@ module Wx
     alias_method :image_list, :get_image_list
     
     # Returns the image list updated to reflect the DPI scaling used for the given window if possible.
+    # 
     # If {Wx::WithImages#set_images} has been called, this function creates the image list containing the images using the DPI scaling in effect for the provided win, which must be valid.
     # Otherwise it behaves as {Wx::WithImages#get_image_list}, i.e. returns the image list previously set using {Wx::WithImages#set_image_list} or {Wx::WithImages#assign_image_list}, and just returns NULL if none of them had been called.
     # Possibly null pointer owned by this object, i.e. which must not be deleted by the caller.

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

@@ -7,12 +7,13 @@
 module Wx
 
   # {Wx::Wizard} is the central class for implementing 'wizard-like' dialogs.
+  # 
   # These dialogs are mostly familiar to Windows users and are nothing other than a sequence of 'pages', each displayed inside a dialog which has the buttons to navigate to the next (and previous) pages.
   # The wizards are typically used to decompose a complex dialog into several simple steps and are mainly useful to the novice users, hence it is important to keep them as simple as possible.
   # To show a wizard dialog, you must first create an instance of the {Wx::Wizard} class using either the non-default constructor or a default one followed by call to the {Wx::Wizard#create} function. Then you should add all pages you want the wizard to show and call {Wx::Wizard#run_wizard}. Finally, don't forget to call <code>"wizard->Destroy()"</code>, otherwise your application will hang on exit due to an undestroyed window.
   # You can supply a bitmap to display on the left of the wizard, either for all pages or for individual pages. If you need to have the bitmap resize to the height of the wizard, call {Wx::Wizard#set_bitmap_placement} and if necessary, {Wx::Wizard#set_bitmap_background_colour} and {Wx::Wizard#set_minimum_bitmap_width}.
   # To make wizard pages scroll when the display is too small to fit the whole dialog, you can switch layout adaptation on globally with {Wx::Dialog.enable_layout_adaptation} or per dialog with {Wx::Dialog#set_layout_adaptation_mode}. For more about layout adaptation, see Automatic Scrolled Dialogs.
-  # === 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::WizardEvent} events.
   # Event handler methods for events emitted by this class:
@@ -31,18 +32,17 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_wizard_finished}(id, meth = nil, &block): The wizard finished button was pressed. 
   # 
-  # == Extended styles
+  # ## Extended styles
   # 
   # Use the {Wx::Window#set_extra_style} function to set the following style. You will need to use two-step construction (use the default constructor, call {Wx::Wizard#set_extra_style}, then call Create).
   # 
-  # === Extra Styles
+  # ### Extra Styles
   # 
   # This class supports the following extra styles:
   # 
   # - {Wx::WIZARD_EX_HELPBUTTON}: Shows a Help button using {Wx::StandardID::ID_HELP}. 
   # 
   # See also {Wx::Dialog} for other extended styles.
-  # === 
   # 
   # Category:  Common Dialogs
   # @see Wx::WizardEvent
@@ -50,14 +50,17 @@ module Wx
   # @see  Wizard Sample 
   # 
   # 
+  # @wxrb_require USE_WIZARDDLG
   class Wizard < Dialog
   
     # @overload initialize()
     #   Default constructor.
+    #   
     #   Use this if you wish to derive from {Wx::Wizard} and then call {Wx::Wizard#create}, for example if you wish to set an extra style with {Wx::Window#set_extra_style} between the two calls.
     #   @return [Wx::Wizard]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, title=(''), bitmap=(Wx::BitmapBundle.new()), pos=Wx::DEFAULT_POSITION, style=Wx::DEFAULT_DIALOG_STYLE)
     #   Constructor which really creates the wizard  if you use this constructor, you shouldn't call {Wx::Wizard#create}.
+    #   
     #   Notice that unlike almost all other wxWidgets classes, there is no size parameter in the {Wx::Wizard} constructor because the wizard will have a predefined default size by default. If you want to change this, you should use the {Wx::Wizard#get_page_area_sizer} function.
     #   @param parent [Wx::Window]  The parent window, may be NULL.
     #   @param id [Integer]  The id of the dialog, will usually be just {Wx::StandardID::ID_ANY}.
@@ -69,6 +72,7 @@ module Wx
     def initialize(*args) end
     
     # Creates the wizard dialog.
+    # 
     # Must be called if the default constructor had been used to create the object.
     # Notice that unlike almost all other wxWidgets classes, there is no size parameter in the {Wx::Wizard} constructor because the wizard will have a predefined default size by default. If you want to change this, you should use the {Wx::Wizard#get_page_area_sizer} function.
     # @param parent [Wx::Window]  The parent window, may be NULL.
@@ -81,6 +85,7 @@ module Wx
     def create(parent, id=Wx::StandardID::ID_ANY, title=(''), bitmap=(Wx::BitmapBundle.new()), pos=Wx::DEFAULT_POSITION, style=Wx::DEFAULT_DIALOG_STYLE) end
     
     # This method is obsolete, use {Wx::Wizard#get_page_area_sizer} instead.
+    # 
     # Sets the page size to be big enough for all the pages accessible via the given firstPage, i.e. this page, its next page and so on.
     # This method may be called more than once and it will only change the page size if the size required by the new page is bigger than the previously set one. This is useful if the decision about which pages to show is taken during run-time, as in this case, the wizard won't be able to get to all pages starting from a single one and you should call Fit separately for the others.
     # @param firstPage [Wx::WizardPage] 
@@ -88,12 +93,14 @@ module Wx
     def fit_to_page(firstPage) end
     
     # Returns the colour that should be used to fill the area not taken up by the wizard or page bitmap, if a non-zero bitmap placement flag has been set.
+    # 
     # See also {Wx::Wizard#set_bitmap_placement}.
     # @return [Wx::Colour,String,Symbol]
     def get_bitmap_background_colour; end
     alias_method :bitmap_background_colour, :get_bitmap_background_colour
     
     # Returns the flags indicating how the wizard or page bitmap should be expanded and positioned to fit the page height.
+    # 
     # By default, placement is 0 (no expansion is done).
     # See also {Wx::Wizard#set_bitmap_placement} for the possible values.
     # @return [Integer]
@@ -101,18 +108,21 @@ module Wx
     alias_method :bitmap_placement, :get_bitmap_placement
     
     # Get the current page while the wizard is running.
+    # 
     # NULL is returned if {Wx::Wizard#run_wizard} is not being executed now.
     # @return [Wx::WizardPage]
     def get_current_page; end
     alias_method :current_page, :get_current_page
     
     # Returns the minimum width for the bitmap that will be constructed to contain the actual wizard or page bitmap if a non-zero bitmap placement flag has been set.
+    # 
     # See also {Wx::Wizard#set_bitmap_placement}.
     # @return [Integer]
     def get_minimum_bitmap_width; end
     alias_method :minimum_bitmap_width, :get_minimum_bitmap_width
     
     # Returns pointer to page area sizer.
+    # 
     # The wizard is laid out using sizers and the page area sizer is the place-holder for the pages. All pages are resized before being shown to match the wizard page area.
     # Page area sizer has a minimal size that is the maximum of several values. First, all pages (or other objects) added to the sizer. Second, all pages reachable by repeatedly applying {Wx::WizardPage#get_next} to any page inserted into the sizer.
     # Third, the minimal size specified using {Wx::Wizard#set_page_size} and {Wx::Wizard#fit_to_page}. Fourth, the total wizard height may be increased to accommodate the bitmap height. Fifth and finally, wizards are never smaller than some built-in minimal size to avoid wizards that are too small.
@@ -129,6 +139,7 @@ module Wx
     alias_method :page_size, :get_page_size
     
     # Return true if this page is not the last one in the wizard.
+    # 
     # The base class version implements this by calling {Wx::page->GetNext} but this could be undesirable if, for example, the pages are created on demand only.
     # @see Wx::Wizard#has_prev_page 
     # @param page [Wx::WizardPage] 
@@ -137,6 +148,7 @@ module Wx
     alias_method :has_next_page?, :has_next_page
     
     # Returns true if this page is not the first one in the wizard.
+    # 
     # The base class version implements this by calling {Wx::page->GetPrev} but this could be undesirable if, for example, the pages are created on demand only.
     # @see Wx::Wizard#has_next_page 
     # @param page [Wx::WizardPage] 
@@ -145,6 +157,7 @@ module Wx
     alias_method :has_prev_page?, :has_prev_page
     
     # Executes the wizard starting from the given page, returning true if it was successfully finished or false if user cancelled it.
+    # 
     # The firstPage cannot be NULL.
     # @param firstPage [Wx::WizardPage] 
     # @return [Boolean]
@@ -157,6 +170,7 @@ module Wx
     alias_method :bitmap=, :set_bitmap
     
     # Sets the colour that should be used to fill the area not taken up by the wizard or page bitmap, if a non-zero bitmap placement flag has been set.
+    # 
     # See also {Wx::Wizard#set_bitmap_placement}.
     # @param colour [Wx::Colour,String,Symbol] 
     # @return [void]
@@ -164,6 +178,7 @@ module Wx
     alias_method :bitmap_background_colour=, :set_bitmap_background_colour
     
     # Sets the flags indicating how the wizard or page bitmap should be expanded and positioned to fit the page height.
+    # 
     # By default, placement is 0 (no expansion is done). placement is a bitlist with the following possible values:
     # 
     # - <b>{Wx::WIZARD_VALIGN_TOP}:</b> Aligns the bitmap at the top.
@@ -181,6 +196,7 @@ module Wx
     alias_method :bitmap_placement=, :set_bitmap_placement
     
     # Sets width of border around page area.
+    # 
     # Default is zero. For backward compatibility, if there are no pages in {Wx::Wizard#get_page_area_sizer}, the default is 5 pixels.
     # If there is a five point border around all controls in a page and the border around page area is left as zero, a five point white space along all dialog borders will be added to the control border in order to space page controls ten points from the dialog border and non-page controls.
     # @param border [Integer] 
@@ -189,6 +205,7 @@ module Wx
     alias_method :border=, :set_border
     
     # Sets the minimum width for the bitmap that will be constructed to contain the actual wizard or page bitmap if a non-zero bitmap placement flag has been set.
+    # 
     # If this is not set when using bitmap placement, the initial layout may be incorrect.
     # See also {Wx::Wizard#set_bitmap_placement}.
     # @param width [Integer] 
@@ -197,6 +214,7 @@ module Wx
     alias_method :minimum_bitmap_width=, :set_minimum_bitmap_width
     
     # Sets the minimal size to be made available for the wizard pages.
+    # 
     # The wizard will take into account the size of the bitmap (if any) itself. Also, the wizard will never be smaller than the default size.
     # The recommended way to use this function is to lay out all wizard pages using the sizers (even though the wizard is not resizable) and then use {Wx::Sizer#calc_min} in a loop to calculate the maximum of minimal sizes of the pages and pass it to {Wx::Wizard#set_page_size}.
     # @param sizePage [Array(Integer, Integer), Wx::Size] 

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

@@ -59,7 +59,8 @@ module Wx
   EVT_WIZARD_BEFORE_PAGE_CHANGED = 10015
   
   # {Wx::WizardEvent} class represents an event generated by the {Wx::Wizard}: this event is first sent to the page itself and, if not processed there, goes up the window hierarchy as usual.
-  # === Events using this class
+  # 
+  # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::WizardEvent} events.
   # Event handler methods:
@@ -78,18 +79,18 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_wizard_finished}(id, meth = nil, &block): The wizard finished button was pressed. 
   # 
-  # === 
-  # 
   # Category:  {Wx::Events}
   # @see Wx::Wizard
   # @see  Wizard Sample 
   # 
   # 
+  # @wxrb_require USE_WIZARDDLG
   class WizardEvent < NotifyEvent
   
     # Constructor.
+    # 
     # It is not normally used by the user code as the objects of this type are constructed by {Wx::Wizard}.
-    # @param type [Wx::CommandLinkButton::EventType] 
+    # @param type [Wx::StaticLine::EventType] 
     # @param id [Integer] 
     # @param direction [Boolean] 
     # @param page [Wx::WizardPage] 

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

@@ -7,19 +7,20 @@
 module Wx
 
   # {Wx::WizardPage} is one of the screens in {Wx::Wizard}: it must know what are the following and preceding pages (which may be NULL for the first/last page).
+  # 
   # Except for this extra knowledge, {Wx::WizardPage} is just a panel, so the controls may be placed directly on it in the usual way.
   # This class allows the programmer to decide the order of pages in the wizard dynamically (during run-time) and so provides maximal flexibility. Usually, however, the order of pages is known in advance in which case {Wx::WizardPageSimple} class is enough and it is simpler to use.
   # 
-  # == Virtual functions to override
+  # ## Virtual functions to override
   # 
   # To use this class, you must override {Wx::WizardPage#get_prev} and {Wx::WizardPage#get_next} pure virtual functions (or you may use {Wx::WizardPageSimple} instead). {Wx::WizardPage#get_bitmap} can also be overridden, but this should be very rarely needed.
-  # === 
   # 
   # Category:  Miscellaneous Windows
   # @see Wx::Wizard
   # @see  Wizard Sample 
   # 
   # 
+  # @wxrb_require USE_WIZARDDLG
   class WizardPage < Panel
   
     # Default constructor.
@@ -27,6 +28,7 @@ module Wx
     def initialize; end
     
     # Creates the wizard page.
+    # 
     # Must be called if the default constructor had been used to create the object.
     # @param parent [Wx::Wizard]  The parent wizard
     # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  The page-specific bitmap if different from the global one
@@ -34,6 +36,7 @@ module Wx
     def create(parent, bitmap=(Wx::BitmapBundle.new())) end
     
     # This method is called by {Wx::Wizard} to get the bitmap to display alongside the page.
+    # 
     # By default, m_bitmap member variable which was set in the {Wx::WizardPage#initialize} constructor.
     # If the bitmap was not explicitly set (i.e. if {Wx::NULL_BITMAP} is returned), the default bitmap for the wizard should be used.
     # The only cases when you would want to override this function is if the page bitmap depends dynamically on the user choices, i.e. almost never.
@@ -42,6 +45,7 @@ module Wx
     alias_method :bitmap, :get_bitmap
     
     # Get the page which should be shown when the user chooses the <code>"Next"</code> button: if NULL is returned, this button will be disabled.
+    # 
     # The last page of the wizard will usually return NULL from here, but the others will not.
     # @see Wx::WizardPage#get_prev 
     # @return [Wx::WizardPage]
@@ -49,6 +53,7 @@ module Wx
     alias_method :next_, :get_next
     
     # Get the page which should be shown when the user chooses the <code>"Back"</code> button: if NULL is returned, this button will be disabled.
+    # 
     # The first page of the wizard will usually return NULL from here, but the others will not.
     # @see Wx::WizardPage#get_next 
     # @return [Wx::WizardPage]

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

@@ -7,14 +7,15 @@
 module Wx
 
   # {Wx::WizardPageSimple} is the simplest possible {Wx::WizardPage} implementation: it just returns the pointers given to its constructor from {Wx::WizardPage#get_next} and {Wx::WizardPage#get_prev} functions.
+  # 
   # This makes it very easy to use the objects of this class in the wizards where the pages order is known statically - on the other hand, if this is not the case you must derive your own class from {Wx::WizardPage} instead.
-  # === 
   # 
   # Category:  Miscellaneous Windows
   # @see Wx::Wizard
   # @see  Wizard Sample 
   # 
   # 
+  # @wxrb_require USE_WIZARDDLG
   class WizardPageSimple < WizardPage
   
     # @overload initialize()
@@ -22,6 +23,7 @@ module Wx
     #   @return [Wx::WizardPageSimple]
     # @overload initialize(parent, prev=nil, next_=nil, bitmap=(Wx::BitmapBundle.new()))
     #   Constructor takes the previous and next pages.
+    #   
     #   They may be modified later by {Wx::WizardPageSimple#set_prev} or {Wx::WizardPageSimple#set_next}.
     #   @param parent [Wx::Wizard] 
     #   @param prev [Wx::WizardPage] 
@@ -31,6 +33,7 @@ module Wx
     def initialize(*args) end
     
     # Creates the wizard page.
+    # 
     # Must be called if the default constructor had been used to create the object.
     # @param parent [Wx::Wizard] 
     # @param prev [Wx::WizardPage] 
@@ -40,6 +43,7 @@ module Wx
     def create(parent=nil, prev=nil, next_=nil, bitmap=(Wx::BitmapBundle.new())) end
     
     # A helper chaining this page with the next one.
+    # 
     # Notice that this method returns a reference to the next page, so the calls to it can, in turn, be chained:
     # 
     # ```ruby

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

@@ -19,9 +19,9 @@ module Wx
   WRAPSIZER_DEFAULT_FLAGS = 3
   
   # A wrap sizer lays out its items in a single line, like a box sizer  as long as there is space available in that direction.
+  # 
   # Once all available space in the primary direction has been used, a new line is added and items are added there.
   # So a wrap sizer has a primary orientation for adding items, and adds lines as needed in the secondary direction.
-  # === 
   # 
   # Category:  Window Layout
   # @see Wx::BoxSizer
@@ -32,6 +32,7 @@ module Wx
   class WrapSizer < BoxSizer
   
     # Constructor for a {Wx::WrapSizer}.
+    # 
     # orient determines the primary direction of the sizer (the most common case being {Wx::Orientation::HORIZONTAL}). The flags parameter can be a combination of the values {Wx::EXTEND_LAST_ON_EACH_LINE} which will cause the last item on each line to use any remaining space on that line and {Wx::REMOVE_LEADING_SPACES} which removes any spacer elements from the beginning of a row.
     # Both of these flags are on by default.
     # @param orient [Integer] 
@@ -40,6 +41,7 @@ module Wx
     def initialize(orient=Wx::Orientation::HORIZONTAL, flags=Wx::WRAPSIZER_DEFAULT_FLAGS) end
     
     # Not used by an application.
+    # 
     # This is the mechanism by which sizers can inform sub-items of the first determined size component. The sub-item can then better determine its size requirements.
     # Returns true if the information was used (and the sub-item min size was updated).
     # @param direction [Integer] 
@@ -49,12 +51,14 @@ module Wx
     def inform_first_direction(direction, size, availableOtherDir) end
     
     # 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::WrapSizer#calc_min}.
     # @param minSize [Array(Integer, Integer), Wx::Size] 
     # @return [void]
     def reposition_children(minSize) 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

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

@@ -13,6 +13,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_XML
   class XmlNodeType < Wx::Enum
   
     # 
@@ -73,6 +74,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_XML
   class XmlDocumentLoadFlag < Wx::Enum
   
     # 
@@ -86,6 +88,7 @@ module Wx
   end # XmlDocumentLoadFlag
   
   # Represents a node in an XML document.
+  # 
   # See {Wx::XmlDocument}.
   # Each node is named and depending on the node type it may also hold content or be given attributes.
   # The two most common node types are {Wx::XmlNodeType::XML_ELEMENT_NODE} and {Wx::XmlNodeType::XML_TEXT_NODE}. {Wx::XmlNodeType::XML_ELEMENT_NODE} represents a pair of XML element tags, whilst {Wx::XmlNodeType::XML_TEXT_NODE} represents the text value that can belong to the element.
@@ -94,9 +97,12 @@ module Wx
   # A {Wx::XmlNodeType::XML_PI_NODE} represents a Processing Instruction (PI) node with the name parameter set as the target and the contents parameter set as the instructions. Note that whilst the PI instructions are often in the form of pseudo-attributes, these do not use the node's attribute member. It is the user's responsibility to code and decode the PI instruction text.
   # The {Wx::XmlNodeType::XML_DOCUMENT_TYPE_NODE} is not implemented at this time. Instead, you should get and set the DOCTYPE values using the {Wx::XmlDocument} class.
   # If {Wx::Setup::USE_UNICODE} is 0, all strings are encoded in the encoding given to Wx::XmlDocument::Load (default is UTF-8).
-  # Once a {Wx::XmlNode} has been added to a {Wx::XmlDocument} it becomes owned by the document and this has two implications. Firstly, the {Wx::XmlDocument} takes responsibility for deleting the node so the user should not delete it; and secondly, a {Wx::XmlNode} must always be created on the heap and never on the stack.
   # 
-  # === 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>Once a {Wx::XmlNode} has been added to a {Wx::XmlDocument} it becomes owned by the document and this has two implications. Firstly, the {Wx::XmlDocument} takes responsibility for deleting the node so the user should not delete it; and secondly, a {Wx::XmlNode} must always be created on the heap and never on the stack.
+  # </p>
+  # </div>
   # 
   # Category:  {Wx::XML}
   # @see Wx::XmlDocument
@@ -106,6 +112,7 @@ module Wx
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_XML
   class XmlNode < ::Object
   
     # @overload initialize(type, name, content=(''), lineNo=-1)
@@ -117,6 +124,7 @@ module Wx
     #   @return [Wx::XmlNode]
     # @overload initialize(node)
     #   Copy constructor.
+    #   
     #   Note that this does NOT copy siblings and parent pointer, i.e. {Wx::XmlNode#get_parent} and {Wx::XmlNode#get_next} will return NULL after using copy ctor and are never unmodified by {Wx::operator=()}. On the other hand, it DOES copy children and attributes.
     #   @param node [Wx::XmlNode] 
     #   @return [Wx::XmlNode]
@@ -129,8 +137,14 @@ module Wx
     def add_attribute(name, value) end
     
     # Adds node child as the last child of this node.
+    # 
     # Once added, the XML tree takes ownership of this object and there is no need to delete it.
-    # Note that this function works in O(n) time where n is the number of existing children. Consequently, adding large number of child nodes using this method can be expensive, because it has O(n^2) time complexity in number of nodes to be added. Use {Wx::XmlNode#insert_child_after} to populate XML tree in linear time.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Note that this function works in O(n) time where n is the number of existing children. Consequently, adding large number of child nodes using this method can be expensive, because it has O(n^2) time complexity in number of nodes to be added. Use {Wx::XmlNode#insert_child_after} to populate XML tree in linear time.
+    # </p>
+    # </div>
     # @see Wx::XmlNode#insert_child
     # @see  Wx::XmlNode#insert_child_after 
     # @param child [Wx::XmlNode] 
@@ -143,6 +157,7 @@ module Wx
     def delete_attribute(name) end
     
     # Returns the value of the attribute named attrName if it does exist.
+    # 
     # If it does not exist, the defaultVal is returned.
     # @param attrName [String] 
     # @param defaultVal [String] 
@@ -151,18 +166,21 @@ module Wx
     alias_method :attribute, :get_attribute
     
     # Returns the first child of this node.
+    # 
     # To get a pointer to the second child of this node (if it does exist), use the {Wx::XmlNode#get_next} function on the returned value.
     # @return [Wx::XmlNode]
     def get_children; end
     alias_method :children, :get_children
     
     # Returns the content of this node.
+    # 
     # Can be an empty string. Be aware that for nodes of type {Wx::XmlNodeType::XML_ELEMENT_NODE} (the most used node type) the content is an empty string. See {Wx::XmlNode#get_node_content} for more details.
     # @return [Wx::String]
     def get_content; end
     alias_method :content, :get_content
     
     # Returns the number of nodes which separate this node from grandparent.
+    # 
     # This function searches only the parents of this node until it finds grandparent or the NULL node (which is the parent of non-linked nodes or the parent of a {Wx::XmlDocument}'s root element node).
     # @param grandparent [Wx::XmlNode] 
     # @return [Integer]
@@ -170,6 +188,7 @@ module Wx
     alias_method :depth, :get_depth
     
     # Returns a flag indicating whether encoding conversion is necessary when saving.
+    # 
     # The default is false.
     # You can improve saving efficiency considerably by setting this value.
     # @return [Boolean]
@@ -182,6 +201,7 @@ module Wx
     alias_method :line_number, :get_line_number
     
     # Returns the name of this node.
+    # 
     # Can be an empty string (e.g. for nodes of type {Wx::XmlNodeType::XML_TEXT_NODE} or {Wx::XmlNodeType::XML_CDATA_SECTION_NODE}).
     # @return [Wx::String]
     def get_name; end
@@ -193,6 +213,7 @@ module Wx
     alias_method :next_, :get_next
     
     # Returns the content of the first child node of type {Wx::XmlNodeType::XML_TEXT_NODE} or {Wx::XmlNodeType::XML_CDATA_SECTION_NODE}.
+    # 
     # This function is very useful since the XML snippet <code>"<tagname>tagcontent</tagname>"</code> is represented by expat with the following tag tree:
     # 
     # ```
@@ -229,10 +250,15 @@ module Wx
     alias_method :has_attribute?, :has_attribute
     
     # Inserts the child node immediately before followingNode in the children list.
+    # 
     # Once inserted, the XML tree takes ownership of the new child and there is no need to delete it.
     # true if followingNode has been found and the child node has been inserted.
     # 
-    # For historical reasons, followingNode may be NULL. In that case, then child is prepended to the list of children and becomes the first child of this node, i.e. it behaves identically to using the first children (as returned by {Wx::XmlNode#get_children}) for followingNode).
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>For historical reasons, followingNode may be NULL. In that case, then child is prepended to the list of children and becomes the first child of this node, i.e. it behaves identically to using the first children (as returned by {Wx::XmlNode#get_children}) for followingNode).
+    # </p>
+    # </div>
     # @see Wx::XmlNode#add_child
     # @see  Wx::XmlNode#insert_child_after 
     # @param child [Wx::XmlNode] 
@@ -241,6 +267,7 @@ module Wx
     def insert_child(child, followingNode) end
     
     # Inserts the child node immediately after precedingNode in the children list.
+    # 
     # Once inserted, the XML tree takes ownership of the new child and there is no need to delete it.
     # true if precedingNode has been found and the child node has been inserted.
     # @see Wx::XmlNode#insert_child
@@ -251,6 +278,7 @@ module Wx
     def insert_child_after(child, precedingNode) end
     
     # Returns true if the content of this node is a string containing only whitespaces (spaces, tabs, new lines, etc).
+    # 
     # Note that this function is locale-independent since the parsing of XML documents must always produce the exact same tree regardless of the locale it runs under.
     # @return [Boolean]
     def is_whitespace_only; end
@@ -269,6 +297,7 @@ module Wx
     alias_method :name=, :set_name
     
     # Sets a flag to indicate whether encoding conversion is necessary when saving.
+    # 
     # The default is false.
     # You can improve saving efficiency considerably by setting this value.
     # @param noconversion [Boolean]