wxruby3 1.6.1 → 1.8.0

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

@@ -0,0 +1,159 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module 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.
+      # 
+      # 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
+
+end

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

@@ -0,0 +1,258 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module HTML
+
+    # 
+    # 
+    ID_HTML_PANEL = 6010
+    
+    # 
+    # 
+    ID_HTML_BACK = 6011
+    
+    # 
+    # 
+    ID_HTML_FORWARD = 6012
+    
+    # 
+    # 
+    ID_HTML_UPNODE = 6013
+    
+    # 
+    # 
+    ID_HTML_UP = 6014
+    
+    # 
+    # 
+    ID_HTML_DOWN = 6015
+    
+    # 
+    # 
+    ID_HTML_PRINT = 6016
+    
+    # 
+    # 
+    ID_HTML_OPENFILE = 6017
+    
+    # 
+    # 
+    ID_HTML_OPTIONS = 6018
+    
+    # 
+    # 
+    ID_HTML_BOOKMARKSLIST = 6019
+    
+    # 
+    # 
+    ID_HTML_BOOKMARKSADD = 6020
+    
+    # 
+    # 
+    ID_HTML_BOOKMARKSREMOVE = 6021
+    
+    # 
+    # 
+    ID_HTML_TREECTRL = 6022
+    
+    # 
+    # 
+    ID_HTML_INDEXPAGE = 6023
+    
+    # 
+    # 
+    ID_HTML_INDEXLIST = 6024
+    
+    # 
+    # 
+    ID_HTML_INDEXTEXT = 6025
+    
+    # 
+    # 
+    ID_HTML_INDEXBUTTON = 6026
+    
+    # 
+    # 
+    ID_HTML_INDEXBUTTONALL = 6027
+    
+    # 
+    # 
+    ID_HTML_NOTEBOOK = 6028
+    
+    # 
+    # 
+    ID_HTML_SEARCHPAGE = 6029
+    
+    # 
+    # 
+    ID_HTML_SEARCHTEXT = 6030
+    
+    # 
+    # 
+    ID_HTML_SEARCHLIST = 6031
+    
+    # 
+    # 
+    ID_HTML_SEARCHBUTTON = 6032
+    
+    # 
+    # 
+    ID_HTML_SEARCHCHOICE = 6033
+    
+    # 
+    # 
+    ID_HTML_COUNTINFO = 6034
+    
+    # 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(data=nil, &block)
+      #   @param data [Wx::HTML::HtmlHelpData] 
+      #   @yieldparam [Wx::HTML::HtmlHelpWindow] win new instance
+      #   @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)
+      #   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]
+      # @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, &block)
+      #   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] 
+      #   @yieldparam [Wx::HTML::HtmlHelpWindow] win new instance
+      #   @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::HTML::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

@@ -0,0 +1,41 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module 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
+      
+      # 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
+
+end