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

data/lib/wx/doc/gen/html/html_window.rb

@@ -78,17 +78,22 @@ module Wx::HTML
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::HTML::HW_SCROLLBAR_NEVER}: Never display scrollbars, not even when the page is larger than the window. 
+  # 
   # - {Wx::HTML::HW_SCROLLBAR_AUTO}: Display scrollbars only if page's size exceeds window's size. 
+  # 
   # - {Wx::HTML::HW_NO_SELECTION}: Don't allow the user to select text. 
   # 
   # === Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HTML::HtmlLinkEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_html_cell_clicked}(id, meth = nil, &block): A {Wx::HTML::HtmlCell} was clicked. 
+  # 
   # - {Wx::EvtHandler#evt_html_cell_hover}(id, meth = nil, &block): The mouse passed over a {Wx::HTML::HtmlCell}. 
+  # 
   # - {Wx::EvtHandler#evt_html_link_clicked}(id, meth = nil, &block): A {Wx::HTML::HtmlCell} which contains a hyperlink was clicked. 
   # 
   # === 
@@ -102,7 +107,7 @@ module Wx::HTML
   
     # @overload initialize()
     #   Default ctor.
-    #   @return [HtmlWindow]
+    #   @return [Wx::HTML::HtmlWindow]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HTML::HW_DEFAULT_STYLE, name=("htmlWindow"))
     #   Constructor.
     #   The parameters are the same as Wx::Scrolled#initialize constructor.
@@ -112,20 +117,20 @@ module Wx::HTML
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @param style [Integer] 
     #   @param name [String] 
-    #   @return [HtmlWindow]
+    #   @return [Wx::HTML::HtmlWindow]
     def initialize(*args) end
     
     # Appends HTML fragment to currently displayed text and refreshes the window.
     # false if an error occurred, true otherwise.
     # @param source [String]  HTML code fragment
-    # @return [true,false]
+    # @return [Boolean]
     def append_to_page(source) end
     
     # Returns pointer to the top-level container.
     # 
     # @see Cells and Containers
     # @see  Printing Framework Overview 
-    # @return [Wx::HtmlContainerCell]
+    # @return [Wx::HTML::HtmlContainerCell]
     def get_internal_representation; end
     alias_method :internal_representation, :get_internal_representation
     
@@ -146,11 +151,6 @@ module Wx::HTML
     def get_opened_page_title; end
     alias_method :opened_page_title, :get_opened_page_title
     
-    # Returns a pointer to the current parser.
-    # @return [Wx::HtmlWinParser]
-    def get_parser; end
-    alias_method :parser, :get_parser
-    
     # Returns the related frame.
     # @return [Wx::Frame]
     def get_related_frame; end
@@ -158,17 +158,17 @@ module Wx::HTML
     
     # Moves back to the previous page.
     # Only pages displayed using {Wx::HTML::HtmlWindow#load_page} are stored in history list.
-    # @return [true,false]
+    # @return [Boolean]
     def history_back; end
     
     # Returns true if it is possible to go back in the history i.e.
     # {Wx::HTML::HtmlWindow#history_back} won't fail.
-    # @return [true,false]
+    # @return [Boolean]
     def history_can_back; end
     
     # Returns true if it is possible to go forward in the history i.e.
     # {Wx::HTML::HtmlWindow#history_forward} won't fail.
-    # @return [true,false]
+    # @return [Boolean]
     def history_can_forward; end
     
     # Clears history.
@@ -177,21 +177,21 @@ module Wx::HTML
     
     # Moves to next page in history.
     # Only pages displayed using {Wx::HTML::HtmlWindow#load_page} are stored in history list.
-    # @return [true,false]
+    # @return [Boolean]
     def history_forward; end
     
     # Loads an HTML page from a file and displays it.
     # false if an error occurred, true otherwise
     # @see Wx::HTML::HtmlWindow#load_page 
     # @param filename [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def load_file(filename) end
     
     # Unlike {Wx::HTML::HtmlWindow#set_page} this function first loads the HTML page from location and then displays it.
     # false if an error occurred, true otherwise
     # @see Wx::HTML::HtmlWindow#load_file 
     # @param location [String]  The address of the document. See the wxFileSystem Overview for details on the address format and {Wx::FileSystem} for a description of how the file is opened.
-    # @return [true,false]
+    # @return [Boolean]
     def load_page(location) end
     
     # Called when an URL is being opened (either when the user clicks on a link or an image is loaded).
@@ -199,11 +199,17 @@ module Wx::HTML
     # You can override {Wx::HTML::HtmlWindow#on_opening_url} to selectively block some URLs (e.g. for security reasons) or to redirect them elsewhere. Default behaviour is to always return {Wx::HTML::HtmlOpeningStatus::HTML_OPEN}.
     # 
     # The return value is:
-    # - {Wx::HTML::HtmlOpeningStatus::HTML_OPEN}: Open the URL.- {Wx::HTML::HtmlOpeningStatus::HTML_BLOCK}: Deny access to the URL, Wx::HtmlParser::OpenURL will return NULL.- {Wx::HTML::HtmlOpeningStatus::HTML_REDIRECT}: Don't open url, redirect to another URL. {Wx::HTML::HtmlWindow#on_opening_url} must fill *redirect with the new URL. {Wx::HTML::HtmlWindow#on_opening_url} will be called again on returned URL.
-    # @param type [HtmlURLType]  Indicates type of the resource. Is one of
-    #   - {Wx::HTML::HtmlURLType::HTML_URL_PAGE}: Opening a HTML page.- {Wx::HTML::HtmlURLType::HTML_URL_IMAGE}: Opening an image.- {Wx::HTML::HtmlURLType::HTML_URL_OTHER}: Opening a resource that doesn't fall into any other category.
+    # 
+    # - {Wx::HTML::HtmlOpeningStatus::HTML_OPEN}: Open the URL.
+    # - {Wx::HTML::HtmlOpeningStatus::HTML_BLOCK}: Deny access to the URL, Wx::HtmlParser::OpenURL will return NULL.
+    # - {Wx::HTML::HtmlOpeningStatus::HTML_REDIRECT}: Don't open url, redirect to another URL. {Wx::HTML::HtmlWindow#on_opening_url} must fill *redirect with the new URL. {Wx::HTML::HtmlWindow#on_opening_url} will be called again on returned URL.
+    # @param type [Wx::HtmlURLType]  Indicates type of the resource. Is one of
+    #   
+    #   - {Wx::HTML::HtmlURLType::HTML_URL_PAGE}: Opening a HTML page.
+    #   - {Wx::HTML::HtmlURLType::HTML_URL_IMAGE}: Opening an image.
+    #   - {Wx::HTML::HtmlURLType::HTML_URL_OTHER}: Opening a resource that doesn't fall into any other category.
     # @param url [String]  URL being opened.
-    # @return [HtmlOpeningStatus]
+    # @return [Wx::HtmlOpeningStatus]
     def on_opening_url(type, url) end
     
     # Called on parsing <TITLE> tag.
@@ -273,15 +279,15 @@ module Wx::HTML
     alias_method :standard_fonts=, :set_standard_fonts
     
     # Sets the source of a page and displays it, for example:
-    # ```
-    #   htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
+    # ```ruby
+    #   htmlwin.set_page('<html><body>Hello, world!</body></html>')
     # ```
     # 
     # If you want to load a document from some location use {Wx::HTML::HtmlWindow#load_page} instead.
     # 
     # false if an error occurred, true otherwise.
     # @param source [String]  The HTML to be displayed.
-    # @return [true,false]
+    # @return [Boolean]
     def set_page(source) end
     alias_method :page=, :set_page
     
@@ -328,18 +334,18 @@ module Wx::HTML
     # ```
     # 
     # The plain text filter will be used if no other filter matches.
-    # @param filter [Wx::HtmlFilter] 
+    # @param filter [Wx::HTML::HtmlFilter] 
     # @return [void]
     def self.add_filter(filter) end
     
     # Retrieves the default cursor for a given HTMLCursor type.
-    # @param type [HTMLCursor]  HTMLCursor type to retrieve.
+    # @param type [Integer]  HTMLCursor type to retrieve.
     # @return [Wx::Cursor]
     def self.get_default_html_cursor(type) end
     
     # Sets the default cursor for a given HTMLCursor type.
     # These cursors are used for all {Wx::HTML::HtmlWindow} objects by default, but can be overridden on a per-window basis.
-    # @param type [HTMLCursor]  HTMLCursor type to retrieve.
+    # @param type [Integer]  HTMLCursor type to retrieve.
     # @param cursor [Wx::Cursor]  The default cursor for the specified cursor type.
     # @return [void]
     def self.set_default_html_cursor(type, cursor) end
@@ -357,30 +363,39 @@ module Wx::HTML
   class HtmlFilter < Object
   
     # Constructor.
-    # @return [HtmlFilter]
+    # @return [Wx::HTML::HtmlFilter]
     def initialize; end
     
     # Returns true if this filter is capable of reading file file.
     # Example: 
-    # ```
-    #   bool MyFilter::CanRead(const wxFSFile& file)
-    #   {
-    #       return (file.GetMimeType() == "application/x-ugh");
-    #   }
+    # ```ruby
+    #   class MyFilter < Wx::HTML::HtmlFilter
+    #     # ...
+    # 
+    #     def can_read(file)
+    #       file.get_mime_type == 'application/x-ugh'
+    #     end
+    # 
+    #     # ...
+    #   end
     # ```
     # @param file [Wx::FSFile] 
-    # @return [true,false]
+    # @return [Boolean]
     def can_read(file) end
     alias_method :can_read?, :can_read
     
     # Reads the file and returns string with HTML document.
     # Example: 
-    # ```
-    #   wxString MyImgFilter::ReadFile(const wxFSFile& file)
-    #   {
-    #       return "<html><body><img src=\"" + file.GetLocation() +
-    #              "\"></body></html>";
-    #   }
+    # ```ruby
+    #   class MyFilter < Wx::HTML::HtmlFilter
+    #     # ...
+    # 
+    #     def read_file(file)
+    #       '<html><body><img src="' + file.get_location + '"></body></html>'
+    #     end
+    # 
+    #     # ...
+    #   end
     # ```
     # @param file [Wx::FSFile] 
     # @return [String]

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

@@ -32,25 +32,30 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::HL_ALIGN_LEFT}: Align the text to the left. 
+  # 
   # - {Wx::HL_ALIGN_RIGHT}: Align the text to the right. This style is not supported under Windows. 
+  # 
   # - {Wx::HL_ALIGN_CENTRE}: Center the text (horizontally). This style is not supported under Windows. 
+  # 
   # - {Wx::HL_CONTEXTMENU}: Pop up a context menu when the hyperlink is right-clicked. The context menu contains a "Copy URL" menu item which is automatically handled by the hyperlink and which just copies in the clipboard the URL (not the label) of the control. 
+  # 
   # - {Wx::HL_DEFAULT_STYLE}: The default style for {Wx::HyperlinkCtrl}: {Wx::Border::BORDER_NONE}|{Wx::HL_CONTEXTMENU}|{Wx::HL_ALIGN_CENTRE}. 
   # 
   # === Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HyperlinkEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_hyperlink}(id, meth = nil, &block): The hyperlink was (left) clicked. If this event is not handled in user's code (or it's skipped; see {Wx::Event#skip}), then a call to {Wx::LaunchDefaultBrowser} is done with the hyperlink's URL. 
   # 
-  # Currently this class is implemented using native support in {Wx::GTK} and {Wx::MSW} and a generic version is used by the other ports.
+  # Currently this class is implemented using native support in wxGTK and wxMSW and a generic version is used by the other ports.
   # === 
   # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
-  #   </td><td> {Wx::GTK} Appearance
-  #   </td><td> {Wx::OSX} 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::URL
   # @see  Wx::HyperlinkEvent 
@@ -59,7 +64,7 @@ module Wx
   class HyperlinkCtrl < Control
   
     # @overload initialize()
-    #   @return [HyperlinkCtrl]
+    #   @return [Wx::HyperlinkCtrl]
     # @overload initialize(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HyperlinkCtrlNameStr)
     #   Constructor.
     #   See {Wx::HyperlinkCtrl#create} for more info.
@@ -71,7 +76,7 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @param style [Integer] 
     #   @param name [String] 
-    #   @return [HyperlinkCtrl]
+    #   @return [Wx::HyperlinkCtrl]
     def initialize(*args) end
     
     # Creates the hyperlink control.
@@ -83,7 +88,7 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size]  Window size. If the {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
     # @param style [Integer]  Window style. See {Wx::HyperlinkCtrl}.
     # @param name [String]  Window name.
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HyperlinkCtrlNameStr) end
     
     # Returns the colour used to print the label of the hyperlink when the mouse is over the control.
@@ -102,7 +107,7 @@ module Wx
     alias_method :url, :get_url
     
     # Returns true if the hyperlink has already been clicked by the user at least one time.
-    # @return [true,false]
+    # @return [Boolean]
     def get_visited; end
     alias_method :visited, :get_visited
     
@@ -130,7 +135,7 @@ module Wx
     alias_method :url=, :set_url
     
     # Marks the hyperlink as visited (see {Wx::HyperlinkCtrl#set_visited_colour}).
-    # @param visited [true,false] 
+    # @param visited [Boolean] 
     # @return [void]
     def set_visited(visited=true) end
     alias_method :visited=, :set_visited

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

@@ -11,6 +11,7 @@ module Wx
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HyperlinkEvent} events.
   # Event handler methods:
+  # 
   # - {Wx::EvtHandler#evt_hyperlink}(id, meth = nil, &block): User clicked on a hyperlink. 
   # 
   # === 
@@ -23,7 +24,7 @@ module Wx
     # @param generator [Wx::Object] 
     # @param id [Integer] 
     # @param url [String] 
-    # @return [HyperlinkEvent]
+    # @return [Wx::HyperlinkEvent]
     def initialize(generator, id, url) end
     
     # Returns the URL of the hyperlink where the user has just clicked.

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

@@ -39,33 +39,33 @@ module Wx
     # @overload initialize()
     #   Default ctor.
     #   Constructs an icon object with no data; an assignment or another member function such as {Wx::Icon#load_file} must be called subsequently.
-    #   @return [Icon]
+    #   @return [Wx::Icon]
     # @overload initialize(icon)
     #   Copy ctor.
     #   @param icon [Wx::Icon] 
-    #   @return [Icon]
+    #   @return [Wx::Icon]
     # @overload initialize(name, type=Wx::ICON_DEFAULT_TYPE, desiredWidth=-1, desiredHeight=-1)
     #   Loads an icon from a file or resource.
     #   
     #   @see Wx::Icon#load_file 
     #   @param name [String]  This can refer to a resource name or a filename under MS Windows and X. Its meaning is determined by the type parameter.
-    #   @param type [BitmapType]  May be one of the {Wx::BitmapType} values and indicates which type of bitmap should be loaded. See the note in the class detailed description. Note that the {Wx::ICON_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the {Wx::icon.h} header for the value it takes for a specific port.
+    #   @param type [Wx::BitmapType]  May be one of the {Wx::BitmapType} values and indicates which type of bitmap should be loaded. See the note in the class detailed description. Note that the {Wx::ICON_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the {Wx::icon.h} header for the value it takes for a specific port.
     #   @param desiredWidth [Integer]  Specifies the desired width of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
     #   @param desiredHeight [Integer]  Specifies the desired height of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
-    #   @return [Icon]
+    #   @return [Wx::Icon]
     # @overload initialize(loc)
     #   Loads an icon from the specified location.
     #   @param loc [Wx::IconLocation] 
-    #   @return [Icon]
+    #   @return [Wx::Icon]
     def initialize(*args) end
     
     # Attach a Windows icon handle.
-    # This {Wx::MSW}-specific method allows assigning a native Windows HICON (which must be cast to WXHICON opaque handle type) to {Wx::Icon}. Notice that this means that the HICON will be destroyed by {Wx::Icon} when it is destroyed.
+    # This wxMSW-specific method allows assigning a native Windows HICON (which must be cast to WXHICON opaque handle type) to {Wx::Icon}. Notice that this means that the HICON will be destroyed by {Wx::Icon} when it is destroyed.
     # true if successful.
     # 
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @param icon [WXHICON] 
-    # @return [true,false]
+    # @return [Boolean]
     def create_from_hicon(icon) end
     
     # Copies bmp bitmap to this icon.
@@ -129,17 +129,17 @@ module Wx
     alias_method :width, :get_width
     
     # Returns true if icon data is present.
-    # @return [true,false]
+    # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok
     
     # Loads an icon from a file or resource.
     # true if the operation succeeded, false otherwise.
     # @param name [String]  Either a filename or a Windows resource name. The meaning of name is determined by the type parameter.
-    # @param type [BitmapType]  One of the {Wx::BitmapType} values; see the note in the class detailed description. Note that the {Wx::ICON_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the {Wx::icon.h} header for the value it takes for a specific port.
+    # @param type [Wx::BitmapType]  One of the {Wx::BitmapType} values; see the note in the class detailed description. Note that the {Wx::ICON_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the {Wx::icon.h} header for the value it takes for a specific port.
     # @param desiredWidth [Integer]  Specifies the desired width of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
     # @param desiredHeight [Integer]  Specifies the desired height of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
-    # @return [true,false]
+    # @return [Boolean]
     def load_file(name, type=Wx::ICON_DEFAULT_TYPE, desiredWidth=-1, desiredHeight=-1) end
     
   end # Icon
@@ -169,53 +169,53 @@ module Wx
     
     # @overload initialize()
     #   Default ctor.
-    #   @return [IconBundle]
+    #   @return [Wx::IconBundle]
     # @overload initialize(file, type=Wx::BitmapType::BITMAP_TYPE_ANY)
     #   Initializes the bundle with the icon(s) found in the file.
     #   @param file [String] 
-    #   @param type [BitmapType] 
-    #   @return [IconBundle]
+    #   @param type [Wx::BitmapType] 
+    #   @return [Wx::IconBundle]
     # @overload initialize(stream, type=Wx::BitmapType::BITMAP_TYPE_ANY)
     #   Initializes the bundle with the icon(s) found in the stream.
     #   Notice that the stream must be seekable, at least if it contains more than one icon. The stream pointer is positioned after the last icon read from the stream when this function returns.
     #   @param stream [IO,Wx::InputStream] 
-    #   @param type [BitmapType] 
-    #   @return [IconBundle]
+    #   @param type [Wx::BitmapType] 
+    #   @return [Wx::IconBundle]
     # @overload initialize(icon)
     #   Initializes the bundle with a single icon.
     #   @param icon [Wx::Icon] 
-    #   @return [IconBundle]
+    #   @return [Wx::IconBundle]
     # @overload initialize(resourceName, module_)
     #   Initializes the bundle with all sizes of a group icon with resourceName stored as an MS Windows resource in module.
     #   When module is 0, the current instance is used.
     #   
-    #   Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    #   Availability:  only available for the wxMSW port.  {Wx::msw}
     #   @see AddIcon(const wxString&
     #   @see  WXHINSTANCE)
     #   @param resourceName [String] 
     #   @param module_ [WXHINSTANCE] 
-    #   @return [IconBundle]
+    #   @return [Wx::IconBundle]
     # @overload initialize(ic)
     #   Copy constructor.
     #   @param ic [Wx::IconBundle] 
-    #   @return [IconBundle]
+    #   @return [Wx::IconBundle]
     def initialize(*args) end
     
     # @overload add_icon(file, type=Wx::BitmapType::BITMAP_TYPE_ANY)
     #   Adds all the icons contained in the file to the bundle; if the collection already contains icons with the same width and height, they are replaced by the new ones.
     #   @param file [String] 
-    #   @param type [BitmapType] 
+    #   @param type [Wx::BitmapType] 
     #   @return [void]
     # @overload add_icon(stream, type=Wx::BitmapType::BITMAP_TYPE_ANY)
     #   Adds all the icons contained in the stream to the bundle; if the collection already contains icons with the same width and height, they are replaced by the new ones.
     #   Notice that, as well as in the constructor loading the icon bundle from stream, the stream must be seekable, at least if more than one icon is to be loaded from it.
     #   @param stream [IO,Wx::InputStream] 
-    #   @param type [BitmapType] 
+    #   @param type [Wx::BitmapType] 
     #   @return [void]
     # @overload add_icon(resourceName, module_)
     #   Loads all sizes of a group icon with resourceName stored as an MS Windows resource in module.
     #   When module is 0, the current instance is used.
-    #   Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    #   Availability:  only available for the wxMSW port.  {Wx::msw}
     #   @param resourceName [String] 
     #   @param module_ [WXHINSTANCE] 
     #   @return [void]
@@ -263,7 +263,7 @@ module Wx
     alias_method :icon_by_index, :get_icon_by_index
     
     # Returns true if the bundle doesn't contain any icons, false otherwise (in which case a call to {Wx::IconBundle#get_icon} with default parameter should return a valid icon).
-    # @return [true,false]
+    # @return [Boolean]
     def is_empty; end
     alias_method :empty?, :is_empty
     

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

@@ -21,7 +21,7 @@ module Wx
   class IconLocation < ::Object
   
     # Returns true if the object is valid, i.e. was properly initialized, and false otherwise.
-    # @return [true,false]
+    # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok