mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-31 14:15:30 +00:00
137 lines
4.0 KiB
Plaintext
137 lines
4.0 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; 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/. */
|
|
|
|
#include "nsISupports.idl"
|
|
#include "nsIPrintSettings.idl"
|
|
|
|
%{ C++
|
|
struct nsFont;
|
|
|
|
namespace mozilla {
|
|
namespace embedding {
|
|
class PrintData;
|
|
}
|
|
}
|
|
%}
|
|
|
|
interface nsIStringEnumerator;
|
|
interface nsIWebBrowserPrint;
|
|
|
|
/**
|
|
* Native types
|
|
*/
|
|
[ref] native nsNativeFontRef(nsFont);
|
|
[ref] native PrintDataRef(const mozilla::embedding::PrintData);
|
|
[ptr] native PrintDataPtr(mozilla::embedding::PrintData);
|
|
|
|
/**
|
|
* Print options interface
|
|
*
|
|
* Do not attempt to freeze this API - it still needs lots of work. Consult
|
|
* John Keiser <jkeiser@netscape.com> and Roland Mainz
|
|
* <roland.mainz@informatik.med.uni-giessen.de> for futher details.
|
|
*/
|
|
[scriptable, uuid(2ac74034-700e-40fd-8059-81d33223af58)]
|
|
|
|
interface nsIPrintOptions : nsISupports
|
|
{
|
|
/**
|
|
* Show Native Print Options dialog, this may not be supported on all platforms
|
|
*/
|
|
void ShowPrintSetupDialog(in nsIPrintSettings aThePrintSettings);
|
|
|
|
/**
|
|
* Creates a new PrintSettnigs Object
|
|
* and initializes it from prefs
|
|
*/
|
|
nsIPrintSettings CreatePrintSettings();
|
|
|
|
/**
|
|
* Get a prefixed integer pref
|
|
*/
|
|
int32_t getPrinterPrefInt(in nsIPrintSettings aPrintSettings, in wstring
|
|
aPrefName);
|
|
|
|
/**
|
|
* display Printer Job Properties dialog
|
|
*/
|
|
void displayJobProperties (in wstring aPrinter, in nsIPrintSettings
|
|
aPrintSettings, out boolean aDisplayed);
|
|
|
|
/**
|
|
* Native data constants
|
|
*/
|
|
const short kNativeDataPrintRecord = 0;
|
|
|
|
[noscript] voidPtr GetNativeData(in short aDataType);
|
|
|
|
/**
|
|
* Given some nsIPrintSettings and (optionally) an nsIWebBrowserPrint, populates
|
|
* a PrintData representing them which can be sent over IPC. Values are only
|
|
* ever read from aSettings and aWBP.
|
|
*
|
|
* @param aSettings
|
|
* An nsIPrintSettings for a print job.
|
|
* @param aWBP (optional)
|
|
* The nsIWebBrowserPrint for the print job.
|
|
* @param data
|
|
* Pointer to a pre-existing PrintData to populate.
|
|
*
|
|
* @return nsresult
|
|
*/
|
|
[noscript] void SerializeToPrintData(in nsIPrintSettings aPrintSettings,
|
|
in nsIWebBrowserPrint aWebBrowserPrint,
|
|
in PrintDataPtr data);
|
|
|
|
/**
|
|
* This function is the opposite of SerializeToPrintData, in that it takes
|
|
* a PrintData, and populates a pre-existing nsIPrintSettings with the data
|
|
* from PrintData.
|
|
*
|
|
* @param PrintData
|
|
* Printing information sent through IPC.
|
|
* @param settings
|
|
* A pre-existing nsIPrintSettings to populate with the PrintData.
|
|
*
|
|
* @return nsresult
|
|
*/
|
|
[noscript] void DeserializeToPrintSettings(in PrintDataRef data,
|
|
in nsIPrintSettings aPrintSettings);
|
|
};
|
|
|
|
[scriptable, uuid(5e738fff-404c-4c94-9189-e8f2cce93e94)]
|
|
|
|
interface nsIPrinterEnumerator : nsISupports
|
|
{
|
|
/**
|
|
* The name of the system default printer. This name should also be
|
|
* present in printerNameList below. This is not necessarily gecko's
|
|
* default printer; see nsIPrintSettingsService.defaultPrinterName
|
|
* for that.
|
|
*/
|
|
readonly attribute wstring defaultPrinterName;
|
|
|
|
/**
|
|
* Initializes certain settings from the native printer into the PrintSettings
|
|
* These settings include, but are not limited to:
|
|
* Page Orientation
|
|
* Page Size
|
|
* Number of Copies
|
|
*/
|
|
void initPrintSettingsFromPrinter(in wstring aPrinterName, in nsIPrintSettings aPrintSettings);
|
|
|
|
/**
|
|
* The list of printer names
|
|
*/
|
|
readonly attribute nsIStringEnumerator printerNameList;
|
|
|
|
/* takes printer selected and will display job properties dlg for that printer
|
|
* returns true if dialog displays
|
|
*/
|
|
void displayPropertiesDlg(in wstring aPrinter, in nsIPrintSettings aPrintSettings);
|
|
|
|
};
|
|
|