widget/src/gtk2/nsPaperPS.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 developed for mozilla.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Kenneth Herron <kherron@newsguy.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
  40 #ifndef _PAPERPS_H_
  41 #define _PAPERPS_H_
  42
  43 #include "prtypes.h"
  44 #include "nsDebug.h"
  45
  46 struct nsPaperSizePS_ {
  47     const char *name;
  48     float width_mm;
  49     float height_mm;
  50     PRBool isMetric;        // Present to the user in metric, if possible
  51 };
  52
  53 class nsPaperSizePS {
  54     public:
  55         /** ---------------------------------------------------
  56          * Constructor
  57          */
  58         nsPaperSizePS() { mCurrent = 0; }
  59
  60         /** ---------------------------------------------------
  61          * @return PR_TRUE if the cursor points past the last item.
  62          */
  63         PRBool AtEnd() { return mCurrent >= mCount; }
  64
  65         /** ---------------------------------------------------
  66          * Position the cursor at the beginning of the paper size list.
  67          * @return VOID
  68          */
  69         void First() { mCurrent = 0; }
  70
  71         /** ---------------------------------------------------
  72          * Advance the cursor to the next item.
  73          * @return VOID
  74          */
  75         void Next() {
  76             NS_ASSERTION(!AtEnd(), "Invalid current item");
  77             mCurrent++;
  78         }
  79
  80         /** ---------------------------------------------------
  81          * Point the cursor to the entry with the given paper name.
  82          * @return PR_TRUE if pointing to a valid entry.
  83          */
  84         PRBool Find(const char *aName);
  85
  86         /** ---------------------------------------------------
  87          * @return a pointer to the name of the current paper size
  88          */
  89         const char *Name() {
  90             NS_PRECONDITION(!AtEnd(), "Invalid current item");
  91             return mList[mCurrent].name;
  92         }
  93
  94         /** ---------------------------------------------------
  95          * @return the width of the page in millimeters
  96          */
  97         float Width_mm() {
  98             NS_PRECONDITION(!AtEnd(), "Invalid current item");
  99             return mList[mCurrent].width_mm;
 100         }
 101
 102         /** ---------------------------------------------------
 103          * @return the height of the page in millimeters
 104          */
 105         float Height_mm() {
 106             NS_PRECONDITION(!AtEnd(), "Invalid current item");
 107             return mList[mCurrent].height_mm;
 108         }
 109
 110         /** ---------------------------------------------------
 111          * @return PR_TRUE if the paper should be presented to
 112          *                 the user in metric units.
 113          */
 114         PRBool IsMetric() {
 115             NS_PRECONDITION(!AtEnd(), "Invalid current item");
 116             return mList[mCurrent].isMetric;
 117         }
 118
 119     private:
 120         unsigned int mCurrent;
 121         static const nsPaperSizePS_ mList[];
 122         static const unsigned int mCount;
 123 };
 124
 125 #endif
 126