wxruby3 0.9.4-x64-mingw-ucrt → 0.9.7-x64-mingw-ucrt

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

@@ -6,150 +6,154 @@
 
 module Wx::HTML
 
-  # 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.
-  # 
-  # Category:  {Wx::HELP}, {Wx::HTML}
-  # 
-  # @wxrb_require USE_HELP,USE_HTML
-  class HtmlHelpData < Object
-  
-    # Constructor.
-    # @return [Wx::HTML::HtmlHelpData]
-    def initialize; end
-    
-    # Adds new book.
+  module Wx::HTML
+
+    # This class is used by {Wx::HTML::HtmlHelpController} and {Wx::HtmlHelpFrame} to access HTML help items.
     # 
-    # 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 [Boolean]
-    def add_book(book_url) end
-    
-    # Returns page's URL based on integer ID stored in project.
-    # @param id [Integer] 
-    # @return [String]
-    def find_page_by_id(id) end
-    
-    # Returns page's URL based on its (file)name.
-    # @param page [String] 
-    # @return [String]
-    def find_page_by_name(page) end
-    
-    # Returns array with help books info.
-    # @return [Array<Wx::HtmlBookRecord>]
-    def get_book_rec_array; end
-    alias_method :book_rec_array, :get_book_rec_array
-    
-    # Returns reference to array with contents entries.
-    # @return [Array<Wx::HtmlHelpDataItem>]
-    def get_contents_array; end
-    alias_method :contents_array, :get_contents_array
-    
-    # Returns reference to array with index entries.
-    # @return [Array<Wx::HtmlHelpDataItem>]
-    def get_index_array; end
-    alias_method :index_array, :get_index_array
-    
-    # Sets the temporary directory where binary cached versions of MS HTML Workshop files will be stored.
+    # It is internal class and should not be used directly - except for the case you're writing your own HTML help controller.
     # 
-    # (This is turned off by default and you can enable this feature by setting non-empty temp dir.)
-    # @param path [String] 
-    # @return [void]
-    def set_temp_dir(path) end
-    alias_method :temp_dir=, :set_temp_dir
-    
-  end # HtmlHelpData
-  
-  # Helper class for {Wx::HTML::HtmlHelpData}.
-  # 
-  # 
-  # 
-  # 
-  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
-  # @wxrb_require USE_HELP,USE_HTML
-  class HtmlBookRecord < ::Object
-  
-    # @param bookfile [String] 
-    # @param basepath [String] 
-    # @param title [String] 
-    # @param start [String] 
-    # @return [Wx::HTML::HtmlBookRecord]
-    def initialize(bookfile, basepath, title, start) end
-    
-    # @return [String]
-    def get_book_file; end
-    alias_method :book_file, :get_book_file
-    
-    # @return [String]
-    def get_title; end
-    alias_method :title, :get_title
-    
-    # @return [String]
-    def get_start; end
-    alias_method :start, :get_start
-    
-    # @return [String]
-    def get_base_path; end
-    alias_method :base_path, :get_base_path
-    
-    # @param start [Integer] 
-    # @param end_ [Integer] 
-    # @return [void]
-    def set_contents_range(start, end_) end
-    
-    # @return [Integer]
-    def get_contents_start; end
-    alias_method :contents_start, :get_contents_start
-    
-    # @return [Integer]
-    def get_contents_end; end
-    alias_method :contents_end, :get_contents_end
-    
-    # @param title [String] 
-    # @return [void]
-    def set_title(title) end
-    alias_method :title=, :set_title
-    
-    # @param path [String] 
-    # @return [void]
-    def set_base_path(path) end
-    alias_method :base_path=, :set_base_path
-    
-    # @param start [String] 
-    # @return [void]
-    def set_start(start) end
-    alias_method :start=, :set_start
-    
-    # @param page [String] 
-    # @return [String]
-    def get_full_path(page) end
-    alias_method :full_path, :get_full_path
-    
-  end # HtmlBookRecord
-  
-  # Helper class for {Wx::HTML::HtmlHelpData}.
-  # 
-  # 
-  # 
-  # 
-  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
-  # @wxrb_require USE_HELP,USE_HTML
-  class HtmlHelpDataItem < ::Object
-  
-    # @return [Wx::HTML::HtmlHelpDataItem]
-    def initialize; end
-    
-    # @return [String]
-    def get_full_path; end
-    alias_method :full_path, :get_full_path
-    
-    # @return [String]
-    def get_indented_name; end
-    alias_method :indented_name, :get_indented_name
+    # Category:  {Wx::HELP}, {Wx::HTML}
+    # 
+    # @wxrb_require USE_HELP,USE_HTML
+    class HtmlHelpData < Object
+    
+      # Constructor.
+      # @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 [Boolean]
+      def add_book(book_url) end
+      
+      # Returns page's URL based on integer ID stored in project.
+      # @param id [Integer] 
+      # @return [String]
+      def find_page_by_id(id) end
+      
+      # Returns page's URL based on its (file)name.
+      # @param page [String] 
+      # @return [String]
+      def find_page_by_name(page) end
+      
+      # Returns array with help books info.
+      # @return [Array<Wx::HtmlBookRecord>]
+      def get_book_rec_array; end
+      alias_method :book_rec_array, :get_book_rec_array
+      
+      # Returns reference to array with contents entries.
+      # @return [Array<Wx::HtmlHelpDataItem>]
+      def get_contents_array; end
+      alias_method :contents_array, :get_contents_array
+      
+      # Returns reference to array with index entries.
+      # @return [Array<Wx::HtmlHelpDataItem>]
+      def get_index_array; end
+      alias_method :index_array, :get_index_array
+      
+      # Sets the temporary directory where binary cached versions of MS HTML Workshop files will be stored.
+      # 
+      # (This is turned off by default and you can enable this feature by setting non-empty temp dir.)
+      # @param path [String] 
+      # @return [void]
+      def set_temp_dir(path) end
+      alias_method :temp_dir=, :set_temp_dir
+      
+    end # HtmlHelpData
+    
+    # Helper class for {Wx::HTML::HtmlHelpData}.
+    # 
+    # 
+    # 
+    # 
+    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+    # @wxrb_require USE_HELP,USE_HTML
+    class HtmlBookRecord < ::Object
+    
+      # @param bookfile [String] 
+      # @param basepath [String] 
+      # @param title [String] 
+      # @param start [String] 
+      # @return [Wx::HTML::HtmlBookRecord]
+      def initialize(bookfile, basepath, title, start) end
+      
+      # @return [String]
+      def get_book_file; end
+      alias_method :book_file, :get_book_file
+      
+      # @return [String]
+      def get_title; end
+      alias_method :title, :get_title
+      
+      # @return [String]
+      def get_start; end
+      alias_method :start, :get_start
+      
+      # @return [String]
+      def get_base_path; end
+      alias_method :base_path, :get_base_path
+      
+      # @param start [Integer] 
+      # @param end_ [Integer] 
+      # @return [void]
+      def set_contents_range(start, end_) end
+      
+      # @return [Integer]
+      def get_contents_start; end
+      alias_method :contents_start, :get_contents_start
+      
+      # @return [Integer]
+      def get_contents_end; end
+      alias_method :contents_end, :get_contents_end
+      
+      # @param title [String] 
+      # @return [void]
+      def set_title(title) end
+      alias_method :title=, :set_title
+      
+      # @param path [String] 
+      # @return [void]
+      def set_base_path(path) end
+      alias_method :base_path=, :set_base_path
+      
+      # @param start [String] 
+      # @return [void]
+      def set_start(start) end
+      alias_method :start=, :set_start
+      
+      # @param page [String] 
+      # @return [String]
+      def get_full_path(page) end
+      alias_method :full_path, :get_full_path
+      
+    end # HtmlBookRecord
+    
+    # Helper class for {Wx::HTML::HtmlHelpData}.
+    # 
+    # 
+    # 
+    # 
+    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+    # @wxrb_require USE_HELP,USE_HTML
+    class HtmlHelpDataItem < ::Object
+    
+      # @return [Wx::HTML::HtmlHelpDataItem]
+      def initialize; end
+      
+      # @return [String]
+      def get_full_path; end
+      alias_method :full_path, :get_full_path
+      
+      # @return [String]
+      def get_indented_name; end
+      alias_method :indented_name, :get_indented_name
+      
+    end # HtmlHelpDataItem
     
-  end # HtmlHelpDataItem
-  
 
-end
+    end
+
+  end