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

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

@@ -6,6 +6,45 @@
 
 module Wx::HTML
 
+  # 
+  HF_TOOLBAR = 1
+  
+  # 
+  HF_CONTENTS = 2
+  
+  # 
+  HF_INDEX = 4
+  
+  # 
+  HF_SEARCH = 8
+  
+  # 
+  HF_BOOKMARKS = 16
+  
+  # 
+  HF_OPEN_FILES = 32
+  
+  # 
+  HF_PRINT = 64
+  
+  # 
+  HF_FLAT_TOOLBAR = 128
+  
+  # 
+  HF_MERGE_BOOKS = 256
+  
+  # 
+  HF_ICONS_BOOK = 512
+  
+  # 
+  HF_ICONS_BOOK_CHAPTER = 1024
+  
+  # 
+  HF_ICONS_FOLDER = 0
+  
+  # 
+  HF_DEFAULT_STYLE = 95
+  
   # 
   ID_HTML_HELPFRAME = 6000
   
@@ -49,7 +88,7 @@ module Wx::HTML
   # 
   # Category:  {Wx::HELP}, {Wx::HTML}
   # @see wxBestHelpController
-  # @see  Wx::HTML::HtmlHelpFrame
+  # @see  Wx::HtmlHelpFrame
   # @see  Wx::HtmlHelpDialog
   # @see  Wx::HTML::HtmlHelpWindow
   # @see  Wx::HtmlModalHelp 
@@ -57,30 +96,30 @@ module Wx::HTML
   # 
   class HtmlHelpController < Object
   
-    # @overload initialize(style=Wx::HTML::HF_DEFAULT_STYLE, parentWindow=nil)
+    # @overload initialize(style=Wx::HF_DEFAULT_STYLE, parentWindow=nil)
     #   Constructor.
     #   @param style [Integer]  This is a combination of these flags:
     #     
-    #     - {Wx::HTML::HF_TOOLBAR}: The help window has a toolbar.
-    #     - {Wx::HTML::HF_FLAT_TOOLBAR}: The help window has a toolbar with flat buttons (aka coolbar).
-    #     - {Wx::HTML::HF_CONTENTS}: The help window has a contents panel.
-    #     - {Wx::HTML::HF_INDEX}: The help window has an index panel.
-    #     - {Wx::HTML::HF_SEARCH}: The help window has a search panel.
-    #     - {Wx::HTML::HF_BOOKMARKS}: The help window has bookmarks controls.
-    #     - {Wx::HTML::HF_OPEN_FILES}: Allows user to open arbitrary HTML document.
-    #     - {Wx::HTML::HF_PRINT}: The toolbar contains "print" button.
-    #     - {Wx::HTML::HF_MERGE_BOOKS}: The contents pane does not show book nodes. All books are merged together and appear as single book to the user.
-    #     - {Wx::HTML::HF_ICONS_BOOK}: All nodes in contents pane have a book icon. This is how Microsoft's HTML help viewer behaves.
-    #     - {Wx::HTML::HF_ICONS_FOLDER}: Book nodes in contents pane have a book icon, book's sections have a folder icon. This is the default.
-    #     - {Wx::HTML::HF_ICONS_BOOK_CHAPTER}: Both book nodes and nodes of top-level sections of a book (i.e. chapters) have a book icon, all other sections (sections, subsections, ...) have a folder icon.
+    #     - {Wx::HF_TOOLBAR}: The help window has a toolbar.
+    #     - {Wx::HF_FLAT_TOOLBAR}: The help window has a toolbar with flat buttons (aka coolbar).
+    #     - {Wx::HF_CONTENTS}: The help window has a contents panel.
+    #     - {Wx::HF_INDEX}: The help window has an index panel.
+    #     - {Wx::HF_SEARCH}: The help window has a search panel.
+    #     - {Wx::HF_BOOKMARKS}: The help window has bookmarks controls.
+    #     - {Wx::HF_OPEN_FILES}: Allows user to open arbitrary HTML document.
+    #     - {Wx::HF_PRINT}: The toolbar contains "print" button.
+    #     - {Wx::HF_MERGE_BOOKS}: The contents pane does not show book nodes. All books are merged together and appear as single book to the user.
+    #     - {Wx::HF_ICONS_BOOK}: All nodes in contents pane have a book icon. This is how Microsoft's HTML help viewer behaves.
+    #     - {Wx::HF_ICONS_FOLDER}: Book nodes in contents pane have a book icon, book's sections have a folder icon. This is the default.
+    #     - {Wx::HF_ICONS_BOOK_CHAPTER}: Both book nodes and nodes of top-level sections of a book (i.e. chapters) have a book icon, all other sections (sections, subsections, ...) have a folder icon.
     #     - {Wx::HTML::HF_EMBEDDED}: Specifies that the help controller controls an embedded window of class {Wx::HTML::HtmlHelpWindow} that should not be destroyed when the controller is destroyed.
     #     - {Wx::HTML::HF_DIALOG}: Specifies that the help controller should create a dialog containing the help window.
     #     - {Wx::HTML::HF_FRAME}: Specifies that the help controller should create a frame containing the help window. This is the default if neither {Wx::HTML::HF_DIALOG} nor {Wx::HTML::HF_EMBEDDED} is specified.
     #     - {Wx::HTML::HF_MODAL}: Specifies that the help controller should create a modal dialog containing the help window (used with the {Wx::HTML::HF_DIALOG} style).
-    #     - {Wx::HTML::HF_DEFAULT_STYLE}: {Wx::HTML::HF_TOOLBAR} | {Wx::HTML::HF_CONTENTS} | {Wx::HTML::HF_INDEX} | {Wx::HTML::HF_SEARCH} | {Wx::HTML::HF_BOOKMARKS} | {Wx::HTML::HF_PRINT}
+    #     - {Wx::HF_DEFAULT_STYLE}: {Wx::HF_TOOLBAR} | {Wx::HF_CONTENTS} | {Wx::HF_INDEX} | {Wx::HF_SEARCH} | {Wx::HF_BOOKMARKS} | {Wx::HF_PRINT}
     #   @param parentWindow [Wx::Window]  This is an optional window to be used as the parent for the help window.
     #   @return [Wx::HTML::HtmlHelpController]
-    # @overload initialize(parentWindow, style=Wx::HTML::HF_DEFAULT_STYLE)
+    # @overload initialize(parentWindow, style=Wx::HF_DEFAULT_STYLE)
     #   @param parentWindow [Wx::Window] 
     #   @param style [Integer] 
     #   @return [Wx::HTML::HtmlHelpController]
@@ -90,20 +129,20 @@ module Wx::HTML
     #   Adds a book (i.e.
     #   a .hhp file; an HTML Help Workshop project file) into the list of loaded books.
     #   This must be called at least once before displaying any help. bookFile or bookUrl may be either <code>".hhp"</code> file or a ZIP archive that contains an arbitrary number of <code>".hhp"</code> files in its top-level directory. This ZIP archive must have <code>".zip"</code> or <code>".htb"</code> extension (the latter stands for "HTML book"). In other words, 
-    #   ```
-    #     AddBook(wxFileName("help.zip"))
+    #   ```ruby
+    #     add_book('help.zip')
     #   ```
     #    is possible and is the recommended way.
-    #   @param bookFile [Wx::FileName]  Help book filename. It is recommended to use this prototype instead of the one taking URL, because it is less error-prone.
-    #   @param showWaitMsg [true,false]  If true then a decoration-less window with progress message is displayed.
-    #   @return [true,false]
+    #   @param bookFile [String]  Help book filename. It is recommended to use this prototype instead of the one taking URL, because it is less error-prone.
+    #   @param showWaitMsg [Boolean]  If true then a decoration-less window with progress message is displayed.
+    #   @return [Boolean]
     # @overload add_book(bookUrl, showWaitMsg=false)
     #   Adds a book (i.e.
     #   a .hhp file; an HTML Help Workshop project file) into the list of loaded books.
     #   See the other overload for additional info.
     #   @param bookUrl [String]  Help book URL (note that syntax of filename and URL is different on most platforms).
-    #   @param showWaitMsg [true,false]  If true then a decoration-less window with progress message is displayed.
-    #   @return [true,false]
+    #   @param showWaitMsg [Boolean]  If true then a decoration-less window with progress message is displayed.
+    #   @return [Boolean]
     def add_book(*args) end
     
     # @overload display(x)
@@ -123,28 +162,28 @@ module Wx::HTML
     #   - try to find x in index (if x is for example "How To ...")
     #   - switch to Search panel and start searching
     #   @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 alternative form is used to search help contents by numeric IDs.
     #   @param id [Integer] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def display(*args) end
     
     # Displays help window and focuses contents panel.
-    # @return [true,false]
+    # @return [Boolean]
     def display_contents; end
     
     # Displays help window and focuses index panel.
-    # @return [true,false]
+    # @return [Boolean]
     def display_index; end
     
     # Displays the help window, focuses search panel and starts searching.
     # Returns true if the keyword was found. Optionally it searches through the index (mode = {Wx::HelpSearchMode::HELP_SEARCH_INDEX}), default the content (mode = {Wx::HelpSearchMode::HELP_SEARCH_ALL}).
     # {Wx::HTML::HtmlHelpController#keyword_search} searches only pages listed in <code>".hhc"</code> file(s). You should list all pages in the contents file.
     # @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 controller's setting (position of window, etc.)
@@ -156,7 +195,7 @@ module Wx::HTML
     # Sets whether the help frame should prevent application from exiting if it's the only remaining top level window.
     # 
     # @see Wx::App#set_exit_on_frame_delete
-    # @param enable [true,false]  If true, the application will not quit unless the help frame is closed. Default is false, i.e. the application does exit if only the help window remains opened.
+    # @param enable [Boolean]  If true, the application will not quit unless the help frame is closed. Default is false, i.e. the application does exit if only the help window remains opened.
     # @return [void]
     def set_should_prevent_app_exit(enable) end
     alias_method :should_prevent_app_exit=, :set_should_prevent_app_exit
@@ -178,7 +217,7 @@ module Wx::HTML
     
     # Associates the config object with the controller.
     # If there is associated config object, {Wx::HTML::HtmlHelpController} automatically reads and writes settings (including {Wx::HTML::HtmlWindow}'s settings) when needed. The only thing you must do is create {Wx::Config} object and call {Wx::HTML::HtmlHelpController#use_config}.
-    # If you do not use {Wx::HTML::HtmlHelpController#use_config}, {Wx::HTML::HtmlHelpController} will use the default {Wx::Config} object if available (for details see Wx::ConfigBase::Get and Wx::ConfigBase::Set).
+    # If you do not use {Wx::HTML::HtmlHelpController#use_config}, {Wx::HTML::HtmlHelpController} will use the default {Wx::Config} object if available (for details see {Wx::ConfigBase::Get} and {Wx::ConfigBase::Set}).
     # @param config [Wx::ConfigBase] 
     # @param rootpath [String] 
     # @return [void]
@@ -196,35 +235,23 @@ module Wx::HTML
     alias_method :help_window, :get_help_window
     
     # Set the help window to be managed by this controller.
-    # This makes it possible to have a help window that might not be in a {Wx::HTML::HtmlHelpFrame} or dialog but is embedded in some other window in the application. Be sure to use the {Wx::HTML::HF_EMBEDDED} style in this case.
+    # This makes it possible to have a help window that might not be in a {Wx::HtmlHelpFrame} or dialog but is embedded in some other window in the application. Be sure to use the {Wx::HTML::HF_EMBEDDED} style in this case.
     # @param helpWindow [Wx::HTML::HtmlHelpWindow] 
     # @return [void]
     def set_help_window(helpWindow) end
     alias_method :help_window=, :set_help_window
     
-    # Returns the current help frame.
-    # (May be NULL.)
-    # @return [Wx::HTML::HtmlHelpFrame]
-    def get_frame; end
-    alias_method :frame, :get_frame
-    
-    # Returns the current help dialog.
-    # (May be NULL.)
-    # @return [Wx::HtmlHelpDialog]
-    def get_dialog; end
-    alias_method :dialog, :get_dialog
-    
     # Displays the section as a popup window using a context id.
     # Returns false if unsuccessful or not implemented.
     # @param contextId [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def display_context_popup(contextId) end
     
     # Displays the text in a popup window, if possible.
     # Returns false if unsuccessful or not implemented.
     # @param text [String] 
     # @param pos [Array(Integer, Integer), Wx::Point] 
-    # @return [true,false]
+    # @return [Boolean]
     def display_text_popup(text, pos) end
     
     # Returns the window to be used as the parent for the help window.
@@ -237,7 +264,7 @@ module Wx::HTML
     # Does not invoke the help viewer. This must be called directly after the help instance object is created and before any attempts to communicate with the viewer.
     # You may omit the file extension and a suitable one will be chosen. For {Wx::HTML::HtmlHelpController}, the extensions zip, htb and hhp will be appended while searching for a suitable file. For WinHelp, the hlp extension is appended.
     # @param file [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def init(file) end
     
     # Overridable member called when this application's viewer is quit by the user.
@@ -252,7 +279,7 @@ module Wx::HTML
     # @param titleFormat [String] 
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param pos [Array(Integer, Integer), Wx::Point] 
-    # @param newFrameEachTime [true,false] 
+    # @param newFrameEachTime [Boolean] 
     # @return [void]
     def set_frame_parameters(titleFormat, size, pos=Wx::DEFAULT_POSITION, newFrameEachTime=false) end
     
@@ -266,10 +293,10 @@ module Wx::HTML
     # Sets detailed viewer information.
     # So far this is only relevant to {Wx::ExtHelpController}. Some examples of usage:
     # 
-    # ```
-    #   m_help.SetViewer("kdehelp");
-    #   m_help.SetViewer("gnome-help-browser");
-    #   m_help.SetViewer("netscape", wxHELP_NETSCAPE);
+    # ```ruby
+    #   @help.set_viewer('kdehelp')
+    #   @help.set_viewer('gnome-help-browser')
+    #   @help.set_viewer('netscape', Wx::HELP_NETSCAPE)
     # ```
     # 
     # Todomodernize this function with {Wx::LaunchDefaultBrowser}

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

@@ -6,7 +6,7 @@
 
 module Wx::HTML
 
-  # This class is used by {Wx::HTML::HtmlHelpController} and {Wx::HTML::HtmlHelpFrame} to access HTML help items.
+  # This class is used by {Wx::HTML::HtmlHelpController} and {Wx::HtmlHelpFrame} to access HTML help items.
   # It is internal class and should not be used directly - except for the case you're writing your own HTML help controller.
   # === 
   # 
@@ -22,7 +22,7 @@ module Wx::HTML
     # book_url is URL (not filename!) of HTML help project (hhp) or ZIP file that contains arbitrary number of .hhp projects (this zip file can have either .zip or .htb extension, htb stands for "html book").
     # Returns success.
     # @param book_url [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def add_book(book_url) end
     
     # Returns page's URL based on integer ID stored in project.

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

@@ -33,7 +33,7 @@ module Wx::HTML
   # 
   class HtmlListBox < VListBox
   
-    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::HtmlListBoxNameStr)
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::HTML_LIST_BOX_NAME_STR)
     #   Normal constructor which calls {Wx::HTML::HtmlListBox#create} internally.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -56,8 +56,8 @@ module Wx::HTML
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
-    def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::HtmlListBoxNameStr) end
+    # @return [Boolean]
+    def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::HTML_LIST_BOX_NAME_STR) end
     
     
     protected
@@ -139,9 +139,9 @@ module Wx::HTML
   # 
   class SimpleHtmlListBox < HtmlListBox
   
-    # @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)
+    # @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::SIMPLE_HTML_LIST_BOX_NAME_STR)
     #   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]
-    # @overload create(parent, id, pos, size, choices, style=Wx::HTML::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SimpleHtmlListBoxNameStr)
+    #   @return [Boolean]
+    # @overload create(parent, id, pos, size, choices, style=Wx::HTML::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SIMPLE_HTML_LIST_BOX_NAME_STR)
     #   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,10 +162,10 @@ 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)
+    # @overload initialize(parent, id, pos, size, choices, style=Wx::HTML::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SIMPLE_HTML_LIST_BOX_NAME_STR)
     #   Constructor, creating and showing the HTML list box.
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
     #   @param id [Integer]  Window identifier. A value of -1 indicates a default value.
@@ -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

@@ -108,7 +108,7 @@ module Wx::HTML
     # @overload initialize()
     #   Default ctor.
     #   @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"))
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HTML::HW_DEFAULT_STYLE, name=("HTML_WINDOW"))
     #   Constructor.
     #   The parameters are the same as Wx::Scrolled#initialize constructor.
     #   @param parent [Wx::Window] 
@@ -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

@@ -65,7 +65,7 @@ module Wx
   
     # @overload initialize()
     #   @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)
+    # @overload initialize(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HYPERLINK_CTRL_NAME_STR)
     #   Constructor.
     #   See {Wx::HyperlinkCtrl#create} for more info.
     #   @param parent [Wx::Window] 
@@ -88,8 +88,8 @@ 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]
-    def create(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HyperlinkCtrlNameStr) end
+    # @return [Boolean]
+    def create(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HYPERLINK_CTRL_NAME_STR) end
     
     # Returns the colour used to print the label of the hyperlink when the mouse is over the control.
     # @return [Wx::Colour]
@@ -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