widget/public/nsIPrintSettingsX.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  *   Conrad Carlen <ccarlen@netscape.com>
  24  *   Don Cone <dcone@netscape.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
  42 %{ C++
  43 #include <PMApplication.h>
  44 %}
  45
  46 /**
  47  * Native types
  48  */
  49 native nsPMPageFormat(PMPageFormat);
  50 native nsPMPrintSettings(PMPrintSettings);
  51 native nsPMPrintSession(PMPrintSession);
  52
  53 /**
  54  * Simplified PrintSettings for OSX interface
  55  *
  56  * @status UNDER_REVIEW
  57  */
  58 [scriptable, uuid(CD2A0A4F-0DE9-4c51-9232-42668F559F94)]
  59
  60 interface nsIPrintSettingsX : nsISupports
  61 {
  62   /**
  63    * nativePrintSession attribute
  64    *
  65    * Convenience method which gets the nsIPrintSession
  66    * and returns its native session object
  67    *
  68    * Does NOT do PMRetain() on result.
  69    */
  70   [noscript] readonly attribute nsPMPrintSession nativePrintSession;
  71
  72   /**
  73    * PMPageFormat and PMPrintSettings attributes
  74    *
  75    * Getter does NOT do PMRetain() on result.
  76    * Setter does PMRetain() on parameter.
  77    */
  78   [noscript] attribute nsPMPageFormat pMPageFormat;
  79
  80   [noscript] attribute nsPMPrintSettings pMPrintSettings;
  81
  82   /**
  83    * readPageFormatFromPrefs and writePageFormatToPrefs
  84    *
  85    * Read and write a flattened PMPageFormat to/from prefs.
  86    * This also contains any custom data we appended to the dialog
  87    */
  88   [noscript] void readPageFormatFromPrefs();
  89   [noscript] void writePageFormatToPrefs();
  90 };