okular/core/pagesize.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Pino Toscano <pino@kde.org>                     *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  ***************************************************************************/
   9
  10 #ifndef _OKULAR_PAGESIZE_H_
  11 #define _OKULAR_PAGESIZE_H_
  12
  13 #include <QtCore/QList>
  14 #include <QtCore/QSharedDataPointer>
  15 #include <QtCore/QString>
  16
  17 #include <okular/core/okular_export.h>
  18
  19 namespace Okular {
  20
  21 class PageSizePrivate;
  22
  23 /**
  24  * @short A small class that represents the size of a page.
  25  */
  26 class OKULAR_EXPORT PageSize
  27 {
  28     public:
  29         typedef QList<PageSize> List;
  30
  31         /**
  32          * Construct a null page size.
  33          * @see isNull()
  34          */
  35         PageSize();
  36         /**
  37          * Construct a page size with the specified @p width and @p height,
  38          * having the ID @p name.
  39          */
  40         PageSize( double width, double height, const QString &name );
  41         /**
  42          * Copy constructor.
  43          */
  44         PageSize( const PageSize &pageSize );
  45         ~PageSize();
  46
  47         /**
  48          * Returns the width of the page size.
  49          */
  50         double width() const;
  51         /**
  52          * Returns the height of the page size.
  53          */
  54         double height() const;
  55         /**
  56          * Returns the ID of the page size.
  57          */
  58         QString name() const;
  59
  60         /**
  61          * Whether the page size is null.
  62          */
  63         bool isNull() const;
  64
  65         PageSize& operator=( const PageSize &pageSize );
  66
  67         /**
  68          * Comparison operator.
  69          */
  70         bool operator==( const PageSize &pageSize ) const;
  71
  72         bool operator!=( const PageSize &pageSize ) const;
  73
  74     private:
  75         /// @cond PRIVATE
  76         friend class PageSizePrivate;
  77         /// @endcond
  78         QSharedDataPointer<PageSizePrivate> d;
  79 };
  80
  81 }
  82
  83 #endif