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


module Wx::HTML

  # 
  HF_TOOLBAR = 1
  
  # 
  HF_CONTENTS = 2
  
  # 
  HF_INDEX = 4
  
  # 
  HF_SEARCH = 8
  
  # 
  HF_BOOKMARKS = 16
  
  # 
  HF_OPEN_FILES = 32
  
  # 
  HF_PRINT = 64
  
  # 
  HF_FLAT_TOOLBAR = 128
  
  # 
  HF_MERGE_BOOKS = 256
  
  # 
  HF_ICONS_BOOK = 512
  
  # 
  HF_ICONS_BOOK_CHAPTER = 1024
  
  # 
  HF_ICONS_FOLDER = 0
  
  # 
  HF_DEFAULT_STYLE = 95
  
  # This class is used by {Wx::HTML::HtmlHelpController} to display help.
  # It is an internal class and should not be used directly - except for the case when you're writing your own HTML help controller.
  # === 
  # 
  # Category:  {Wx::HELP}, {Wx::HTML}
  # 
  class HtmlHelpFrame < Frame
  
    # @overload initialize(data=nil)
    #   @param data [Wx::HtmlHelpData] 
    #   @return [HtmlHelpFrame]
    # @overload initialize(parent, id, title=Wx::EMPTY_STRING, style=Wx::HF_DEFAULT_STYLE, data=nil, config=nil, rootpath=Wx::EMPTY_STRING)
    #   Constructor.
    #   For the possible values of style, please see {Wx::HTML::HtmlHelpController}.
    #   @param parent [Wx::Window] 
    #   @param id [Integer] 
    #   @param title [String] 
    #   @param style [Integer] 
    #   @param data [Wx::HtmlHelpData] 
    #   @param config [Wx::ConfigBase] 
    #   @param rootpath [String] 
    #   @return [HtmlHelpFrame]
    def initialize(*args) end
    
    # You may override this virtual method to add more buttons to the help window's toolbar.
    # toolBar is a pointer to the toolbar and style is the style flag as passed to the {Wx::HTML::HtmlHelpFrame#create} method.
    # {Wx::ToolBar#realize} is called immediately after returning from this function.
    # @param toolBar [Wx::ToolBar] 
    # @param style [Integer] 
    # @return [void]
    def add_toolbar_buttons(toolBar, style) end
    
    # Creates the frame.
    # See the constructor for a description of the parameters.
    # @param parent [Wx::Window] 
    # @param id [Integer] 
    # @param title [String] 
    # @param style [Integer] 
    # @param config [Wx::ConfigBase] 
    # @param rootpath [String] 
    # @return [true,false]
    def create(parent, id, title=Wx::EMPTY_STRING, style=Wx::HF_DEFAULT_STYLE, config=nil, rootpath=Wx::EMPTY_STRING) end
    
    # Returns the help controller associated with the frame.
    # @return [Wx::HtmlHelpController]
    def get_controller; end
    alias_method :controller, :get_controller
    
    # Sets the help controller associated with the frame.
    # @param controller [Wx::HtmlHelpController] 
    # @return [void]
    def set_controller(controller) end
    alias_method :controller=, :set_controller
    
    # Sets the frame's title format.
    # format must contain exactly one "%s" (it will be replaced by the page title).
    # @param format [String] 
    # @return [void]
    def set_title_format(format) end
    alias_method :title_format=, :set_title_format
    
  end # HtmlHelpFrame
  

end