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

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

@@ -0,0 +1,131 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  HD_ALLOW_REORDER = 1
+  
+  # 
+  # 
+  HD_ALLOW_HIDE = 2
+  
+  # 
+  # 
+  HD_BITMAP_ON_RIGHT = 4
+  
+  # 
+  # 
+  HD_DEFAULT_STYLE = 1
+  
+  # 
+  # 
+  EVT_HEADER_CLICK = 10157
+  
+  # 
+  # 
+  EVT_HEADER_RIGHT_CLICK = 10158
+  
+  # 
+  # 
+  EVT_HEADER_MIDDLE_CLICK = 10159
+  
+  # 
+  # 
+  EVT_HEADER_DCLICK = 10160
+  
+  # 
+  # 
+  EVT_HEADER_RIGHT_DCLICK = 10161
+  
+  # 
+  # 
+  EVT_HEADER_MIDDLE_DCLICK = 10162
+  
+  # 
+  # 
+  EVT_HEADER_SEPARATOR_DCLICK = 10163
+  
+  # 
+  # 
+  EVT_HEADER_BEGIN_RESIZE = 10164
+  
+  # 
+  # 
+  EVT_HEADER_RESIZING = 10165
+  
+  # 
+  # 
+  EVT_HEADER_END_RESIZE = 10166
+  
+  # 
+  # 
+  EVT_HEADER_BEGIN_REORDER = 10167
+  
+  # 
+  # 
+  EVT_HEADER_END_REORDER = 10168
+  
+  # 
+  # 
+  EVT_HEADER_DRAGGING_CANCELLED = 10169
+  
+  # Event class representing the events generated by {Wx::HeaderCtrl}.
+  # === 
+  # 
+  # Category:  {Wx::Events}
+  # @see Wx::HeaderCtrl 
+  # 
+  # 
+  class HeaderCtrlEvent < NotifyEvent
+  
+    # @overload initialize(commandType=Wx::EVT_NULL, winid=0)
+    #   @param commandType [Wx::CommandLinkButton::EventType] 
+    #   @param winid [Integer] 
+    #   @return [Wx::HeaderCtrlEvent]
+    # @overload initialize(event)
+    #   @param event [Wx::HeaderCtrlEvent] 
+    #   @return [Wx::HeaderCtrlEvent]
+    def initialize(*args) end
+    
+    # Return the index of the column affected by this event.
+    # This method can be called for all header control events.
+    # @return [Integer]
+    def get_column; end
+    alias_method :column, :get_column
+    
+    # @param col [Integer] 
+    # @return [void]
+    def set_column(col) end
+    alias_method :column=, :set_column
+    
+    # Return the current width of the column.
+    # This method can only be called for the dragging events.
+    # @return [Integer]
+    def get_width; end
+    alias_method :width, :get_width
+    
+    # @param width [Integer] 
+    # @return [void]
+    def set_width(width) end
+    alias_method :width=, :set_width
+    
+    # Return the new order of the column.
+    # This method can only be called for a reorder event for which it indicates the tentative new position for the column {Wx::HeaderCtrlEvent#get_column} selected by the user. If the event is not vetoed, this will become the new column position in {Wx::HeaderCtrl#get_columns_order}.
+    # @return [Integer]
+    def get_new_order; end
+    alias_method :new_order, :get_new_order
+    
+    # @param order [Integer] 
+    # @return [void]
+    def set_new_order(order) end
+    alias_method :new_order=, :set_new_order
+    
+  end # HeaderCtrlEvent
+  
+
+end

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

@@ -59,20 +59,20 @@ module Wx
     def initialize(parentWindow=nil) end
     
     # If the help viewer is not running, runs it and displays the contents.
-    # @return [true,false]
+    # @return [Boolean]
     def display_contents; end
     
     # 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.
@@ -85,7 +85,7 @@ module Wx
     # 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
     
     # If the help viewer is not running, runs it, and searches for sections matching the given keyword.
@@ -96,8 +96,8 @@ module Wx
     # - External HTML help, simple {Wx::HTML} help: If more than one match is found, a choice of topics is displayed.
     # - {Wx::HTML::HtmlHelpController}: see {Wx::HTML::HtmlHelpController::KeywordSearch}.
     # @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
     
     # Overridable member called when this application's viewer is quit by the user.
@@ -112,7 +112,7 @@ module Wx
     # @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
     

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

@@ -52,15 +52,15 @@ module Wx
     # Shows help for the given window.
     # Override this function if the help doesn't depend on the exact position inside the window, otherwise you need to override {Wx::HelpProvider#show_help_at_point}. Returns true if help was shown, or false if no help was available for this window.
     # @param window [Wx::Window] 
-    # @return [true,false]
+    # @return [Boolean]
     def show_help(window) end
     
     # This function may be overridden to show help for the window when it should depend on the position inside the window, By default this method forwards to {Wx::HelpProvider#show_help}, so it is enough to only implement the latter if the help doesn't depend on the position.
     # true if help was shown, or false if no help was available for this window.
     # @param window [Wx::Window]  Window to show help text for.
     # @param point [Array(Integer, Integer), Wx::Point]  Coordinates of the mouse at the moment of help event emission.
-    # @param origin [Wx::HelpEvent::Origin]  Help event origin, see {Wx::HelpEvent#get_origin}.
-    # @return [true,false]
+    # @param origin [Wx::wxHelpEvent::Origin]  Help event origin, see {Wx::HelpEvent#get_origin}.
+    # @return [Boolean]
     def show_help_at_point(window, point, origin) end
     
     # Returns pointer to help provider instance.

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

@@ -176,22 +176,6 @@ module Wx::HTML
     def get_link(x=0, y=0) end
     alias_method :link, :get_link
     
-    # Returns cursor to show when mouse pointer is over the cell.
-    # 
-    # @see Wx::HTML::HtmlCell#get_mouse_cursor_at 
-    # @param window [Wx::HtmlWindowInterface]  interface to the parent HTML window
-    # @return [Wx::Cursor]
-    def get_mouse_cursor(window) end
-    alias_method :mouse_cursor, :get_mouse_cursor
-    
-    # Returns cursor to show when mouse pointer is over the specified point.
-    # This function should be overridden instead of {Wx::HTML::HtmlCell#get_mouse_cursor_at} if the cursor should depend on the exact position of the mouse in the window.
-    # @param window [Wx::HtmlWindowInterface]  interface to the parent HTML window
-    # @param rePos [Array(Integer, Integer), Wx::Point]  Position to show cursor.
-    # @return [Wx::Cursor]
-    def get_mouse_cursor_at(window, rePos) end
-    alias_method :mouse_cursor_at, :get_mouse_cursor_at
-    
     # Returns pointer to the next cell in list (see {Wx::htmlcell.h} if you're interested in details).
     # @return [Wx::HTML::HtmlCell,Wx::HTML::HtmlContainerCell]
     def get_next; end
@@ -255,7 +239,7 @@ module Wx::HTML
     
     # Converts the cell into text representation.
     # If sel != NULL then only part of the cell inside the selection is converted.
-    # @param sel [Wx::HtmlSelection] 
+    # @param sel [Wx::HTML::HtmlSelection] 
     # @return [String]
     def convert_to_text(sel) end
     
@@ -364,13 +348,6 @@ module Wx::HTML
     # @return [void]
     def insert_cell(cell) end
     
-    # Sets the container's alignment (both horizontal and vertical) according to the values stored in tag.
-    # (Tags ALIGN parameter is extracted.) In fact it is only a front-end to {Wx::HTML::HtmlContainerCell#set_align_hor} and {Wx::HTML::HtmlContainerCell#set_align_ver}.
-    # @param tag [Wx::HtmlTag] 
-    # @return [void]
-    def set_align(tag) end
-    alias_method :align=, :set_align
-    
     # Sets the container's horizontal alignment.
     # During {Wx::HTML::HtmlCell#layout} each line is aligned according to al value.
     # @param al [Integer]  new horizontal alignment. May be one of these values:
@@ -434,29 +411,75 @@ module Wx::HTML
     def set_min_height(h, align=Wx::HTML::HTML_ALIGN_TOP) end
     alias_method :min_height=, :set_min_height
     
-    # @overload set_width_float(w, units)
-    #   Sets floating width adjustment.
-    #   The normal behaviour of container is that its width is the same as the width of parent container (and thus you can have only one sub-container per line). You can change this by setting the floating width adjustment.
-    #   @param w [Integer]  Width of the container. If the value is negative it means complement to full width of parent container. E.g. 
-    #     ```
-    #       SetWidthFloat(-50, wxHTML_UNITS_PIXELS) 
-    #     ```
-    #      sets the width of container to parent's width minus 50 pixels. This is useful when creating tables - you can call SetWidthFloat(50) and SetWidthFloat(-50).
-    #   @param units [Integer]  Units of w This parameter affects the interpretation of value.
-    #     
-    #     - {Wx::HTML::HTML_UNITS_PIXELS}: w is number of pixels
-    #     - {Wx::HTML::HTML_UNITS_PERCENT}: w is interpreted as percents of width of parent container
+  end # HtmlContainerCell
+  
+  # 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class HtmlSelection < ::Object
+  
+    # @return [Wx::HTML::HtmlSelection]
+    def initialize; end
+    
+    # @overload set(fromPos, fromCell, toPos, toCell)
+    #   @param fromPos [Array(Integer, Integer), Wx::Point] 
+    #   @param fromCell [Wx::HTML::HtmlCell] 
+    #   @param toPos [Array(Integer, Integer), Wx::Point] 
+    #   @param toCell [Wx::HTML::HtmlCell] 
     #   @return [void]
-    # @overload set_width_float(tag, pixel_scale=1.0)
-    #   Sets floating width adjustment.
-    #   The normal behaviour of container is that its width is the same as the width of parent container (and thus you can have only one sub-container per line). You can change this by setting the floating width adjustment.
-    #   @param tag [Wx::HtmlTag]  In the second version of method, w and units info is extracted from tag's WIDTH parameter.
-    #   @param pixel_scale [Float]  This is number of real pixels that equals to 1 HTML pixel.
+    # @overload set(fromCell, toCell)
+    #   @param fromCell [Wx::HTML::HtmlCell] 
+    #   @param toCell [Wx::HTML::HtmlCell] 
     #   @return [void]
-    def set_width_float(*args) end
-    alias_method :width_float=, :set_width_float
+    def set(*args) end
     
-  end # HtmlContainerCell
+    # @return [Wx::HTML::HtmlCell]
+    def get_from_cell; end
+    alias_method :from_cell, :get_from_cell
+    
+    # @return [Wx::HTML::HtmlCell]
+    def get_to_cell; end
+    alias_method :to_cell, :get_to_cell
+    
+    # @return [Wx::Point]
+    def get_from_pos; end
+    alias_method :from_pos, :get_from_pos
+    
+    # @return [Wx::Point]
+    def get_to_pos; end
+    alias_method :to_pos, :get_to_pos
+    
+    # @return [void]
+    def clear_from_to_character_pos; end
+    
+    # @return [Boolean]
+    def are_from_to_character_pos_set; end
+    
+    # @param pos [Integer] 
+    # @return [void]
+    def set_from_character_pos(pos) end
+    alias_method :from_character_pos=, :set_from_character_pos
+    
+    # @param pos [Integer] 
+    # @return [void]
+    def set_to_character_pos(pos) end
+    alias_method :to_character_pos=, :set_to_character_pos
+    
+    # @return [Integer]
+    def get_from_character_pos; end
+    alias_method :from_character_pos, :get_from_character_pos
+    
+    # @return [Integer]
+    def get_to_character_pos; end
+    alias_method :to_character_pos, :get_to_character_pos
+    
+    # @return [Boolean]
+    def is_empty; end
+    alias_method :empty?, :is_empty
+    
+  end # HtmlSelection
   
 
 end

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

@@ -23,7 +23,7 @@ module Wx::HTML
   class HtmlCellEvent < CommandEvent
   
     # The constructor is not normally used by the user code.
-    # @param commandType [Wx::AUI::AuiMDIChildFrame::EventType] 
+    # @param commandType [Wx::CommandLinkButton::EventType] 
     # @param id [Integer] 
     # @param cell [Wx::HTML::HtmlCell] 
     # @param point [Array(Integer, Integer), Wx::Point] 
@@ -37,7 +37,7 @@ module Wx::HTML
     alias_method :cell, :get_cell
     
     # Returns true if SetLinkClicked(true) has previously been called; false otherwise.
-    # @return [true,false]
+    # @return [Boolean]
     def get_link_clicked; end
     alias_method :link_clicked, :get_link_clicked
     
@@ -53,7 +53,7 @@ module Wx::HTML
     
     # Call this function with linkclicked set to true if the cell which has been clicked contained a link or false otherwise (which is the default).
     # With this function the event handler can return info to the {Wx::HTML::HtmlWindow} which sent the event.
-    # @param linkclicked [true,false] 
+    # @param linkclicked [Boolean] 
     # @return [void]
     def set_link_clicked(linkclicked) end
     alias_method :link_clicked=, :set_link_clicked

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

@@ -85,27 +85,27 @@ module Wx::HTML
     # Preview HTML file.
     # Returns false in case of error  call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
     # @param htmlfile [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def preview_file(htmlfile) end
     
     # Preview HTML text (not file!).
     # Returns false in case of error  call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
     # @param htmltext [String]  HTML text.
     # @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.
-    # @return [true,false]
+    # @return [Boolean]
     def preview_text(htmltext, basepath=('')) end
     
     # Print HTML file.
     # Returns false in case of error  call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
     # @param htmlfile [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def print_file(htmlfile) end
     
     # Print HTML text (not file!).
     # Returns false in case of error  call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
     # @param htmltext [String]  HTML text.
     # @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.
-    # @return [true,false]
+    # @return [Boolean]
     def print_text(htmltext, basepath=('')) end
     
     # Sets fonts.
@@ -163,7 +163,7 @@ module Wx::HTML
     # Enable or disable showing the dialog before printing.
     # The prompt mode determines the value of the prompt parameter passed to {Wx::PRT::Printer#print} when it is called by this class.
     # Default prompt mode value is Prompt_Always.
-    # @param promptMode [PromptMode] 
+    # @param promptMode [Wx::wxHtmlEasyPrinting::PromptMode] 
     # @return [void]
     def set_prompt_mode(promptMode) end
     alias_method :prompt_mode=, :set_prompt_mode

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,30 +57,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 +90,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 +123,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 +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
@@ -178,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]
@@ -196,35 +196,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 +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.
@@ -252,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
     
@@ -266,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.
   # === 
   # 
@@ -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.