Class: Wx::HTML::HtmlPrintout
- Inherits:
-
Printout
- Object
- Printout
- Wx::HTML::HtmlPrintout
- 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
Class Method Summary collapse
-
.add_filter(filter) ⇒ void
Adds a filter to the static list of filters for HtmlPrintout.
Instance Method Summary collapse
-
#initialize(title = ("Wx::PRT::Printout")) ⇒ Wx::HTML::HtmlPrintout
constructor
Constructor.
-
#set_fonts(normal_face, fixed_face, sizes = nil) ⇒ void
This function sets font sizes and faces.
-
#set_footer(footer, pg = Wx::HTML::PAGE_ALL) ⇒ void
(also: #footer=)
Set page footer.
-
#set_header(header, pg = Wx::HTML::PAGE_ALL) ⇒ void
(also: #header=)
Set page header.
-
#set_html_file(htmlfile) ⇒ void
(also: #html_file=)
Prepare the class for printing this HTML file.
-
#set_html_text(html, basepath = (''), isdir = true) ⇒ void
(also: #html_text=)
Prepare the class for printing this HTML text.
- #set_margins(*args) ⇒ Object (also: #margins=)
Constructor Details
#initialize(title = ("Wx::PRT::Printout")) ⇒ Wx::HTML::HtmlPrintout
Constructor.
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.
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.
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:
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)
45 |
# File 'lib/wx/doc/gen/html/html_printout.rb', line 45 def (, 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)
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.
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.
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=
94 |
# File 'lib/wx/doc/gen/html/html_printout.rb', line 94 def set_margins(*args) end |