gecko-dev/gfx/idl/nsIPrintOptions.idl

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Netscape Public License
 * Version 1.1 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/NPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is 
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2000
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Don Cone <dcone@netscape.com>
 *
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the NPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the NPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

%{ C++
#include "nsMargin.h"
#include "nsFont.h"
%}

/**
 * Native types
 */
  [ref] native nsNativeMarginRef(nsMargin);
  [ref] native nsNativeFontRef(nsFont);
  [ref] native nsNativeStringRef(nsString);

/**
 * Simplified graphics interface for JS rendering.
 *
 * @status UNDER_REVIEW
 */
[scriptable, uuid(CAE87E20-479E-11d4-A856-00105A183419)]

interface nsIPrintOptions : nsISupports
{
  /* Print Option Flags for Bit Field*/
  const long kOptPrintOddPages              = 0x00000001;
  const long kOptPrintEvenPages             = 0x00000002;
  const long kPrintOptionsEnableSelectionRB = 0x00000004;

  /* Print Range Enums */
  const long kRangeAllPages           = 0;
  const long kRangeSpecifiedPageRange = 1;
  const long kRangeSelection          = 2;
  const long kRangeFocusFrame         = 3;

  /* Justification Enums */
  const long kJustLeft   = 0;
  const long kJustCenter = 1;
  const long kJustRight  = 2;

  /**
   * Page Size Constants
   */
  const short kLetterPaperSize    = 0;
  const short kLegalPaperSize     = 1;
  const short kExecutivePaperSize = 2;
  const short kA4PaperSize        = 3;
  const short kA3PaperSize        = 4;

  /**
   * Orientation Constants
   */
  const short kPortraitOrientation  = 0;
  const short kLandscapeOrientation = 1;

  /**
   * Print Frame Constants
   */
  const short kNoFrames      = 0;
  const short kFramesAsIs    = 1;
  const short kSelectedFrame = 2;
  const short kEachFrameSep  = 3;

  const short kFrameEnableNone        = 0;
  const short kFrameEnableAll         = 1;
  const short kFrameEnableAsIsAndEach = 2;

  /**
   * Show Native Print Options dialog, this may not be supported on all platforms
   */
  void ShowNativeDialog();

  /**
   * Set PrintOptions 
   */
  void SetPrintOptions(in PRInt32 aType, in PRBool aTurnOnOff);

  /**
   * Get PrintOptions 
   */
  PRBool GetPrintOptions(in PRInt32 aType);

  /**
   * Set PrintOptions Bit field
   */
  PRInt32 GetPrintOptionsBits();

  /**
   * Read Prefs 
   */
  void ReadPrefs();

  /**
   * Write Prefs
   */
  void WritePrefs();


  /**
   * Data Members
   */
  attribute long    startPageRange;    
  attribute long    endPageRange;    

  attribute double  marginTop;     /*  these are in inches */
  attribute double  marginLeft;
  attribute double  marginBottom;
  attribute double  marginRight;

  attribute short   printRange; 

  attribute wstring title;
  attribute wstring docURL;

  attribute wstring headerStrLeft;
  attribute wstring headerStrCenter;
  attribute wstring headerStrRight;

  attribute wstring footerStrLeft;
  attribute wstring footerStrCenter;
  attribute wstring footerStrRight;

  attribute short   howToEnableFrameUI;
  attribute short   printFrameType;
  attribute boolean isCancelled;
  attribute boolean PrintSilent;	/* print without putting up the dialog */


  /* Additional XP Related */
  attribute boolean printReversed;
  attribute boolean printInColor;  /* a false means grayscale */
  attribute long    paperSize;     /*  see page size consts */
  attribute long    orientation;   /*  see orientation consts */
  attribute wstring printCommand;
  attribute boolean printToFile;
  attribute wstring toFileName;

  attribute long    printPageDelay; /* in milliseconds */

  /* No Script Methods */

  [noscript] void SetFontNamePointSize(in nsNativeStringRef aName, in PRInt32 aPointSize);

  [noscript] void SetMarginInTwips(in nsNativeMarginRef aMargin);
  /* Purposely made this an "in" arg */
  [noscript] void GetMarginInTwips(in nsNativeMarginRef aMargin);

  [noscript] void SetDefaultFont(in nsNativeFontRef aMargin);
  /* Purposely made this an "in" arg */
  [noscript] void GetDefaultFont(in nsNativeFontRef aMargin);


  /**
   * Native data constants
   */
  const short kNativeDataPrintRecord        = 0;

  [noscript] voidPtr GetNativeData(in short aDataType);

};