# :stopdoc:
# This file is automatically generated by the WXRuby3 documentation 
# generator. Do not alter this file.
# :startdoc:


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: 
  # 
  #   // 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")));
  # 
  # 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}
  # 
  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_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::HtmlHelpData] 
    #   @return [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 [true,false]
    def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::TAB_TRAVERSAL|Wx::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 [true,false]
    # @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]
    def display(*args) end
    
    # Displays contents panel.
    # @return [true,false]
    def display_contents; end
    
    # Displays index panel.
    # @return [true,false]
    def display_index; end
    
    # Returns the {Wx::HTML::HtmlHelpData} object, which is usually a pointer to the controller's data.
    # @return [Wx::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]
    def keyword_search(keyword, mode=Wx::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=Wx::EMPTY_STRING) 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=Wx::EMPTY_STRING) 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=Wx::EMPTY_STRING) end
    
    # Refresh all panels.
    # This is necessary if a new book was added.
    # @return [void]
    def refresh_lists; end
    
    # @return [Wx::HtmlHelpController]
    def get_controller; end
    alias_method :controller, :get_controller
    
    # @param controller [Wx::HtmlHelpController] 
    # @return [void]
    def set_controller(controller) end
    alias_method :controller=, :set_controller
    
  end # HtmlHelpWindow
  

end