mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-05 08:35:26 +00:00
107 lines
3.9 KiB
Plaintext
107 lines
3.9 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
/* Interface to the Service for gwetting the Global PrintSettings object
|
|
or a unique PrintSettings object
|
|
*/
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsIPrintSettings;
|
|
|
|
[scriptable, uuid(841387C8-72E6-484b-9296-BF6EEA80D58A)]
|
|
interface nsIPrintSettingsService : nsISupports
|
|
{
|
|
/**
|
|
* 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 attribute nsIPrintSettings globalPrintSettings;
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
*/
|
|
readonly attribute nsIPrintSettings newPrintSettings;
|
|
|
|
/**
|
|
* The name of the last printer used, or else the system default printer.
|
|
*/
|
|
readonly attribute wstring defaultPrinterName;
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
void initPrintSettingsFromPrinter(in wstring aPrinterName, in nsIPrintSettings aPrintSettings);
|
|
|
|
/**
|
|
* 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, howToEnableFrameUI, isCancelled, printFrameTypeUsage
|
|
* printFrameType, printSilent, shrinkToFit, numCopies,
|
|
* printerName
|
|
*
|
|
*/
|
|
void initPrintSettingsFromPrefs(in nsIPrintSettings aPrintSettings, in boolean aUsePrinterNamePrefix, in unsigned long aFlags);
|
|
|
|
/**
|
|
* 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
|
|
* aUsePrinterNamePrefix - indicates whether to use the printer name as a prefix
|
|
* aFlags - 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
|
|
*
|
|
*/
|
|
void savePrintSettingsToPrefs(in nsIPrintSettings aPrintSettings, in boolean aUsePrinterNamePrefix, in unsigned long aFlags);
|
|
|
|
};
|
|
|
|
%{C++
|
|
// {841387C8-72E6-484b-9296-BF6EEA80D58A}
|
|
#define NS_PRINTSETTINGSSERVICE_IID \
|
|
{0x841387c8, 0x72e6, 0x484b, { 0x92, 0x96, 0xbf, 0x6e, 0xea, 0x80, 0xd5, 0x8a}}
|
|
%}
|