widget/public/nsIPrintDialogService.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  * Kenneth Herron <kherron@fmailbox.com>
  19  * Portions created by the Initial Developer are Copyright (C) 2007
  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 nsIPrintDialogService_h__
  39 #define nsIPrintDialogService_h__
  40
  41 #include "nsISupports.h"
  42
  43 class nsIDOMWindow;
  44 class nsIPrintSettings;
  45
  46 /*
  47  * Interface to a print dialog accessed through the widget library.
  48  */
  49
  50 #define NS_IPRINTDIALOGSERVICE_IID \
  51 { 0x3715eb1a, 0xb314, 0x447c, \
  52 { 0x95, 0x33, 0xd0, 0x6a, 0x6d, 0xa6, 0xa6, 0xf0 } }
  53
  54
  55 /**
  56  *
  57  */
  58 class nsIPrintDialogService  : public nsISupports
  59 {
  60 public:
  61   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IPRINTDIALOGSERVICE_IID)
  62
  63   /**
  64    * Initialize the service.
  65    * @return NS_OK or a suitable error.
  66    */
  67   NS_IMETHOD Init() = 0;
  68
  69   /**
  70    * Show the print dialog.
  71    * @param aParent   A DOM window the dialog will be parented to.
  72    * @param aSettings On entry, this contains initial settings for the
  73    *                  print dialog. On return, if the print operation should
  74    *                  proceed then this contains settings for the print
  75    *                  operation.
  76    * @return NS_OK if the print operation should proceed
  77    * @return NS_ERROR_ABORT if the user indicated not to proceed
  78    * @return a suitable error for failures to show the print dialog.
  79    */
  80   NS_IMETHOD Show(nsIDOMWindow *aParent, nsIPrintSettings *aSettings) = 0;
  81
  82   /**
  83    * Show the page setup dialog. Note that there is no way to tell whether the
  84    * user clicked OK or Cancel on the dialog.
  85    * @param aParent   A DOM window the dialog will be parented to.
  86    * @param aSettings On entry, this contains initial settings for the
  87    *                  page setup dialog. On return, this contains new default
  88    *                  page setup options.
  89    * @return NS_OK if everything is OK.
  90    * @return a suitable error for failures to show the page setup dialog.
  91    */
  92   NS_IMETHOD ShowPageSetup(nsIDOMWindow *aParent, nsIPrintSettings *aSettings) = 0;
  93
  94 };
  95
  96 NS_DEFINE_STATIC_IID_ACCESSOR(nsIPrintDialogService, NS_IPRINTDIALOGSERVICE_IID)
  97
  98 #define NS_PRINTDIALOGSERVICE_CONTRACTID ("@mozilla.org/widget/printdialog-service;1")
  99
 100 #endif // nsIPrintDialogService_h__
 101