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


module Wx::HTML

  # This class serves as printout class for HTML documents.
  # 
  # Category:  {Wx::HTML}, Printing Framework
  # 
  # @wxrb_require USE_PRINTING_ARCHITECTURE,USE_HTML
  class HtmlPrintout < Printout
  
    # Constructor.
    # @param title [String] 
    # @return [Wx::HTML::HtmlPrintout]
    def initialize(title=("Wx::PRT::Printout")) end
    
    # This function sets font sizes and faces.
    # 
    # See {Wx::HTML::HtmlWindow#set_fonts} for detailed description.
    # @param normal_face [String] 
    # @param fixed_face [String] 
    # @param sizes [Array(Integer,Integer,Integer,Integer,Integer,Integer,Integer), nil] 
    # @return [void]
    def set_fonts(normal_face, fixed_face, sizes=nil) end
    
    # Set page footer.
    # 
    # The following macros can be used inside it:
    # 
    # - @DATE@ is replaced by the current date in default format
    # - @PAGENUM@ is replaced by page number
    # - @PAGESCNT@ is replaced by total number of pages
    # - @TIME@ is replaced by the current time in default format
    # - @TITLE@ is replaced with the title of the document
    # @param footer [String]  HTML text to be used as footer.
    # @param pg [Integer]  one of {Wx::HTML::PAGE_ODD}, {Wx::HTML::PAGE_EVEN} and {Wx::HTML::PAGE_ALL} constants.
    # @return [void]
    def set_footer(footer, pg=Wx::HTML::PAGE_ALL) end
    alias_method :footer=, :set_footer
    
    # Set page header.
    # 
    # The following macros can be used inside it:
    # 
    # - @DATE@ is replaced by the current date in default format
    # - @PAGENUM@ is replaced by page number
    # - @PAGESCNT@ is replaced by total number of pages
    # - @TIME@ is replaced by the current time in default format
    # - @TITLE@ is replaced with the title of the document
    # @param header [String]  HTML text to be used as header.
    # @param pg [Integer]  one of {Wx::HTML::PAGE_ODD}, {Wx::HTML::PAGE_EVEN} and {Wx::HTML::PAGE_ALL} constants.
    # @return [void]
    def set_header(header, pg=Wx::HTML::PAGE_ALL) end
    alias_method :header=, :set_header
    
    # Prepare the class for printing this HTML <b>file</b>.
    # 
    # The file may be located on any virtual file system or it may be normal file.
    # @param htmlfile [String] 
    # @return [void]
    def set_html_file(htmlfile) end
    alias_method :html_file=, :set_html_file
    
    # Prepare the class for printing this HTML text.
    # @param html [String]  HTML text. (NOT file!)
    # @param basepath [String]  base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.
    # @param isdir [Boolean]  false if basepath is filename, true if it is directory name (see {Wx::FileSystem} for detailed explanation).
    # @return [void]
    def set_html_text(html, basepath=(''), isdir=true) end
    alias_method :html_text=, :set_html_text
    
    # @overload set_margins(top=25.2, bottom=25.2, left=25.2, right=25.2, spaces=5)
    #   Sets margins in millimeters.
    #   
    #   Defaults to 1 inch for margins and 0.5cm for space between text and header and/or footer.
    #   @param top [Float] 
    #   @param bottom [Float] 
    #   @param left [Float] 
    #   @param right [Float] 
    #   @param spaces [Float] 
    #   @return [void]
    # @overload set_margins(pageSetupData)
    #   Sets margins from {Wx::PRT::PageSetupDialogData}.
    #   @param pageSetupData [Wx::PRT::PageSetupDialogData] 
    #   @return [void]
    def set_margins(*args) end
    alias_method :margins=, :set_margins
    
    # Adds a filter to the static list of filters for {Wx::HTML::HtmlPrintout}.
    # 
    # See {Wx::HTML::HtmlFilter} for further information.
    # @param filter [Wx::HTML::HtmlFilter] 
    # @return [void]
    def self.add_filter(filter) end
    
  end # HtmlPrintout
  

end