widget/nsIPrintSettings.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8
   9 %{ C++
  10 #include "nsMargin.h"
  11 #include "nsTArray.h"
  12 %}
  13
  14 /**
  15  * Native types
  16  */
  17   [ref] native nsNativeIntMarginRef(nsIntMargin);
  18   [ref] native IntegerArray(nsTArray<int32_t>);
  19
  20 interface nsIPrintSession;
  21
  22 /**
  23  * Simplified graphics interface for JS rendering.
  24  */
  25 [scriptable, uuid(ecc5cbad-57fc-4731-b0bd-09e865bd62ad)]
  26
  27 interface nsIPrintSettings : nsISupports
  28 {
  29   /**
  30    * PrintSettings to be Saved Navigation Constants
  31    */
  32   const unsigned long kInitSaveOddEvenPages   = 0x00000001;
  33   const unsigned long kInitSaveHeaderLeft     = 0x00000002;
  34   const unsigned long kInitSaveHeaderCenter   = 0x00000004;
  35   const unsigned long kInitSaveHeaderRight    = 0x00000008;
  36   const unsigned long kInitSaveFooterLeft     = 0x00000010;
  37   const unsigned long kInitSaveFooterCenter   = 0x00000020;
  38   const unsigned long kInitSaveFooterRight    = 0x00000040;
  39   const unsigned long kInitSaveBGColors       = 0x00000080;
  40   const unsigned long kInitSaveBGImages       = 0x00000100;
  41   const unsigned long kInitSavePaperSize      = 0x00000200;
  42   const unsigned long kInitSaveResolution     = 0x00000400;
  43   const unsigned long kInitSaveDuplex         = 0x00000800;
  44   /* Flag 0x00001000 is unused */
  45   const unsigned long kInitSavePaperData      = 0x00002000;
  46   const unsigned long kInitSaveUnwriteableMargins = 0x00004000;
  47   const unsigned long kInitSaveEdges          = 0x00008000;
  48
  49   const unsigned long kInitSaveReversed       = 0x00010000;
  50   const unsigned long kInitSaveInColor        = 0x00020000;
  51   const unsigned long kInitSaveOrientation    = 0x00040000;
  52
  53   const unsigned long kInitSavePrinterName    = 0x00100000;
  54   const unsigned long kInitSavePrintToFile    = 0x00200000;
  55   const unsigned long kInitSaveToFileName     = 0x00400000;
  56   const unsigned long kInitSavePageDelay      = 0x00800000;
  57   const unsigned long kInitSaveMargins        = 0x01000000;
  58   const unsigned long kInitSaveNativeData     = 0x02000000;
  59
  60   const unsigned long kInitSaveShrinkToFit    = 0x08000000;
  61   const unsigned long kInitSaveScaling        = 0x10000000;
  62
  63   const unsigned long kInitSaveAll            = 0xFFFFFFFF;
  64
  65   /* Print Option Flags for Bit Field*/
  66   const long kPrintOddPages     = 0x00000001;
  67   const long kPrintEvenPages    = 0x00000002;
  68   const long kEnableSelectionRB = 0x00000004;
  69
  70   /* Print Range Enums */
  71   const long kRangeAllPages           = 0;
  72   const long kRangeSpecifiedPageRange = 1;
  73   const long kRangeSelection          = 2;
  74   const long kRangeFocusFrame         = 3;
  75
  76   /* Justification Enums */
  77   const long kJustLeft   = 0;
  78   const long kJustCenter = 1;
  79   const long kJustRight  = 2;
  80
  81   /**
  82    * FrameSet Default Type Constants
  83    */
  84   const short kUseInternalDefault    = 0;
  85   const short kUseSettingWhenPossible = 1;
  86
  87   /**
  88    * Page Size Type Constants
  89    */
  90   const short kPaperSizeNativeData  = 0;
  91   const short kPaperSizeDefined     = 1;
  92
  93   /**
  94    * Page Size Unit Constants
  95    */
  96   const short kPaperSizeInches      = 0;
  97   const short kPaperSizeMillimeters = 1;
  98
  99   /**
 100    * Orientation Constants
 101    */
 102   const short kPortraitOrientation  = 0;
 103   const short kLandscapeOrientation = 1;
 104
 105   /**
 106    * Print Frame Constants
 107    */
 108   const short kNoFrames      = 0;
 109   const short kFramesAsIs    = 1;
 110   const short kSelectedFrame = 2;
 111   const short kEachFrameSep  = 3;
 112
 113   /**
 114    * How to Enable Frame Set Printing Constants
 115    */
 116   const short kFrameEnableNone        = 0;
 117   const short kFrameEnableAll         = 1;
 118   const short kFrameEnableAsIsAndEach = 2;
 119
 120   /**
 121    * Output file format
 122    */
 123   const short kOutputFormatNative = 0;
 124   const short kOutputFormatPS     = 1;
 125   const short kOutputFormatPDF    = 2;
 126
 127   /**
 128    * Set PrintOptions
 129    */
 130   void SetPrintOptions(in int32_t aType, in boolean aTurnOnOff);
 131
 132   /**
 133    * Get PrintOptions
 134    */
 135   boolean GetPrintOptions(in int32_t aType);
 136
 137   /**
 138    * Get PrintOptions Bit field
 139    */
 140   int32_t GetPrintOptionsBits();
 141
 142   /**
 143    * Set PrintOptions Bit field
 144    */
 145   void SetPrintOptionsBits(in int32_t bits);
 146
 147   /**
 148    * Get the page size in twips, considering the
 149    * orientation (portrait or landscape).
 150    */
 151   void GetEffectivePageSize(out double aWidth, out double aHeight);
 152
 153   /**
 154    * Makes a new copy
 155    */
 156     nsIPrintSettings clone();
 157
 158   /**
 159    * Assigns the internal values from the "in" arg to the current object
 160    */
 161     void assign(in nsIPrintSettings aPS);
 162
 163   /**
 164    * Data Members
 165    */
 166   [noscript] attribute nsIPrintSession printSession; /* We hold a weak reference */
 167
 168   attribute long    startPageRange;
 169   attribute long    endPageRange;
 170
 171   /**
 172    * The edge measurements define the positioning of the headers
 173    * and footers on the page. They're measured as an offset from
 174    * the "unwriteable margin" (described below).
 175    */
 176   attribute double  edgeTop;     /*  these are in inches */
 177   attribute double  edgeLeft;
 178   attribute double  edgeBottom;
 179   attribute double  edgeRight;
 180
 181   /**
 182    * The margins define the positioning of the content on the page.
 183    * They're treated as an offset from the "unwriteable margin"
 184    * (described below).
 185    */
 186   attribute double  marginTop;     /*  these are in inches */
 187   attribute double  marginLeft;
 188   attribute double  marginBottom;
 189   attribute double  marginRight;
 190   /**
 191    * The unwriteable margin defines the printable region of the paper, creating
 192    * an invisible border from which the edge and margin attributes are measured.
 193    */
 194   attribute double  unwriteableMarginTop;     /*  these are in inches */
 195   attribute double  unwriteableMarginLeft;
 196   attribute double  unwriteableMarginBottom;
 197   attribute double  unwriteableMarginRight;
 198
 199   attribute double  scaling;      /* values 0.0 - 1.0 */
 200   attribute boolean printBGColors; /* Print Background Colors */
 201   attribute boolean printBGImages; /* Print Background Images */
 202
 203   attribute short   printRange;
 204
 205   attribute AString title;
 206   attribute AString docURL;
 207
 208   attribute AString headerStrLeft;
 209   attribute AString headerStrCenter;
 210   attribute AString headerStrRight;
 211
 212   attribute AString footerStrLeft;
 213   attribute AString footerStrCenter;
 214   attribute AString footerStrRight;
 215
 216   attribute short   howToEnableFrameUI;  /* indicates how to enable the frameset UI            */
 217   attribute boolean isCancelled;         /* indicates whether the print job has been cancelled */
 218   attribute short   printFrameTypeUsage; /* indicates whether to use the interal value or not  */
 219   attribute short   printFrameType;
 220   attribute boolean printSilent;             /* print without putting up the dialog */
 221   attribute boolean shrinkToFit;             /* shrinks content to fit on page      */
 222   attribute boolean showPrintProgress;   /* indicates whether the progress dialog should be shown */
 223
 224   /* Additional XP Related */
 225   attribute AString paperName;     /* name of paper */
 226   attribute short   paperData;     /* native data value */
 227   attribute double  paperWidth;    /* width of the paper in inches or mm */
 228   attribute double  paperHeight;   /* height of the paper in inches or mm */
 229   attribute short   paperSizeUnit; /* paper is in inches or mm */
 230
 231   attribute boolean printReversed;
 232   attribute boolean printInColor;  /* a false means grayscale */
 233   attribute long    orientation;   /*  see orientation consts */
 234   attribute long    numCopies;
 235
 236   attribute AString printerName;   /* name of destination printer */
 237
 238   attribute boolean printToFile;
 239   attribute AString toFileName;
 240   attribute short   outputFormat;
 241
 242   attribute long    printPageDelay; /* in milliseconds */
 243
 244   attribute long    resolution;     /* print resolution (dpi) */
 245
 246   attribute long    duplex;         /* duplex mode */
 247
 248   /* initialize helpers */
 249   /**
 250    * This attribute tracks whether the PS has been initialized
 251    * from a printer specified by the "printerName" attr.
 252    * If a different name is set into the "printerName"
 253    * attribute than the one it was initialized with the PS
 254    * will then get intialized from that printer.
 255    */
 256   attribute boolean isInitializedFromPrinter;
 257
 258   /**
 259    * This attribute tracks whether the PS has been initialized
 260    * from prefs. If a different name is set into the "printerName"
 261    * attribute than the one it was initialized with the PS
 262    * will then get intialized from prefs again.
 263    */
 264   attribute boolean isInitializedFromPrefs;
 265
 266   /* C++ Helper Functions */
 267   [noscript] void SetMarginInTwips(in nsNativeIntMarginRef aMargin);
 268   [noscript] void SetEdgeInTwips(in nsNativeIntMarginRef aEdge);
 269   /* Purposely made this an "in" arg */
 270   [noscript] void GetMarginInTwips(in nsNativeIntMarginRef aMargin);
 271   [noscript] void GetEdgeInTwips(in nsNativeIntMarginRef aEdge);
 272
 273   /**
 274    * We call this function so that anything that requires a run of the event loop
 275    * can do so safely. The print dialog runs the event loop but in silent printing
 276    * that doesn't happen.
 277    *
 278    * Either this or ShowPrintDialog (but not both) MUST be called by the print engine
 279    * before printing, otherwise printing can fail on some platforms.
 280    */
 281   [noscript] void SetupSilentPrinting();
 282
 283   /**
 284    * Sets/Gets the "unwriteable margin" for the page format.  This defines
 285    * the boundary from which we'll measure the EdgeInTwips and MarginInTwips
 286    * attributes, to place the headers and content, respectively.
 287    *
 288    * Note: Implementations of SetUnwriteableMarginInTwips should handle
 289    * negative margin values by falling back on the system default for
 290    * that margin.
 291    */
 292   [noscript] void SetUnwriteableMarginInTwips(in nsNativeIntMarginRef aEdge);
 293   [noscript] void GetUnwriteableMarginInTwips(in nsNativeIntMarginRef aEdge);
 294
 295   /**
 296    * Get more accurate print ranges from the superior interval
 297    * (startPageRange, endPageRange). The aPages array is populated with a
 298    * list of pairs (start, end), where the endpoints are included. The print
 299    * ranges (start, end), must not overlap and must be in the
 300    * (startPageRange, endPageRange) scope.
 301    *
 302    * If there are no print ranges the aPages array is cleared.
 303    */
 304   [noscript] void GetPageRanges(in IntegerArray aPages);
 305 };