widget/public/nsIPrintOptions.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2000
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Don Cone <dcone@netscape.com>
  24  *   Jessica Blanco <jblanco@us.ibm.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsISupports.idl"
  41 #include "nsIPrintSettings.idl"
  42
  43 %{ C++
  44 struct nsFont;
  45 %}
  46
  47 interface nsIStringEnumerator;
  48
  49 /**
  50  * Native types
  51  */
  52 [ref] native nsNativeFontRef(nsFont);
  53
  54 /**
  55  * Print options interface
  56  *
  57  * Do not attempt to freeze this API - it still needs lots of work. Consult
  58  * John Keiser <jkeiser@netscape.com> and Roland Mainz
  59  * <roland.mainz@informatik.med.uni-giessen.de> for futher details.
  60  */
  61 [scriptable, uuid(92597c2b-109b-40bb-8f93-9b9acfa31de8)]
  62
  63 interface nsIPrintOptions : nsISupports
  64 {
  65   /**
  66    * Show Native Print Options dialog, this may not be supported on all platforms
  67    */
  68   void ShowPrintSetupDialog(in nsIPrintSettings aThePrintSettings);
  69
  70   /**
  71    * Creates a new PrintSettnigs Object
  72    * and initializes it from prefs
  73    */
  74   nsIPrintSettings CreatePrintSettings();
  75
  76   /**
  77    * Get a prefixed integer pref
  78    */
  79   PRInt32 getPrinterPrefInt(in nsIPrintSettings aPrintSettings, in wstring
  80                             aPrefName);
  81
  82   /**
  83    * display Printer Job Properties dialog
  84    */
  85   void displayJobProperties (in wstring aPrinter, in nsIPrintSettings
  86                              aPrintSettings, out boolean aDisplayed);
  87
  88   /**
  89    * Native data constants
  90    */
  91   const short kNativeDataPrintRecord        = 0;
  92
  93   [noscript] voidPtr GetNativeData(in short aDataType);
  94 };
  95
  96 [scriptable, uuid(5e738fff-404c-4c94-9189-e8f2cce93e94)]
  97
  98 interface nsIPrinterEnumerator : nsISupports
  99 {
 100   /**
 101    * The name of the system default printer. This name should also be
 102    * present in printerNameList below. This is not necessarily gecko's
 103    * default printer; see nsIPrintSettingsService.defaultPrinterName
 104    * for that.
 105    */
 106   readonly attribute wstring defaultPrinterName;
 107
 108   /**
 109    * Initializes certain settings from the native printer into the PrintSettings
 110    * These settings include, but are not limited to:
 111    *   Page Orientation
 112    *   Page Size
 113    *   Number of Copies
 114    */
 115   void initPrintSettingsFromPrinter(in wstring aPrinterName, in nsIPrintSettings aPrintSettings);
 116
 117   /**
 118    * The list of printer names
 119    */
 120   readonly attribute nsIStringEnumerator printerNameList;
 121
 122   /*  takes printer selected and will display job properties dlg for that printer
 123    *  returns true if dialog displays
 124    */
 125   void displayPropertiesDlg(in wstring aPrinter, in nsIPrintSettings aPrintSettings);
 126
 127 };
 128