nsIPrintSettingsService

IID:841387C8-72E6-484b-9296-BF6EEA80D58A
Inherits From:nsISupports

This interface is intended to be used as a service.

This interface is implemented by the following components:


Properties

readonly PRUnichar* defaultPrinterName

The name of the default printer

readonly nsIPrintSettings globalPrintSettings

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

readonly nsIPrintSettings newPrintSettings

Returns a new, unique PrintSettings object each time.

For example, if each browser was to have its own unique PrintSettings, then each browser window would call this to create its own unique PrintSettings object.

If each browse window was to use the same PrintSettings object then it should use "globalPrintSettings"

Initializes the newPrintSettings from the default printer


Methods

void initPrintSettingsFromPrefs ( nsIPrintSettings printSettings , PRBool usePrinterNamePrefix , PRUint32 flags ) void initPrintSettingsFromPrinter ( PRUnichar* printerName , nsIPrintSettings printSettings ) void savePrintSettingsToPrefs ( nsIPrintSettings printSettings , PRBool usePrinterNamePrefix , PRUint32 flags )

void initPrintSettingsFromPrefs ( nsIPrintSettings printSettings , PRBool usePrinterNamePrefix , PRUint32 flags )

Reads PrintSettings values from Prefs, the values to be read are indicated by the "flags" arg.

First it reads in the "generic" set of PrintSetings not associated with any printer then it uses the PrinterName in the PrinterSettings to read any settings that were saved just for that printer.

APS - PrintSettings to have its settings read usePrinterNamePrefix - indicates whether to use the printer name as a prefix flags - indicates which prefs to read, see nsIPrintSettings.idl for the const values.

Items not read: startPageRange, endPageRange, scaling, printRange, title docURL, howToEnableFrameUI, isCancelled, printFrameTypeUsage printFrameType, printSilent, shrinkToFit, numCopies

Arguments:
printSettings
usePrinterNamePrefix
flags

void initPrintSettingsFromPrinter ( PRUnichar* printerName , nsIPrintSettings printSettings )

Initializes certain settings from the native printer into the PrintSettings if printerName is null then it uses the default printer name if it can These settings include, but are not limited to: Page Orientation Page Size Number of Copies

Arguments:
printerName
printSettings

void savePrintSettingsToPrefs ( nsIPrintSettings printSettings , PRBool usePrinterNamePrefix , PRUint32 flags )

Writes PrintSettings values to Prefs, the values to be written are indicated by the "flags" arg.

If there is no PrinterName in the PrinterSettings the values are saved as the "generic" values not associated with any printer. If a PrinterName is there, then it saves the items qualified for that Printer

APS - PrintSettings to have its settings saved usePrinterNamePrefix - indicates whether to use the printer name as a prefix flags - indicates which prefs to save, see nsIPrintSettings.idl for the const values.

Items not written: startPageRange, endPageRange, scaling, printRange, title docURL, howToEnableFrameUI, isCancelled, printFrameTypeUsage printFrameType, printSilent, shrinkToFit, numCopies

Arguments:
printSettings
usePrinterNamePrefix
flags

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com