wxruby3 0.9.0.pre.rc.2-x64-mingw-ucrt → 0.9.0-x64-mingw-ucrt

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

@@ -28,7 +28,7 @@ module Wx
     # Constructor.
     # Pass a pointer to the window on which you wish to paint.
     # @param window [Wx::Window] 
-    # @return [WindowDC]
+    # @return [Wx::WindowDC]
     def initialize(window) end
     
   end # WindowDC

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

@@ -17,7 +17,7 @@ module Wx
   # @note  In wxRuby this is a mixin module instead of a (base) class.
   module WithImages
   
-    # @return [WithImages]
+    # @return [Wx::WithImages]
     def initialize; end
     
     # Return the number of images in this control.
@@ -30,7 +30,7 @@ module Wx
     # Return true if the control has any images associated with it.
     # 
     # @see Wx::WithImages#get_image_count
-    # @return [true,false]
+    # @return [Boolean]
     def has_images; end
     alias_method :has_images?, :has_images
     

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

@@ -16,12 +16,19 @@ module Wx
   # 
   # 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:
+  # 
   # - {Wx::EvtHandler#evt_wizard_page_changed}(id, meth = nil, &block): The page has just been changed (this event cannot be vetoed). 
+  # 
   # - {Wx::EvtHandler#evt_wizard_page_changing}(id, meth = nil, &block): The page is being changed (this event can be vetoed). 
+  # 
   # - {Wx::EvtHandler#evt_wizard_before_page_changed}(id, meth = nil, &block): Called after Next is clicked but before GetNext is called. Unlike EVT_WIZARD_CHANGING, the handler for this function can change state that might affect the return value of GetNext. This event can be vetoed. 
+  # 
   # - {Wx::EvtHandler#evt_wizard_page_shown}(id, meth = nil, &block): The page was shown and laid out (this event cannot be vetoed). 
+  # 
   # - {Wx::EvtHandler#evt_wizard_cancel}(id, meth = nil, &block): The user attempted to cancel the wizard (this event may also be vetoed). 
+  # 
   # - {Wx::EvtHandler#evt_wizard_help}(id, meth = nil, &block): The wizard help button was pressed. 
+  # 
   # - {Wx::EvtHandler#evt_wizard_finished}(id, meth = nil, &block): The wizard finished button was pressed. 
   # 
   # == Extended styles
@@ -31,7 +38,7 @@ module Wx
   # === 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.
@@ -48,7 +55,7 @@ module Wx
     # @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 [Wizard]
+    #   @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.
@@ -58,7 +65,7 @@ module Wx
     #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  The default bitmap used in the left side of the wizard. See also {Wx::Wizard#get_bitmap}.
     #   @param pos [Array(Integer, Integer), Wx::Point]  The position of the dialog, it will be centered on the screen by default.
     #   @param style [Integer]  Window style is passed to {Wx::Dialog}.
-    #   @return [Wizard]
+    #   @return [Wx::Wizard]
     def initialize(*args) end
     
     # Creates the wizard dialog.
@@ -70,7 +77,7 @@ module Wx
     # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  The default bitmap used in the left side of the wizard. See also {Wx::Wizard#get_bitmap}.
     # @param pos [Array(Integer, Integer), Wx::Point]  The position of the dialog, it will be centered on the screen by default.
     # @param style [Integer]  Window style is passed to {Wx::Dialog}.
-    # @return [true,false]
+    # @return [Boolean]
     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.
@@ -125,7 +132,7 @@ module Wx
     # 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] 
-    # @return [true,false]
+    # @return [Boolean]
     def has_next_page(page) end
     alias_method :has_next_page?, :has_next_page
     
@@ -133,14 +140,14 @@ module Wx
     # 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] 
-    # @return [true,false]
+    # @return [Boolean]
     def has_prev_page(page) end
     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 [true,false]
+    # @return [Boolean]
     def run_wizard(firstPage) end
     
     # Sets the bitmap used for the wizard.
@@ -159,7 +166,13 @@ module Wx
     # 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.- <b>{Wx::WIZARD_VALIGN_CENTRE}:</b> Centres the bitmap vertically.- <b>{Wx::WIZARD_VALIGN_BOTTOM}:</b> Aligns the bitmap at the bottom.- <b>{Wx::WIZARD_HALIGN_LEFT}:</b> Left-aligns the bitmap.- <b>{Wx::WIZARD_HALIGN_CENTRE}:</b> Centres the bitmap horizontally.- <b>{Wx::WIZARD_HALIGN_RIGHT}:</b> Right-aligns the bitmap.- <b>{Wx::WIZARD_TILE}:</b> The bitmap will be tiled to fit available space.
+    # - <b>{Wx::WIZARD_VALIGN_TOP}:</b> Aligns the bitmap at the top.
+    # - <b>{Wx::WIZARD_VALIGN_CENTRE}:</b> Centres the bitmap vertically.
+    # - <b>{Wx::WIZARD_VALIGN_BOTTOM}:</b> Aligns the bitmap at the bottom.
+    # - <b>{Wx::WIZARD_HALIGN_LEFT}:</b> Left-aligns the bitmap.
+    # - <b>{Wx::WIZARD_HALIGN_CENTRE}:</b> Centres the bitmap horizontally.
+    # - <b>{Wx::WIZARD_HALIGN_RIGHT}:</b> Right-aligns the bitmap.
+    # - <b>{Wx::WIZARD_TILE}:</b> The bitmap will be tiled to fit available space.
     # 
     # See also {Wx::Wizard#set_minimum_bitmap_width}.
     # @param placement [Integer] 

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

@@ -63,12 +63,19 @@ module Wx
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::WizardEvent} events.
   # Event handler methods:
+  # 
   # - {Wx::EvtHandler#evt_wizard_page_changed}(id, meth = nil, &block): The page has been just changed (this event cannot be vetoed). 
+  # 
   # - {Wx::EvtHandler#evt_wizard_page_changing}(id, meth = nil, &block): The page is being changed (this event can be vetoed). 
+  # 
   # - {Wx::EvtHandler#evt_wizard_before_page_changed}(id, meth = nil, &block): Called after Next is clicked but before GetNext is called. Unlike EVT_WIZARD_CHANGING, the handler for this function can change state that might affect the return value of GetNext. This event can be vetoed. 
+  # 
   # - {Wx::EvtHandler#evt_wizard_page_shown}(id, meth = nil, &block): The page was shown and laid out (this event cannot be vetoed). 
+  # 
   # - {Wx::EvtHandler#evt_wizard_cancel}(id, meth = nil, &block): The user attempted to cancel the wizard (this event may also be vetoed). 
+  # 
   # - {Wx::EvtHandler#evt_wizard_help}(id, meth = nil, &block): The wizard help button was pressed. 
+  # 
   # - {Wx::EvtHandler#evt_wizard_finished}(id, meth = nil, &block): The wizard finished button was pressed. 
   # 
   # === 
@@ -82,15 +89,15 @@ module Wx
   
     # Constructor.
     # It is not normally used by the user code as the objects of this type are constructed by {Wx::Wizard}.
-    # @param type [Integer] 
+    # @param type [Wx::CommandLinkButton::EventType] 
     # @param id [Integer] 
-    # @param direction [true,false] 
+    # @param direction [Boolean] 
     # @param page [Wx::WizardPage] 
-    # @return [WizardEvent]
+    # @return [Wx::WizardEvent]
     def initialize(type=Wx::EVT_NULL, id=Wx::StandardID::ID_ANY, direction=true, page=0) end
     
     # Return the direction in which the page is changing: for EVT_WIZARD_PAGE_CHANGING, return true if we're going forward or false otherwise and for EVT_WIZARD_PAGE_CHANGED return true if we came from the previous page and false if we returned from the next one.
-    # @return [true,false]
+    # @return [Boolean]
     def get_direction; end
     alias_method :direction, :get_direction
     

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

@@ -23,18 +23,18 @@ module Wx
   class WizardPage < Panel
   
     # Default constructor.
-    # @return [WizardPage]
+    # @return [Wx::WizardPage]
     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
-    # @return [true,false]
+    # @return [Boolean]
     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#wizard_page} constructor.
+    # 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.
     # @return [Wx::Bitmap]

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

@@ -19,7 +19,7 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [WizardPageSimple]
+    #   @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}.
@@ -27,7 +27,7 @@ module Wx
     #   @param prev [Wx::WizardPage] 
     #   @param next_ [Wx::WizardPage] 
     #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
-    #   @return [WizardPageSimple]
+    #   @return [Wx::WizardPageSimple]
     def initialize(*args) end
     
     # Creates the wizard page.
@@ -36,17 +36,17 @@ module Wx
     # @param prev [Wx::WizardPage] 
     # @param next_ [Wx::WizardPage] 
     # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
-    # @return [true,false]
+    # @return [Boolean]
     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:
     # 
-    # ```
-    #   wxWizardPageSimple* firstPage = new FirstPage;
-    #   (*firstPage).Chain(new SecondPage)
-    #               .Chain(new ThirdPage)
-    #               .Chain(new LastPage);
+    # ```ruby
+    #   firstPage = FirstPage.new # derived from Wx::WizardPageSimple
+    #   firstPage.chain(SecondPage.new)
+    #              .chain(ThirdPage.new)
+    #              .chain(LastPage.new)
     # ```
     # 
     # This makes this method the simplest way to define the order of changes in fully static wizards, i.e. in those where the order doesn't depend on the choices made by the user in the wizard pages during run-time.

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

@@ -0,0 +1,65 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  EXTEND_LAST_ON_EACH_LINE = 1
+  
+  # 
+  # 
+  REMOVE_LEADING_SPACES = 2
+  
+  # 
+  # 
+  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
+  # @see  Wx::Sizer
+  # @see  Sizers Overview 
+  # 
+  # 
+  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] 
+    # @param flags [Integer] 
+    # @return [Wx::WrapSizer]
+    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] 
+    # @param size [Integer] 
+    # @param availableOtherDir [Integer] 
+    # @return [Boolean]
+    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
+    
+  end # WrapSizer
+  
+
+end

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

@@ -110,16 +110,16 @@ module Wx
   
     # @overload initialize(type, name, content=(''), lineNo=-1)
     #   A simplified version of the first constructor form, assuming a NULL parent.
-    #   @param type [XmlNodeType]  One of the {Wx::XmlNodeType} enumeration value.
+    #   @param type [Wx::XmlNodeType]  One of the {Wx::XmlNodeType} enumeration value.
     #   @param name [String]  The name of the node. This is the string which appears between angular brackets.
     #   @param content [String]  The content of the node. Only meaningful when type is {Wx::XmlNodeType::XML_TEXT_NODE} or {Wx::XmlNodeType::XML_CDATA_SECTION_NODE}.
     #   @param lineNo [Integer]  Number of line this node was present at in input file or -1.
-    #   @return [XmlNode]
+    #   @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 [XmlNode]
+    #   @return [Wx::XmlNode]
     def initialize(*args) end
     
     # Appends an attribute with given name and value to the list of attributes for this node.
@@ -139,7 +139,7 @@ module Wx
     
     # Removes the first attributes which has the given name from the list of attributes for this node.
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def delete_attribute(name) end
     
     # Returns the value of the attribute named attrName if it does exist.
@@ -172,7 +172,7 @@ module Wx
     # 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 [true,false]
+    # @return [Boolean]
     def get_no_conversion; end
     alias_method :no_conversion, :get_no_conversion
     
@@ -193,7 +193,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>"tagnametagcontent/tagname"</code> is represented by expat with the following tag tree:
+    # This function is very useful since the XML snippet <code>"<tagname>tagcontent</tagname>"</code> is represented by expat with the following tag tree:
     # 
     # ```
     #   wxXML_ELEMENT_NODE name="tagname", content=""
@@ -218,13 +218,13 @@ module Wx
     alias_method :parent, :get_parent
     
     # Returns the type of this node.
-    # @return [XmlNodeType]
+    # @return [Wx::XmlNodeType]
     def get_type; end
     alias_method :type, :get_type
     
     # Returns true if this node has a attribute named attrName.
     # @param attrName [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def has_attribute(attrName) end
     alias_method :has_attribute?, :has_attribute
     
@@ -237,7 +237,7 @@ module Wx
     # @see  Wx::XmlNode#insert_child_after 
     # @param child [Wx::XmlNode] 
     # @param followingNode [Wx::XmlNode] 
-    # @return [true,false]
+    # @return [Boolean]
     def insert_child(child, followingNode) end
     
     # Inserts the child node immediately after precedingNode in the children list.
@@ -247,12 +247,12 @@ module Wx
     # @see  Wx::XmlNode#add_child 
     # @param child [Wx::XmlNode]  The child to insert.
     # @param precedingNode [Wx::XmlNode]  The node to insert child after. As a special case, this can be NULL if this node has no children yet  in that case, child will become this node's only child node.
-    # @return [true,false]
+    # @return [Boolean]
     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 [true,false]
+    # @return [Boolean]
     def is_whitespace_only; end
     alias_method :whitespace_only?, :is_whitespace_only
     
@@ -271,13 +271,13 @@ module Wx
     # 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 [true,false] 
+    # @param noconversion [Boolean] 
     # @return [void]
     def set_no_conversion(noconversion) end
     alias_method :no_conversion=, :set_no_conversion
     
     # Sets the type of this node.
-    # @param type [XmlNodeType] 
+    # @param type [Wx::XmlNodeType] 
     # @return [void]
     def set_type(type) end
     alias_method :type=, :set_type

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

@@ -48,12 +48,12 @@ module Wx
     #   @param filemask [String]  The XRC file, archive file, or wildcard specification that will be used to load all resource files inside a zip archive.
     #   @param flags [Integer]  One or more value of the {Wx::XmlResourceFlags} enumeration.
     #   @param domain [String]  The name of the gettext catalog to search for translatable strings. By default all loaded catalogs will be searched. This provides a way to allow the strings to only come from a specific catalog.
-    #   @return [XmlResource]
+    #   @return [Wx::XmlResource]
     # @overload initialize(flags=Wx::XmlResourceFlags::XRC_USE_LOCALE, domain=(''))
     #   Constructor.
     #   @param flags [Integer]  One or more value of the {Wx::XmlResourceFlags} enumeration.
     #   @param domain [String]  The name of the gettext catalog to search for translatable strings. By default all loaded catalogs will be searched. This provides a way to allow the strings to only come from a specific catalog.
-    #   @return [XmlResource]
+    #   @return [Wx::XmlResource]
     def initialize(*args) end
     
     # Attaches an unknown control to the given panel/window/dialog.
@@ -61,7 +61,7 @@ module Wx
     # @param name [String] 
     # @param control [Wx::Window] 
     # @param parent [Wx::Window] 
-    # @return [true,false]
+    # @return [Boolean]
     def attach_unknown_control(name, control, parent=nil) end
     
     # Compares the XRC version to the argument.
@@ -104,18 +104,19 @@ module Wx
     
     # Loads resources from XML files that match given filemask.
     # Example: 
-    # ```
-    #   if (!wxXmlResource::Get()->Load("rc/*.xrc"))
-    #       wxLogError("Couldn't load resources!");
+    # ```ruby
+    #   if !Wx::XmlResource.get.load('rc/*.xrc')
+    #     Wx.log_error("Couldn't load resources!")
+    #   end
     # ```
     # 
-    # If {Wx::USE_FILESYS} is enabled, this method understands {Wx::FileSystem} URLs (see Wx::FileSystem#find_first).
+    # If {Wx::USE_FILESYS} is enabled, this method understands {Wx::FileSystem} URLs (see {Wx::FileSystem#find_first}).
     # 
     # If you are sure that the argument is name of single XRC file (rather than an URL or a wildcard), use {Wx::XmlResource#load_file} instead.
     # @see Wx::XmlResource#load_file
     # @see  Wx::XmlResource#load_all_files 
     # @param filemask [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def load(filemask) end
     
     # Simpler form of {Wx::XmlResource#load} for loading a single XRC file.
@@ -123,8 +124,8 @@ module Wx
     # @see Wx::XmlResource#load
     # @see  Wx::XmlResource#load_all_files
     # @see  Wx::XmlResource#load_document 
-    # @param file [Wx::FileName] 
-    # @return [true,false]
+    # @param file [String] 
+    # @return [Boolean]
     def load_file(file) end
     
     # Loads all .xrc files from directory dirname.
@@ -132,7 +133,7 @@ module Wx
     # @see Wx::XmlResource#load_file
     # @see  Wx::XmlResource#load 
     # @param dirname [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def load_all_files(dirname) end
     
     # Loads a bitmap resource from a file.
@@ -151,15 +152,17 @@ module Wx
     # parent points to parent window (if any).
     # This form is used to finish creation of an already existing instance (the main reason for this is that you may want to use derived class with a new event table). Example:
     # 
-    # ```
-    #   MyDialog dlg;
-    #   wxXmlResource::Get()->LoadDialog(&dlg, mainFrame, "my_dialog");
-    #   dlg.ShowModal();
+    # ```ruby
+    #   dlg = MyDialog.new
+    #   Wx::XmlResource.get.load_dialog_subclass(dlg, main_frame, 'my_dialog')
+    #   dlg.show_modal
+    # 
+    #   dlg.destroy
     # ```
     # @param dlg [Wx::Dialog] 
     # @param parent [Wx::Window] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def load_dialog_subclass(dlg, parent, name) end
     
     # Loads a frame from the resource.
@@ -174,7 +177,7 @@ module Wx
     # @param frame [Wx::Frame] 
     # @param parent [Wx::Window] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def load_frame_subclass(frame, parent, name) end
     
     # Loads an icon resource from a file.
@@ -212,7 +215,7 @@ module Wx
     #   @param parent [Wx::Window] 
     #   @param name [String] 
     #   @param classname [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def load_object(*args) end
     
     # @overload load_object_recursively(parent, name, classname)
@@ -227,7 +230,7 @@ module Wx
     #   @param parent [Wx::Window] 
     #   @param name [String] 
     #   @param classname [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def load_object_recursively(*args) end
     
     # Loads a panel.
@@ -242,7 +245,7 @@ module Wx
     # @param panel [Wx::Panel] 
     # @param parent [Wx::Window] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def load_panel_subclass(panel, parent, name) end
     
     # Loads a toolbar.
@@ -266,7 +269,7 @@ module Wx
     # This function unloads a resource previously loaded by {Wx::XmlResource#load}.
     # Returns true if the resource was successfully unloaded and false if it hasn't been found in the list of loaded resources.
     # @param filename [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def unload(filename) end
     
     # Registers subclasses factory for use in XRC.

data/lib/wx/doc/graphics_context.rb

@@ -1,42 +1,62 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
 
-class Wx::GraphicsContext
-
-  # @overload self.draw_on(window)
-  #   Creates a {Wx::GraphicsContext} from a {Wx::Window} and passes that object to the given block.
-  #   Deletes the gc object after the block returns.
-  #   @see Wx::GraphicsRenderer#create_context
-  #   @param window [Wx::Window]
-  #   @return [Wx::GraphicsContext]
-  # @overload self.draw_on(windowDC)
-  #   Creates a {Wx::GraphicsContext} from a {Wx::WindowDC} and passes that object to the given block.
-  #   Deletes the gc object after the block returns.
-  #   @see Wx::GraphicsRenderer#create_context
-  #   @param windowDC [Wx::WindowDC]
-  #   @return [Wx::GraphicsContext]
-  # @overload self.draw_on(memoryDC)
-  #   Creates a {Wx::GraphicsContext} from a {Wx::MemoryDC} and passes that object to the given block.
-  #   Deletes the gc object after the block returns.
-  #   @see Wx::GraphicsRenderer#create_context
-  #   @param memoryDC [Wx::MemoryDC]
-  #   @return [Wx::GraphicsContext]
-  # @overload self.draw_on(printerDC)
-  #   Creates a {Wx::GraphicsContext} from a {Wx::PrinterDC} and passes that object to the given block.
-  #   Deletes the gc object after the block returns.
-  #   Under GTK+, this will only work when using the GtkPrint printing backend which is available since GTK+ 2.10.
-  #   @see Wx::GraphicsRenderer#create_context
-  #   @see  Printing Under Unix (GTK+)
-  #   @param printerDC [Wx::PrinterDC]
-  #   @return [Wx::GraphicsContext]
-  # @overload self.draw_on(image)
-  #   Creates a {Wx::GraphicsContext} associated with a {Wx::Image} and passes that object to the given block.
-  #   Deletes the gc object after the block returns.
-  #   The image specifies the size of the context as well as whether alpha is supported (if {Wx::Image#has_alpha}) or not and the initial contents of the context. The image object must have a life time greater than that of the new context as the context copies its contents back to the image when it is destroyed.
-  #   @param image [Wx::Image]
-  #   @return [Wx::GraphicsContext]
-  # @overload self.draw_on()
-  #   Create a lightweight context that can be used only for measuring text and passes that object to the given block.
-  #   Deletes the gc object after the block returns.
-  #   @return [Wx::GraphicsContext]
-  def self.draw_on(*args) end
+
+module Wx
+
+  class GraphicsContext
+
+    # @overload self.draw_on(window)
+    #   Creates a {Wx::GraphicsContext} from a {Wx::Window} and passes that object to the given block.
+    #   Deletes the gc object after the block returns.
+    #   @see Wx::GraphicsRenderer#create_context
+    #   @param window [Wx::Window]
+    #   @return [Wx::GraphicsContext]
+    # @overload self.draw_on(windowDC)
+    #   Creates a {Wx::GraphicsContext} from a {Wx::WindowDC} and passes that object to the given block.
+    #   Deletes the gc object after the block returns.
+    #   @see Wx::GraphicsRenderer#create_context
+    #   @param windowDC [Wx::WindowDC]
+    #   @return [Wx::GraphicsContext]
+    # @overload self.draw_on(memoryDC)
+    #   Creates a {Wx::GraphicsContext} from a {Wx::MemoryDC} and passes that object to the given block.
+    #   Deletes the gc object after the block returns.
+    #   @see Wx::GraphicsRenderer#create_context
+    #   @param memoryDC [Wx::MemoryDC]
+    #   @return [Wx::GraphicsContext]
+    # @overload self.draw_on(printerDC)
+    #   Creates a {Wx::GraphicsContext} from a {Wx::PrinterDC} and passes that object to the given block.
+    #   Deletes the gc object after the block returns.
+    #   Under GTK+, this will only work when using the GtkPrint printing backend which is available since GTK+ 2.10.
+    #   @see Wx::GraphicsRenderer#create_context
+    #   @see  Printing Under Unix (GTK+)
+    #   @param printerDC [Wx::PrinterDC]
+    #   @return [Wx::GraphicsContext]
+    # @overload self.draw_on(image)
+    #   Creates a {Wx::GraphicsContext} associated with a {Wx::Image} and passes that object to the given block.
+    #   Deletes the gc object after the block returns.
+    #   The image specifies the size of the context as well as whether alpha is supported (if {Wx::Image#has_alpha}) or not and the initial contents of the context. The image object must have a life time greater than that of the new context as the context copies its contents back to the image when it is destroyed.
+    #   @param image [Wx::Image]
+    #   @return [Wx::GraphicsContext]
+    # @overload self.draw_on()
+    #   Create a lightweight context that can be used only for measuring text and passes that object to the given block.
+    #   Deletes the gc object after the block returns.
+    #   @return [Wx::GraphicsContext]
+    def self.draw_on(*args) end
+
+  end
+
+  class GraphicsGradientStop
+
+    # Creates a stop with the given colour and position.
+    # @param col [Wx::Colour]  The colour of this stop. Note that the alpha component of the colour is honoured thus allowing the background colours to partially show through the gradient.
+    # @param pos [Float]  The stop position, must be in [0, 1] range with 0 being the beginning and 1 the end of the gradient.
+    # @return [Wx::GraphicsGradientStop]
+    def initialize(col=Wx::TransparentColour, pos=0.0) end
+
+  end
 
 end