wxruby3 0.9.5-x64-mingw-ucrt → 0.9.7-x64-mingw-ucrt

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

@@ -6,232 +6,236 @@
 
 module Wx::HTML
 
-  # 
-  # 
-  ID_HTML_PANEL = 6009
-  
-  # 
-  # 
-  ID_HTML_BACK = 6010
-  
-  # 
-  # 
-  ID_HTML_FORWARD = 6011
-  
-  # 
-  # 
-  ID_HTML_UPNODE = 6012
-  
-  # 
-  # 
-  ID_HTML_UP = 6013
-  
-  # 
-  # 
-  ID_HTML_DOWN = 6014
-  
-  # 
-  # 
-  ID_HTML_PRINT = 6015
-  
-  # 
-  # 
-  ID_HTML_OPENFILE = 6016
-  
-  # 
-  # 
-  ID_HTML_OPTIONS = 6017
-  
-  # 
-  # 
-  ID_HTML_BOOKMARKSLIST = 6018
-  
-  # 
-  # 
-  ID_HTML_BOOKMARKSADD = 6019
-  
-  # 
-  # 
-  ID_HTML_BOOKMARKSREMOVE = 6020
-  
-  # 
-  # 
-  ID_HTML_TREECTRL = 6021
-  
-  # 
-  # 
-  ID_HTML_INDEXPAGE = 6022
-  
-  # 
-  # 
-  ID_HTML_INDEXLIST = 6023
-  
-  # 
-  # 
-  ID_HTML_INDEXTEXT = 6024
-  
-  # 
-  # 
-  ID_HTML_INDEXBUTTON = 6025
-  
-  # 
-  # 
-  ID_HTML_INDEXBUTTONALL = 6026
-  
-  # 
-  # 
-  ID_HTML_NOTEBOOK = 6027
-  
-  # 
-  # 
-  ID_HTML_SEARCHPAGE = 6028
-  
-  # 
-  # 
-  ID_HTML_SEARCHTEXT = 6029
-  
-  # 
-  # 
-  ID_HTML_SEARCHLIST = 6030
-  
-  # 
-  # 
-  ID_HTML_SEARCHBUTTON = 6031
-  
-  # 
-  # 
-  ID_HTML_SEARCHCHOICE = 6032
-  
-  # 
-  # 
-  ID_HTML_COUNTINFO = 6033
-  
-  # 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: 
-  # ```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.
-  # 
-  # Category:  {Wx::HELP}, {Wx::HTML}
-  # 
-  # @wxrb_require USE_HELP,USE_HTML
-  class HtmlHelpWindow < Window
-  
-    # @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::HF_DEFAULT_STYLE, data=nil)
-    #   Constructor.
-    #   
-    #   For the values of helpStyle, please see the documentation for {Wx::HTML::HtmlHelpController}.
-    #   @param parent [Wx::Window] 
-    #   @param id [Integer] 
-    #   @param pos [Array(Integer, Integer), Wx::Point] 
-    #   @param size [Array(Integer, Integer), Wx::Size] 
-    #   @param style [Integer] 
-    #   @param helpStyle [Integer] 
-    #   @param data [Wx::HTML::HtmlHelpData] 
-    #   @return [Wx::HTML::HtmlHelpWindow]
-    def initialize(*args) end
-    
-    # Creates the help window.
-    # 
-    # See the constructor for a description of the parameters.
-    # @param parent [Wx::Window] 
-    # @param id [Integer] 
-    # @param pos [Array(Integer, Integer), Wx::Point] 
-    # @param size [Array(Integer, Integer), Wx::Size] 
-    # @param style [Integer] 
-    # @param helpStyle [Integer] 
-    # @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 ...")
-    #   @param x [String] 
-    #   @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 [Boolean]
-    def display(*args) end
-    
-    # Displays contents panel.
-    # @return [Boolean]
-    def display_contents; end
-    
-    # Displays index panel.
-    # @return [Boolean]
-    def display_index; end
-    
-    # Returns the {Wx::HTML::HtmlHelpData} object, which is usually a pointer to the controller's data.
-    # @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 [Wx::HelpSearchMode] 
-    # @return [Boolean]
-    def keyword_search(keyword, mode=Wx::HelpSearchMode::HELP_SEARCH_ALL) end
-    
-    # Reads the user's settings for this window.
-    # 
-    # 
-    # @see Wx::HTML::HtmlHelpController#read_customization 
-    # @param cfg [Wx::ConfigBase] 
-    # @param path [String] 
-    # @return [void]
-    def read_customization(cfg, path=('')) end
-    
-    # Saves the user's settings for this window.
-    # 
-    # 
-    # @see Wx::HTML::HtmlHelpController#write_customization 
-    # @param cfg [Wx::ConfigBase] 
-    # @param path [String] 
-    # @return [void]
-    def write_customization(cfg, path=('')) end
-    
-    # Refresh all panels.
-    # 
-    # This is necessary if a new book was added.
-    # @return [void]
-    def refresh_lists; end
-    
-    # @return [Wx::HTML::HtmlHelpController]
-    def get_controller; end
-    alias_method :controller, :get_controller
-    
-    # @param controller [Wx::HTML::HtmlHelpController] 
-    # @return [void]
-    def set_controller(controller) end
-    alias_method :controller=, :set_controller
-    
-  end # HtmlHelpWindow
-  
+  module Wx::HTML
 
-end
+    # 
+    # 
+    ID_HTML_PANEL = 6009
+    
+    # 
+    # 
+    ID_HTML_BACK = 6010
+    
+    # 
+    # 
+    ID_HTML_FORWARD = 6011
+    
+    # 
+    # 
+    ID_HTML_UPNODE = 6012
+    
+    # 
+    # 
+    ID_HTML_UP = 6013
+    
+    # 
+    # 
+    ID_HTML_DOWN = 6014
+    
+    # 
+    # 
+    ID_HTML_PRINT = 6015
+    
+    # 
+    # 
+    ID_HTML_OPENFILE = 6016
+    
+    # 
+    # 
+    ID_HTML_OPTIONS = 6017
+    
+    # 
+    # 
+    ID_HTML_BOOKMARKSLIST = 6018
+    
+    # 
+    # 
+    ID_HTML_BOOKMARKSADD = 6019
+    
+    # 
+    # 
+    ID_HTML_BOOKMARKSREMOVE = 6020
+    
+    # 
+    # 
+    ID_HTML_TREECTRL = 6021
+    
+    # 
+    # 
+    ID_HTML_INDEXPAGE = 6022
+    
+    # 
+    # 
+    ID_HTML_INDEXLIST = 6023
+    
+    # 
+    # 
+    ID_HTML_INDEXTEXT = 6024
+    
+    # 
+    # 
+    ID_HTML_INDEXBUTTON = 6025
+    
+    # 
+    # 
+    ID_HTML_INDEXBUTTONALL = 6026
+    
+    # 
+    # 
+    ID_HTML_NOTEBOOK = 6027
+    
+    # 
+    # 
+    ID_HTML_SEARCHPAGE = 6028
+    
+    # 
+    # 
+    ID_HTML_SEARCHTEXT = 6029
+    
+    # 
+    # 
+    ID_HTML_SEARCHLIST = 6030
+    
+    # 
+    # 
+    ID_HTML_SEARCHBUTTON = 6031
+    
+    # 
+    # 
+    ID_HTML_SEARCHCHOICE = 6032
+    
+    # 
+    # 
+    ID_HTML_COUNTINFO = 6033
+    
+    # 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: 
+    # ```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.
+    # 
+    # Category:  {Wx::HELP}, {Wx::HTML}
+    # 
+    # @wxrb_require USE_HELP,USE_HTML
+    class HtmlHelpWindow < Window
+    
+      # @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::HF_DEFAULT_STYLE, data=nil)
+      #   Constructor.
+      #   
+      #   For the values of helpStyle, please see the documentation for {Wx::HTML::HtmlHelpController}.
+      #   @param parent [Wx::Window] 
+      #   @param id [Integer] 
+      #   @param pos [Array(Integer, Integer), Wx::Point] 
+      #   @param size [Array(Integer, Integer), Wx::Size] 
+      #   @param style [Integer] 
+      #   @param helpStyle [Integer] 
+      #   @param data [Wx::HTML::HtmlHelpData] 
+      #   @return [Wx::HTML::HtmlHelpWindow]
+      def initialize(*args) end
+      
+      # Creates the help window.
+      # 
+      # See the constructor for a description of the parameters.
+      # @param parent [Wx::Window] 
+      # @param id [Integer] 
+      # @param pos [Array(Integer, Integer), Wx::Point] 
+      # @param size [Array(Integer, Integer), Wx::Size] 
+      # @param style [Integer] 
+      # @param helpStyle [Integer] 
+      # @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 ...")
+      #   @param x [String] 
+      #   @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 [Boolean]
+      def display(*args) end
+      
+      # Displays contents panel.
+      # @return [Boolean]
+      def display_contents; end
+      
+      # Displays index panel.
+      # @return [Boolean]
+      def display_index; end
+      
+      # Returns the {Wx::HTML::HtmlHelpData} object, which is usually a pointer to the controller's data.
+      # @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 [Wx::HelpSearchMode] 
+      # @return [Boolean]
+      def keyword_search(keyword, mode=Wx::HelpSearchMode::HELP_SEARCH_ALL) end
+      
+      # Reads the user's settings for this window.
+      # 
+      # 
+      # @see Wx::HTML::HtmlHelpController#read_customization 
+      # @param cfg [Wx::ConfigBase] 
+      # @param path [String] 
+      # @return [void]
+      def read_customization(cfg, path=('')) end
+      
+      # Saves the user's settings for this window.
+      # 
+      # 
+      # @see Wx::HTML::HtmlHelpController#write_customization 
+      # @param cfg [Wx::ConfigBase] 
+      # @param path [String] 
+      # @return [void]
+      def write_customization(cfg, path=('')) end
+      
+      # Refresh all panels.
+      # 
+      # This is necessary if a new book was added.
+      # @return [void]
+      def refresh_lists; end
+      
+      # @return [Wx::HTML::HtmlHelpController]
+      def get_controller; end
+      alias_method :controller, :get_controller
+      
+      # @param controller [Wx::HTML::HtmlHelpController] 
+      # @return [void]
+      def set_controller(controller) end
+      alias_method :controller=, :set_controller
+      
+    end # HtmlHelpWindow
+    
+
+    end
+
+  end

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

@@ -6,32 +6,36 @@
 
 module Wx::HTML
 
-  # This event class is used for the events generated by {Wx::HTML::HtmlWindow}.
-  # 
-  # ### Events using this class
-  # 
-  # 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. 
-  # 
-  # Category:  {Wx::HTML}, {Wx::Events}
-  # 
-  # @wxrb_require USE_HTML
-  class HtmlLinkEvent < CommandEvent
-  
-    # The constructor is not normally used by the user code.
-    # @param id [Integer] 
-    # @param linkinfo [Wx::HTML::HtmlLinkInfo] 
-    # @return [Wx::HTML::HtmlLinkEvent]
-    def initialize(id, linkinfo) end
+  module Wx::HTML
+
+    # This event class is used for the events generated by {Wx::HTML::HtmlWindow}.
+    # 
+    # ### Events using this class
+    # 
+    # 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. 
+    # 
+    # Category:  {Wx::HTML}, {Wx::Events}
+    # 
+    # @wxrb_require USE_HTML
+    class HtmlLinkEvent < CommandEvent
     
-    # Returns the {Wx::HTML::HtmlLinkInfo} which contains info about the cell clicked and the hyperlink it contains.
-    # @return [Wx::HTML::HtmlLinkInfo]
-    def get_link_info; end
-    alias_method :link_info, :get_link_info
+      # The constructor is not normally used by the user code.
+      # @param id [Integer] 
+      # @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::HTML::HtmlLinkInfo]
+      def get_link_info; end
+      alias_method :link_info, :get_link_info
+      
+    end # HtmlLinkEvent
     
-  end # HtmlLinkEvent
-  
 
-end
+    end
+
+  end