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

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

@@ -108,17 +108,18 @@ module Wx::HTML
   
   # This class is used by {Wx::HTML::HtmlHelpController} to display help within a frame or dialog, but you can use it yourself to create an embedded HTML help window.
   # For example: 
-  # ```
-  #   // m_embeddedHelpWindow is a wxHtmlHelpWindow
-  #   // m_embeddedHtmlHelp is a wxHtmlHelpController
-  #   
-  #   // Create embedded HTML Help window
-  #   m_embeddedHelpWindow = new wxHtmlHelpWindow;
-  #   m_embeddedHtmlHelp.UseConfig(config, rootPath); // Set your own config object here
-  #   m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow);
-  #   m_embeddedHelpWindow->Create(this, wxID_ANY, wxDefaultPosition, GetClientSize(),
-  #                                wxTAB_TRAVERSAL|wxBORDER_NONE, wxHF_DEFAULT_STYLE);
-  #   m_embeddedHtmlHelp.AddBook(wxFileName(wxT("doc.zip")));
+  # ```ruby
+  #   # @embeddedHelpWindow is a wxHtmlHelpWindow
+  #   # @embeddedHtmlHelp is a wxHtmlHelpController
+  #   #   
+  #   # Create embedded HTML Help window
+  #   @embeddedHelpWindow = Wx::HTML::HtmlHelpWindow.new
+  #   @embeddedHtmlHelp.use_config(config, rootPath) # Set your own config object here
+  #   @embeddedHtmlHelp.set_help_window(@embeddedHelpWindow)
+  #   @embeddedHelpWindow.create(self, Wx::ID_ANY, 
+  #                              size: get_client_size,
+  #                              style: Wx::TAB_TRAVERSAL|Wx::BORDER_NONE)
+  #   @embeddedHtmlHelp.add_book('doc.zip')
   # ```
   # 
   # You should pass the style {Wx::HTML::HF_EMBEDDED} to the style parameter of {Wx::HTML::HtmlHelpController} to allow the embedded window to be destroyed independently of the help controller.
@@ -131,7 +132,7 @@ module Wx::HTML
     # @overload initialize(data=nil)
     #   @param data [Wx::HTML::HtmlHelpData] 
     #   @return [Wx::HTML::HtmlHelpWindow]
-    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::TAB_TRAVERSAL|Wx::Border::BORDER_NONE), helpStyle=Wx::HTML::HF_DEFAULT_STYLE, data=nil)
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::TAB_TRAVERSAL|Wx::Border::BORDER_NONE), helpStyle=Wx::HF_DEFAULT_STYLE, data=nil)
     #   Constructor.
     #   For the values of helpStyle, please see the documentation for {Wx::HTML::HtmlHelpController}.
     #   @param parent [Wx::Window] 
@@ -152,8 +153,8 @@ module Wx::HTML
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param helpStyle [Integer] 
-    # @return [true,false]
-    def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::TAB_TRAVERSAL|Wx::Border::BORDER_NONE), helpStyle=Wx::HTML::HF_DEFAULT_STYLE) end
+    # @return [Boolean]
+    def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::TAB_TRAVERSAL|Wx::Border::BORDER_NONE), helpStyle=Wx::HF_DEFAULT_STYLE) end
     
     # @overload display(x)
     #   Displays page x.
@@ -164,20 +165,20 @@ module Wx::HTML
     #   - try to find x in contents (if x is for example "How To ...")
     #   - try to find x in index (if x is for example "How To ...")
     #   @param x [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload display(id)
     #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
     #   This form takes numeric ID as the parameter (uses an extension to MS format, param name="ID" value=id).
     #   @param id [Integer] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def display(*args) end
     
     # Displays contents panel.
-    # @return [true,false]
+    # @return [Boolean]
     def display_contents; end
     
     # Displays index panel.
-    # @return [true,false]
+    # @return [Boolean]
     def display_index; end
     
     # Returns the {Wx::HTML::HtmlHelpData} object, which is usually a pointer to the controller's data.
@@ -188,8 +189,8 @@ module Wx::HTML
     # Search for given keyword.
     # Optionally it searches through the index (mode = {Wx::HelpSearchMode::HELP_SEARCH_INDEX}), default the content (mode = {Wx::HelpSearchMode::HELP_SEARCH_ALL}).
     # @param keyword [String] 
-    # @param mode [HelpSearchMode] 
-    # @return [true,false]
+    # @param mode [Wx::HelpSearchMode] 
+    # @return [Boolean]
     def keyword_search(keyword, mode=Wx::HelpSearchMode::HELP_SEARCH_ALL) end
     
     # Reads the user's settings for this window.
@@ -200,13 +201,6 @@ module Wx::HTML
     # @return [void]
     def read_customization(cfg, path=('')) end
     
-    # Associates a {Wx::Config} object with the help window.
-    # It is recommended that you use {Wx::HTML::HtmlHelpController#use_config} instead.
-    # @param config [Wx::ConfigBase] 
-    # @param rootpath [String] 
-    # @return [void]
-    def use_config(config, rootpath=('')) end
-    
     # Saves the user's settings for this window.
     # 
     # @see Wx::HTML::HtmlHelpController#write_customization 

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

@@ -56,7 +56,7 @@ module Wx::HTML
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::HtmlListBoxNameStr) end
     
     
@@ -141,7 +141,7 @@ module Wx::HTML
   
     # @overload create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=Wx::HTML::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SimpleHtmlListBoxNameStr)
     #   Creates the HTML listbox for two-step construction.
-    #   See {Wx::HTML::SimpleHtmlListBox#simple_html_list_box} for further details.
+    #   See {Wx::HTML::SimpleHtmlListBox#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
     #   @param pos [Array(Integer, Integer), Wx::Point] 
@@ -150,10 +150,10 @@ module Wx::HTML
     #   @param style [Integer] 
     #   @param validator [Wx::Validator] 
     #   @param name [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload create(parent, id, pos, size, choices, style=Wx::HTML::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SimpleHtmlListBoxNameStr)
     #   Creates the HTML listbox for two-step construction.
-    #   See {Wx::HTML::SimpleHtmlListBox#simple_html_list_box} for further details.
+    #   See {Wx::HTML::SimpleHtmlListBox#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
     #   @param pos [Array(Integer, Integer), Wx::Point] 
@@ -162,7 +162,7 @@ module Wx::HTML
     #   @param style [Integer] 
     #   @param validator [Wx::Validator] 
     #   @param name [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def create(*args) end
     
     # @overload initialize(parent, id, pos, size, choices, style=Wx::HTML::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SimpleHtmlListBoxNameStr)
@@ -275,7 +275,7 @@ module Wx::HTML
     def delete(n) end
     
     # Returns true, if either untyped data (<code>void*</code>) or object data ({Wx::ClientData}*) is associated with the items of the control.
-    # @return [true,false]
+    # @return [Boolean]
     def has_client_data; end
     alias_method :has_client_data?, :has_client_data
     

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

@@ -64,7 +64,7 @@ module Wx::HTML
     # Prepare the class for printing this HTML text.
     # @param html [String]  HTML text. (NOT file!)
     # @param basepath [String]  base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.
-    # @param isdir [true,false]  false if basepath is filename, true if it is directory name (see {Wx::FileSystem} for detailed explanation).
+    # @param isdir [Boolean]  false if basepath is filename, true if it is directory name (see {Wx::FileSystem} for detailed explanation).
     # @return [void]
     def set_html_text(html, basepath=(''), isdir=true) end
     alias_method :html_text=, :set_html_text

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

@@ -123,7 +123,7 @@ module Wx::HTML
     # 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.
@@ -151,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
@@ -163,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.
@@ -182,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).
@@ -208,13 +203,13 @@ module Wx::HTML
     # - {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
+    # @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.
@@ -284,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
     
@@ -344,13 +339,13 @@ module Wx::HTML
     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
@@ -373,25 +368,34 @@ module Wx::HTML
     
     # 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

@@ -88,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.
@@ -107,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
     
@@ -135,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/icon.rb

@@ -49,7 +49,7 @@ module Wx
     #   
     #   @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 [Wx::Icon]
@@ -65,7 +65,7 @@ module Wx
     # 
     # 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
@@ -173,13 +173,13 @@ module Wx
     # @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] 
+    #   @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] 
+    #   @param type [Wx::BitmapType] 
     #   @return [Wx::IconBundle]
     # @overload initialize(icon)
     #   Initializes the bundle with a single icon.
@@ -204,13 +204,13 @@ module Wx
     # @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.
@@ -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