Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIWebBrowserPrint Interface Reference

nsIWebBrowserPrint corresponds to the main interface for printing an embedded Gecko web browser window/document More...

import "nsIWebBrowserPrint.idl";

Inheritance diagram for nsIWebBrowserPrint:
Inheritance graph
[legend]
Collaboration diagram for nsIWebBrowserPrint:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void print (in nsIPrintSettings aThePrintSettings, in nsIWebProgressListener aWPListener)
 Print the specified DOM window.
void printPreview (in nsIPrintSettings aThePrintSettings, in nsIDOMWindow aChildDOMWin, in nsIWebProgressListener aWPListener)
 Print Preview the specified DOM window.
void printPreviewNavigate (in short aNavType, in long aPageNum)
 Print Preview - Navigates within the window.
void cancel ()
 Cancels the current print.
void enumerateDocumentNames (out PRUint32 aCount,[retval, array, size_is(aCount)] out wstring aResult)
 Returns an array of the names of all documents names (Title or URL) and sub-documents.
void exitPrintPreview ()
 This exists PrintPreview mode and returns browser window to galley mode.

Public Attributes

const short PRINTPREVIEW_GOTO_PAGENUM = 0
 PrintPreview Navigation Constants.
const short PRINTPREVIEW_PREV_PAGE = 1
const short PRINTPREVIEW_NEXT_PAGE = 2
const short PRINTPREVIEW_HOME = 3
const short PRINTPREVIEW_END = 4
readonly attribute nsIPrintSettings globalPrintSettings
 Returns a "global" PrintSettings object Creates a new the first time, if one doesn't exist.
readonly attribute nsIPrintSettings currentPrintSettings
 Returns a pointer to the PrintSettings object that that was passed into either "print" or "print preview".
readonly attribute nsIDOMWindow currentChildDOMWindow
 Returns a pointer to the current child DOMWindow that is being print previewed.
readonly attribute boolean doingPrint
 Returns whether it is in Print mode.
readonly attribute boolean doingPrintPreview
 Returns whether it is in Print Preview mode.
readonly attribute boolean isFramesetDocument
 This returns whether the current document is a frameset document.
readonly attribute boolean isFramesetFrameSelected
 This returns whether the current document is a frameset document.
readonly attribute boolean isIFrameSelected
 This returns whether there is an IFrame selected.
readonly attribute boolean isRangeSelection
 This returns whether there is a "range" selection.
readonly attribute long printPreviewNumPages
 This returns the total number of pages for the Print Preview.

Detailed Description

nsIWebBrowserPrint corresponds to the main interface for printing an embedded Gecko web browser window/document

FROZEN

Definition at line 54 of file nsIWebBrowserPrint.idl.


Member Function Documentation

Cancels the current print.

Returns:
void
void nsIWebBrowserPrint::enumerateDocumentNames ( out PRUint32  aCount,
[retval, array, size_is(aCount)] out wstring  aResult 
)

Returns an array of the names of all documents names (Title or URL) and sub-documents.

This will return a single item if the attr "isFramesetDocument" is false and may return any number of items is "isFramesetDocument" is true

Parameters:
aCount- returns number of printers returned
aResult- returns array of names
Returns:
void

This exists PrintPreview mode and returns browser window to galley mode.

Returns:
void
void nsIWebBrowserPrint::print ( in nsIPrintSettings  aThePrintSettings,
in nsIWebProgressListener  aWPListener 
)

Print the specified DOM window.

Parameters:
aThePrintSettings- Printer Settings for the print job, if aThePrintSettings is null then the global PS will be used.
aWPListener- is updated during the print
Returns:
void
void nsIWebBrowserPrint::printPreview ( in nsIPrintSettings  aThePrintSettings,
in nsIDOMWindow  aChildDOMWin,
in nsIWebProgressListener  aWPListener 
)

Print Preview the specified DOM window.

Parameters:
aThePrintSettings- Printer Settings for the print preview, if aThePrintSettings is null then the global PS will be used.
aChildDOMWin- DOM Window of the child document to be PP (FrameSet frames)
aWPListener- is updated during the printpreview
Returns:
void
void nsIWebBrowserPrint::printPreviewNavigate ( in short  aNavType,
in long  aPageNum 
)

Print Preview - Navigates within the window.

Parameters:
aNavType- navigation enum
aPageNum- page num to navigate to when aNavType = ePrintPreviewGoToPageNum
Returns:
void

Member Data Documentation

Returns a pointer to the current child DOMWindow that is being print previewed.

(FrameSet Frames)

Returns null if parent document is not a frameset or the entire FrameSet document is being print previewed

This enables any consumers of the interface to have access to the "current" child DOMWindow at later points in the execution

Definition at line 94 of file nsIWebBrowserPrint.idl.

Returns a pointer to the PrintSettings object that that was passed into either "print" or "print preview".

This enables any consumers of the interface to have access to the "current" PrintSetting at later points in the execution

Definition at line 82 of file nsIWebBrowserPrint.idl.

Returns whether it is in Print mode.

Definition at line 99 of file nsIWebBrowserPrint.idl.

Returns whether it is in Print Preview mode.

Definition at line 104 of file nsIWebBrowserPrint.idl.

Returns a "global" PrintSettings object Creates a new the first time, if one doesn't exist.

Then returns the same object each time after that.

Initializes the globalPrintSettings from the default printer

Definition at line 73 of file nsIWebBrowserPrint.idl.

This returns whether the current document is a frameset document.

Definition at line 109 of file nsIWebBrowserPrint.idl.

This returns whether the current document is a frameset document.

Definition at line 114 of file nsIWebBrowserPrint.idl.

This returns whether there is an IFrame selected.

Definition at line 119 of file nsIWebBrowserPrint.idl.

This returns whether there is a "range" selection.

Definition at line 124 of file nsIWebBrowserPrint.idl.

Definition at line 63 of file nsIWebBrowserPrint.idl.

PrintPreview Navigation Constants.

Definition at line 59 of file nsIWebBrowserPrint.idl.

Definition at line 62 of file nsIWebBrowserPrint.idl.

Definition at line 61 of file nsIWebBrowserPrint.idl.

Definition at line 60 of file nsIWebBrowserPrint.idl.

This returns the total number of pages for the Print Preview.

Definition at line 129 of file nsIWebBrowserPrint.idl.


The documentation for this interface was generated from the following file: