Class: Wx::HTML::HtmlPrintout

Inherits:
Printout
  • Object
show all
Defined in:
lib/wx/doc/gen/html/html_printout.rb

Overview

This class serves as printout class for HTML documents.

Category: Wx::HTML, Printing Framework

Requires:

  • USE_PRINTING_ARCHITECTURE
  • USE_HTML

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(title = ("Wx::PRT::Printout")) ⇒ Wx::HTML::HtmlPrintout

Constructor.

Parameters:

  • title (String) (defaults to: ("Wx::PRT::Printout")) 


21
 
# File 'lib/wx/doc/gen/html/html_printout.rb', line 21

def initialize(title=("Wx::PRT::Printout")) end

Class Method Details

.add_filter(filter) ⇒ void

This method returns an undefined value.

Adds a filter to the static list of filters for Wx::HTML::HtmlPrintout.

See Wx::HTML::HtmlFilter for further information.

Parameters:



102
 
# File 'lib/wx/doc/gen/html/html_printout.rb', line 102

def self.add_filter(filter) end

Instance Method Details

#set_fonts(normal_face, fixed_face, sizes = nil) ⇒ void

This method returns an undefined value.

This function sets font sizes and faces.

See Wx::HTML::HtmlWindow#set_fonts for detailed description.

Parameters:

  • normal_face (String)
  • fixed_face (String)
  • sizes (Array(Integer,Integer,Integer,Integer,Integer,Integer,Integer), nil) (defaults to: nil) 


30
 
# File 'lib/wx/doc/gen/html/html_printout.rb', line 30

def set_fonts(normal_face, fixed_face, sizes=nil) end

#set_footer(footer, pg = Wx::HTML::PAGE_ALL) ⇒ void Also known as: footer=

This method returns an undefined value.

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

  • @USER@ is replaced with the user’s name (support for this macro was added in wxWidgets 3.2.8)

Parameters:

  • footer (String) —

    HTML text to be used as footer.

  • pg (Integer) (defaults to: Wx::HTML::PAGE_ALL) —

    one of PAGE_ODD, PAGE_EVEN and PAGE_ALL constants.



45
 
# File 'lib/wx/doc/gen/html/html_printout.rb', line 45

def set_footer(footer, pg=Wx::HTML::PAGE_ALL) end

#set_header(header, pg = Wx::HTML::PAGE_ALL) ⇒ void Also known as: header=

This method returns an undefined value.

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

  • @USER@ is replaced with the user’s name (support for this macro was added in wxWidgets 3.2.8)

Parameters:

  • header (String) —

    HTML text to be used as header.

  • pg (Integer) (defaults to: Wx::HTML::PAGE_ALL) —

    one of PAGE_ODD, PAGE_EVEN and PAGE_ALL constants.



61
 
# File 'lib/wx/doc/gen/html/html_printout.rb', line 61

def set_header(header, pg=Wx::HTML::PAGE_ALL) end

#set_html_file(htmlfile) ⇒ void Also known as: html_file=

This method returns an undefined value.

Prepare the class for printing this HTML file.

The file may be located on any virtual file system or it may be normal file.

Parameters:

  • htmlfile (String) 


69
 
# File 'lib/wx/doc/gen/html/html_printout.rb', line 69

def set_html_file(htmlfile) end

#set_html_text(html, basepath = (''), isdir = true) ⇒ void Also known as: html_text=

This method returns an undefined value.

Prepare the class for printing this HTML text.

Parameters:

  • html (String) —

    HTML text. (NOT file!)

  • basepath (String) (defaults to: ('')) —

    base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.

  • isdir (Boolean) (defaults to: true) —

    false if basepath is filename, true if it is directory name (see FileSystem for detailed explanation).



77
 
# File 'lib/wx/doc/gen/html/html_printout.rb', line 77

def set_html_text(html, basepath=(''), isdir=true) end

#set_margins(top = 25.2, bottom = 25.2, left = 25.2, right = 25.2, spaces = 5) ⇒ void #set_margins(pageSetupData) ⇒ void Also known as: margins=

Overloads:

  • #set_margins(top = 25.2, bottom = 25.2, left = 25.2, right = 25.2, spaces = 5) ⇒ void

    This method returns an undefined value.

    Sets margins in millimeters.

    Defaults to 1 inch for margins and 0.5cm for space between text and header and/or footer.

    Parameters:

    • top (Float) (defaults to: 25.2)
    • bottom (Float) (defaults to: 25.2)
    • left (Float) (defaults to: 25.2)
    • right (Float) (defaults to: 25.2)
    • spaces (Float) (defaults to: 5)
  • #set_margins(pageSetupData) ⇒ void

    This method returns an undefined value.

    Sets margins from PRT::PageSetupDialogData.

    Parameters:



94
 
# File 'lib/wx/doc/gen/html/html_printout.rb', line 94

def set_margins(*args) end