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

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

@@ -49,7 +49,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,68 +57,94 @@ 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::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_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::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 [HtmlHelpController]
-    # @overload initialize(parentWindow, style=Wx::HTML::HF_DEFAULT_STYLE)
+    #   @return [Wx::HTML::HtmlHelpController]
+    # @overload initialize(parentWindow, style=Wx::HF_DEFAULT_STYLE)
     #   @param parentWindow [Wx::Window] 
     #   @param style [Integer] 
-    #   @return [HtmlHelpController]
+    #   @return [Wx::HTML::HtmlHelpController]
     def initialize(*args) end
     
     # @overload add_book(bookFile, showWaitMsg=false)
     #   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)
     #   Displays page x.
     #   This is THE important function - it is used to display the help in application. You can specify the page in many ways:
-    #   - as direct filename of HTML document- as chapter name (from contents) or as a book name- as some word from index- even as any word (will be searched)
+    #   
+    #   - as direct filename of HTML document
+    #   - as chapter name (from contents) or as a book name
+    #   - as some word from index
+    #   - even as any word (will be searched)
     #   
     #   Looking for the page runs in these steps:
-    #   - try to locate file named x (if x is for example "doc/howto.htm")- try to open starting page of book named x- 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 ...")- switch to Search panel and start searching
+    #   
+    #   - try to locate file named x (if x is for example "doc/howto.htm")
+    #   - try to open starting page of book named x
+    #   - 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 ...")
+    #   - 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.)
@@ -130,7 +156,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
@@ -152,7 +178,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]
@@ -165,40 +191,28 @@ module Wx::HTML
     def write_customization(cfg, path=('')) end
     
     # Get the current help window.
-    # @return [Wx::HtmlHelpWindow]
+    # @return [Wx::HTML::HtmlHelpWindow]
     def get_help_window; end
     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.
-    # @param helpWindow [Wx::HtmlHelpWindow] 
+    # 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::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.
@@ -211,7 +225,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.
@@ -226,7 +240,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
     
@@ -240,10 +254,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.
   # === 
   # 
@@ -15,14 +15,14 @@ module Wx::HTML
   class HtmlHelpData < Object
   
     # Constructor.
-    # @return [HtmlHelpData]
+    # @return [Wx::HTML::HtmlHelpData]
     def initialize; end
     
     # Adds new book.
     # 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.
@@ -70,7 +70,7 @@ module Wx::HTML
     # @param basepath [String] 
     # @param title [String] 
     # @param start [String] 
-    # @return [HtmlBookRecord]
+    # @return [Wx::HTML::HtmlBookRecord]
     def initialize(bookfile, basepath, title, start) end
     
     # @return [String]
@@ -131,7 +131,7 @@ module Wx::HTML
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class HtmlHelpDataItem < ::Object
   
-    # @return [HtmlHelpDataItem]
+    # @return [Wx::HTML::HtmlHelpDataItem]
     def initialize; end
     
     # @return [String]

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.
@@ -129,9 +130,9 @@ module Wx::HTML
   class HtmlHelpWindow < Window
   
     # @overload initialize(data=nil)
-    #   @param data [Wx::HtmlHelpData] 
-    #   @return [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)
+    #   @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::HF_DEFAULT_STYLE, data=nil)
     #   Constructor.
     #   For the values of helpStyle, please see the documentation for {Wx::HTML::HtmlHelpController}.
     #   @param parent [Wx::Window] 
@@ -140,8 +141,8 @@ module Wx::HTML
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @param style [Integer] 
     #   @param helpStyle [Integer] 
-    #   @param data [Wx::HtmlHelpData] 
-    #   @return [HtmlHelpWindow]
+    #   @param data [Wx::HTML::HtmlHelpData] 
+    #   @return [Wx::HTML::HtmlHelpWindow]
     def initialize(*args) end
     
     # Creates the help window.
@@ -152,40 +153,44 @@ 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.
     #   If not found it will give the user the choice of searching books. Looking for the page runs in these steps:
-    #   - try to locate file named x (if x is for example "doc/howto.htm")- try to open starting page of book x- 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 ...")
+    #   
+    #   - try to locate file named x (if x is for example "doc/howto.htm")
+    #   - try to open starting page of book x
+    #   - 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.
-    # @return [Wx::HtmlHelpData]
+    # @return [Wx::HTML::HtmlHelpData]
     def get_data; end
     alias_method :data, :get_data
     
     # 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.
@@ -196,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 
@@ -216,11 +214,11 @@ module Wx::HTML
     # @return [void]
     def refresh_lists; end
     
-    # @return [Wx::HtmlHelpController]
+    # @return [Wx::HTML::HtmlHelpController]
     def get_controller; end
     alias_method :controller, :get_controller
     
-    # @param controller [Wx::HtmlHelpController] 
+    # @param controller [Wx::HTML::HtmlHelpController] 
     # @return [void]
     def set_controller(controller) end
     alias_method :controller=, :set_controller

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

@@ -11,6 +11,7 @@ module Wx::HTML
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HTML::HtmlLinkEvent} events.
   # Event handler methods:
+  # 
   # - {Wx::EvtHandler#evt_html_link_clicked}(id, meth = nil, &block): User clicked on a hyperlink. 
   # 
   # === 
@@ -21,12 +22,12 @@ module Wx::HTML
   
     # The constructor is not normally used by the user code.
     # @param id [Integer] 
-    # @param linkinfo [Wx::HtmlLinkInfo] 
-    # @return [HtmlLinkEvent]
+    # @param linkinfo [Wx::HTML::HtmlLinkInfo] 
+    # @return [Wx::HTML::HtmlLinkEvent]
     def initialize(id, linkinfo) end
     
     # Returns the {Wx::HTML::HtmlLinkInfo} which contains info about the cell clicked and the hyperlink it contains.
-    # @return [Wx::HtmlLinkInfo]
+    # @return [Wx::HTML::HtmlLinkInfo]
     def get_link_info; end
     alias_method :link_info, :get_link_info
     

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

@@ -18,8 +18,11 @@ module Wx::HTML
   # 
   # 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. 
   # 
   # === 
@@ -38,10 +41,10 @@ module Wx::HTML
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @param style [Integer] 
     #   @param name [String] 
-    #   @return [HtmlListBox]
+    #   @return [Wx::HTML::HtmlListBox]
     # @overload initialize()
     #   Default constructor, you must call {Wx::HTML::HtmlListBox#create} later.
-    #   @return [HtmlListBox]
+    #   @return [Wx::HTML::HtmlListBox]
     def initialize(*args) end
     
     # Creates the control and optionally sets the initial number of items in it (it may also be set or changed later with {Wx::VListBox#set_item_count}).
@@ -53,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
     
     
@@ -63,7 +66,7 @@ module Wx::HTML
     # Does nothing by default. Overloading this method is deprecated; intercept the event instead.
     # @see Wx::HTML::HtmlLinkInfo. 
     # @param n [Integer]  Index of the item containing the link.
-    # @param link [Wx::HtmlLinkInfo]  Description of the link.
+    # @param link [Wx::HTML::HtmlLinkInfo]  Description of the link.
     # @return [void]
     def on_link_clicked(n, link) end
     
@@ -107,19 +110,24 @@ module Wx::HTML
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::HTML::HLB_DEFAULT_STYLE}: The default style: {Wx::Border::BORDER_SUNKEN} 
+  # 
   # - {Wx::HTML::HLB_MULTIPLE}: Multiple-selection list: the user can toggle multiple items on and off. 
   # 
   # A {Wx::HTML::SimpleHtmlListBox} emits the same events used by {Wx::ListBox} and by {Wx::HTML::HtmlListBox}.
   # === Events emitted by this class
   # 
   # Event handler methods for events emitted by this class:
-  #  
+  # 
   # - {Wx::EvtHandler#evt_listbox}(id, meth = nil, &block): Process a {Wx::EVT_LISTBOX} event, when an item on the list is selected. See {Wx::CommandEvent}. 
+  # 
   # - {Wx::EvtHandler#evt_listbox_dclick}(id, meth = nil, &block): Process a {Wx::EVT_LISTBOX_DCLICK} event, when the listbox is double-clicked. See {Wx::CommandEvent}. 
+  # 
   # - {Wx::EvtHandler#evt_html_cell_clicked}(id, meth = nil, &block): A {Wx::HTML::HtmlCell} was clicked. See {Wx::HTML::HtmlCellEvent}. 
+  # 
   # - {Wx::EvtHandler#evt_html_cell_hover}(id, meth = nil, &block): The mouse passed over a {Wx::HTML::HtmlCell}. See {Wx::HTML::HtmlCellEvent}. 
+  # 
   # - {Wx::EvtHandler#evt_html_link_clicked}(id, meth = nil, &block): A {Wx::HTML::HtmlCell} which contains a hyperlink was clicked. See {Wx::HTML::HtmlLinkEvent} 
   # 
   # === 
@@ -133,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] 
@@ -142,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] 
@@ -154,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)
@@ -167,10 +175,10 @@ module Wx::HTML
     #   @param style [Integer]  Window style. See {Wx::HLB_}* flags.
     #   @param validator [Wx::Validator]  Window validator.
     #   @param name [String]  Window name.
-    #   @return [SimpleHtmlListBox]
+    #   @return [Wx::HTML::SimpleHtmlListBox]
     # @overload initialize()
     #   Default constructor, you must call {Wx::HTML::SimpleHtmlListBox#create} later.
-    #   @return [SimpleHtmlListBox]
+    #   @return [Wx::HTML::SimpleHtmlListBox]
     def initialize(*args) end
     
     # @overload append(item)
@@ -267,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

@@ -15,7 +15,7 @@ module Wx::HTML
   
     # Constructor.
     # @param title [String] 
-    # @return [HtmlPrintout]
+    # @return [Wx::HTML::HtmlPrintout]
     def initialize(title=("Wx::PRT::Printout")) end
     
     # This function sets font sizes and faces.
@@ -28,7 +28,12 @@ module Wx::HTML
     
     # Set page footer.
     # The following macros can be used inside it:
-    # - @DATE@ is replaced by the current date in default format- @PAGENUM@ is replaced by page number- @PAGESCNT@ is replaced by total number of pages- @TIME@ is replaced by the current time in default format- @TITLE@ is replaced with the title of the document
+    # 
+    # - @DATE@ is replaced by the current date in default format
+    # - @PAGENUM@ is replaced by page number
+    # - @PAGESCNT@ is replaced by total number of pages
+    # - @TIME@ is replaced by the current time in default format
+    # - @TITLE@ is replaced with the title of the document
     # @param footer [String]  HTML text to be used as footer.
     # @param pg [Integer]  one of {Wx::HTML::PAGE_ODD}, {Wx::HTML::PAGE_EVEN} and {Wx::HTML::PAGE_ALL} constants.
     # @return [void]
@@ -37,7 +42,12 @@ module Wx::HTML
     
     # Set page header.
     # The following macros can be used inside it:
-    # - @DATE@ is replaced by the current date in default format- @PAGENUM@ is replaced by page number- @PAGESCNT@ is replaced by total number of pages- @TIME@ is replaced by the current time in default format- @TITLE@ is replaced with the title of the document
+    # 
+    # - @DATE@ is replaced by the current date in default format
+    # - @PAGENUM@ is replaced by page number
+    # - @PAGESCNT@ is replaced by total number of pages
+    # - @TIME@ is replaced by the current time in default format
+    # - @TITLE@ is replaced with the title of the document
     # @param header [String]  HTML text to be used as header.
     # @param pg [Integer]  one of {Wx::HTML::PAGE_ODD}, {Wx::HTML::PAGE_EVEN} and {Wx::HTML::PAGE_ALL} constants.
     # @return [void]
@@ -54,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
@@ -70,14 +80,14 @@ module Wx::HTML
     #   @return [void]
     # @overload set_margins(pageSetupData)
     #   Sets margins from {Wx::PRT::PageSetupDialogData}.
-    #   @param pageSetupData [Wx::PageSetupDialogData] 
+    #   @param pageSetupData [Wx::PRT::PageSetupDialogData] 
     #   @return [void]
     def set_margins(*args) end
     alias_method :margins=, :set_margins
     
     # Adds a filter to the static list of filters for {Wx::HTML::HtmlPrintout}.
     # See {Wx::HTML::HtmlFilter} for further information.
-    # @param filter [Wx::HtmlFilter] 
+    # @param filter [Wx::HTML::HtmlFilter] 
     # @return [void]
     def self.add_filter(filter) end