widget/nsIPaper.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 [scriptable, uuid(a4dd9675-6311-45a9-a547-44e0127304a6)]
   9 interface nsIPaper : nsISupports
  10 {
  11   /**
  12    * The internal name of the paper (a fixed, non-localized ID).
  13    * (For CUPS, this is the PWG-standardized name as used internally by CUPS;
  14    * on Windows, it is the integer paper ID as a string.)
  15    */
  16   readonly attribute AString id;
  17
  18   /**
  19    * The human-readable (potentially localized) name of the paper.
  20    */
  21   readonly attribute AString name;
  22
  23   /**
  24    * The width of the paper assuming portrait orientation, in points.
  25    * That is, the length of the shorter edges of the paper.
  26    */
  27   readonly attribute double width;
  28
  29   /**
  30    * The height of the paper assuming portrait orientation, in points.
  31    * That is, the length of the longer edges of the paper.
  32    */
  33   readonly attribute double height;
  34
  35   /**
  36    * The Promise resolves with an nsIPaperMargin object. The margin widths contained
  37    * in that object's top/bottom/left/right properties are relative to the paper in
  38    * portrait orientation. That is, top and bottom are the margins for the short edges,
  39    * and left and right are the margins for the long edges.
  40    */
  41   [implicit_jscontext] readonly attribute Promise unwriteableMargin;
  42 };