okular/core/fontinfo.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_FONTINFO_H_
  11 #define _OKULAR_FONTINFO_H_
  12
  13 #include <QtCore/QList>
  14 #include <QtCore/QMetaType>
  15 #include <QtCore/QSharedDataPointer>
  16 #include <QtCore/QString>
  17
  18 #include <okular/core/okular_export.h>
  19
  20 namespace Okular {
  21
  22 class FontInfoPrivate;
  23
  24 /**
  25  * @short A small class that represents the information of a font.
  26  */
  27 class OKULAR_EXPORT FontInfo
  28 {
  29     public:
  30         typedef QList<FontInfo> List;
  31
  32         /**
  33          * The possible kinds of fonts.
  34          */
  35         enum FontType
  36         {
  37             Unknown,
  38             Type1,
  39             Type1C,
  40             Type1COT,
  41             Type3,
  42             TrueType,
  43             TrueTypeOT,
  44             CIDType0,
  45             CIDType0C,
  46             CIDType0COT,
  47             CIDTrueType,
  48             CIDTrueTypeOT
  49         };
  50
  51         /**
  52          * The possible kinds of embed.
  53          */
  54         enum EmbedType
  55         {
  56             NotEmbedded,
  57             EmbeddedSubset,
  58             FullyEmbedded
  59         };
  60
  61         /**
  62          * Construct a new empty font info.
  63          */
  64         FontInfo();
  65         /**
  66          * Copy constructor.
  67          */
  68         FontInfo( const FontInfo &fi );
  69         /**
  70          * Destructor.
  71          */
  72         ~FontInfo();
  73
  74         /**
  75          * Returns the name of the font.
  76          */
  77         QString name() const;
  78         /**
  79          * Sets a new name for the font.
  80          */
  81         void setName( const QString& name );
  82
  83         /**
  84          * Returns the type of the font.
  85          */
  86         FontType type() const;
  87         /**
  88          * Change the type of the font.
  89          */
  90         void setType( FontType type );
  91
  92         /**
  93          * Returns the type of font embedding.
  94          */
  95         EmbedType embedType() const;
  96         /**
  97          * Sets the type of font embedding.
  98          */
  99         void setEmbedType( EmbedType type );
 100
 101         /**
 102          * In case of not embedded font, returns the path of the font that
 103          * represents this font.
 104          */
 105         QString file() const;
 106         void setFile( const QString& file );
 107
 108         /**
 109          * In case of embedded fonts, returns if the font can be extracted into a QByteArray
 110          *
 111          * @since 0.8 (KDE 4.2)
 112          */
 113         bool canBeExtracted() const;
 114
 115         /**
 116          * Sets if a font can be extracted or not. False by default
 117          */
 118         void setCanBeExtracted( bool extractable );
 119
 120         /**
 121          * Sets the "native" @p id of the font info.
 122          *
 123          * This is for use of the Generator, that can optionally store an
 124          * handle (a pointer, an identifier, etc) of the "native" font
 125          * object, if any.
 126          *
 127          * @since 0.8 (KDE 4.2)
 128          */
 129         void setNativeId( const QVariant &id );
 130
 131         /**
 132          * Returns the "native" id of the font info.
 133          *
 134          * @since 0.8 (KDE 4.2)
 135          */
 136         QVariant nativeId() const;
 137
 138         FontInfo& operator=( const FontInfo &fi );
 139
 140         /**
 141          * Comparison operator.
 142          */
 143         bool operator==( const FontInfo &fi ) const;
 144
 145         bool operator!=( const FontInfo &fi ) const;
 146
 147     private:
 148         /// @cond PRIVATE
 149         friend class FontInfoPrivate;
 150         /// @endcond
 151         QSharedDataPointer<FontInfoPrivate> d;
 152 };
 153
 154 }
 155
 156 Q_DECLARE_METATYPE(Okular::FontInfo)
 157
 158 #endif