widget/public/nsIDeviceContextSpec.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsIDeviceContextSpec_h___
  39 #define nsIDeviceContextSpec_h___
  40
  41 #include "nsIDeviceContext.h"
  42 #include "prtypes.h"
  43
  44 class nsIWidget;
  45 class nsIPrintSettings;
  46
  47 class gfxASurface;
  48
  49 #define NS_IDEVICE_CONTEXT_SPEC_IID   \
  50 { 0x205c614f, 0x39f8, 0x42e1, \
  51 { 0x92, 0x53, 0x04, 0x9b, 0x48, 0xc3, 0xcb, 0xd8 } }
  52
  53 class nsIDeviceContextSpec : public nsISupports
  54 {
  55 public:
  56    NS_DECLARE_STATIC_IID_ACCESSOR(NS_IDEVICE_CONTEXT_SPEC_IID)
  57
  58    /**
  59     * Initialize the device context spec.
  60     * @param aWidget         A widget a dialog can be hosted in
  61     * @param aPrintSettings  Print settings for the print operation
  62     * @param aIsPrintPreview True if creating Spec for PrintPreview
  63     * @return NS_OK or a suitable error code.
  64     */
  65    NS_IMETHOD Init(nsIWidget *aWidget,
  66                    nsIPrintSettings* aPrintSettings,
  67                    PRBool aIsPrintPreview) = 0;
  68
  69    NS_IMETHOD GetSurfaceForPrinter(gfxASurface **nativeSurface) = 0;
  70
  71    NS_IMETHOD BeginDocument(PRUnichar*  aTitle,
  72                             PRUnichar*  aPrintToFileName,
  73                             PRInt32     aStartPage,
  74                             PRInt32     aEndPage) = 0;
  75
  76    NS_IMETHOD EndDocument() = 0;
  77    NS_IMETHOD BeginPage() = 0;
  78    NS_IMETHOD EndPage() = 0;
  79 };
  80
  81 NS_DEFINE_STATIC_IID_ACCESSOR(nsIDeviceContextSpec,
  82                               NS_IDEVICE_CONTEXT_SPEC_IID)
  83
  84 #endif