gfx/src/psshared/nsPSPrinters.h

   1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ex: set tabstop=8 softtabstop=4 shiftwidth=4 expandtab: */
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Mozilla PostScript driver printer list component.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Kenneth Herron <kherron+mozilla@fmailbox.com>
  20  * Portions created by the Initial Developer are Copyright (C) 2004
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsPSPrinters_h___
  40 #define nsPSPrinters_h___
  41
  42 #include "nsString.h"
  43 #include "nsVoidArray.h"
  44 #include "prtypes.h"
  45 #include "nsCUPSShim.h"
  46 #include "psSharedCore.h"
  47
  48 class nsIPrefService;
  49 class nsIPrefBranch;
  50 class nsCUPSShim;
  51
  52 class NS_PSSHARED nsPSPrinterList {
  53     public:
  54         /**
  55          * Initialize a printer manager object.
  56          * @return NS_ERROR_NOT_INITIALIZED if unable to access prefs
  57          *         NS_OK for successful initialization.
  58          */
  59         nsresult Init();
  60
  61         /**
  62          * Is the PostScript module enabled or disabled?
  63          * @return PR_TRUE if enabled,
  64          *         PR_FALSE if not.
  65          */
  66         PRBool Enabled();
  67
  68         /**
  69          * Obtain a list of printers (print destinations) supported by the
  70          * PostScript module, Each entry will be in the form <type>/<name>,
  71          * where <type> is a printer type string, and <name> is the actual
  72          * printer name.
  73          *
  74          * @param aList Upon return, this is populated with the list of
  75          *              printer names as described above, replacing any
  76          *              previous contents. Each entry is a UTF8 string.
  77          *              There should always be at least one entry. The
  78          *              first entry is the default print destination.
  79          */
  80         void GetPrinterList(nsCStringArray& aList);
  81
  82         enum PrinterType {
  83             kTypeUnknown,         // Not actually handled by the PS module
  84             kTypePS,              // Generic postscript module printer
  85             kTypeCUPS             // CUPS printer
  86         };
  87
  88         /**
  89          * Identify a printer's type from its name.
  90          * @param aName The printer's full name as a UTF8 string, including
  91          *              the <type> portion as described for GetPrinterList().
  92          * @return The PrinterType value for this name.
  93          */
  94         static PrinterType GetPrinterType(const nsACString& aName);
  95
  96     private:
  97         nsCOMPtr<nsIPrefService> mPrefSvc;
  98         nsCOMPtr<nsIPrefBranch> mPref;
  99         nsCUPSShim mCups;
 100 };
 101
 102 #endif /* nsPSPrinters_h___ */