Interface nsIPrintSettingsServiceType

Hierarchy

Properties

defaultPrintSettingsForPrinting: nsIPrintSettings

Returns the default print settings as used for printing.

lastUsedPrinterName: string

The name of the last printer used. Note that this may not be set, or may no longer be a valid printer. The caller is responsible for checking and falling back to some other printer (such as the system default printer).

XXX: make it [infallible] when AString supports that (bug 1491187).

Methods

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

  • This function is the opposite of SerializeToPrintData, in that it takes a PrintData, and populates a pre-existing nsIPrintSettings with the data from PrintData.

    Returns

    nsresult

    Parameters

    • data: PrintDataRef
    • aPrintSettings: nsIPrintSettings

    Returns void

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

  • Given some nsIPrintSettings, populates a PrintData representing them which can be sent over IPC. Values are only ever read from aSettings and aWBP.

    Returns

    nsresult

    Parameters

    • aPrintSettings: nsIPrintSettings
    • data: PrintDataPtr

      Pointer to a pre-existing PrintData to populate.

    Returns void

  • Creates a new nsIPrintSettings object.

    Initializes the settings object from the unprefixed printer (Note: this may not happen if there is an OS specific implementation.)

    Returns nsIPrintSettings

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

    aPrintSettings should be initialized with the name of a printer. First it reads in the PrintSettings from the last print job. 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 aUsePrinterNamePrefix - indicates whether to use the printer name as a prefix aFlags - indicates which prefs to read, see nsIPrintSettings.idl for the const values.

    Items not read: startPageRange, endPageRange, scaling, printRange, title docURL, isCancelled, printSilent, shrinkToFit, numCopies, printerName

    Parameters

    • aPrintSettings: nsIPrintSettings
    • aUsePrinterNamePrefix: boolean
    • aFlags: number

    Returns void

  • Initializes certain settings from the native printer into the PrintSettings if aPrinterName 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

    Parameters

    • aPrinterName: string
    • aPrintSettings: nsIPrintSettings

    Returns void

  • As long as the pref print.save_print_settings isn't set to false, this saves the given printer name as the last used printer name.

    Parameters

    • aPrinterName: string

    Returns void

  • As long as the pref print.save_print_settings isn't set to false, this saves to prefs the settings from aPrintSettings that are indicated by aFlags.

    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 aFlags - indicates which prefs to save, see nsIPrintSettings.idl for the const values.

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

    Parameters

    • aPrintSettings: nsIPrintSettings
    • aFlags: number

    Returns void

Generated using TypeDoc