src/plugins/texteditor/fontsettings.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef FONTSETTINGS_H
  34 #define FONTSETTINGS_H
  35
  36 #include "texteditor_global.h"
  37
  38 #include "colorscheme.h"
  39
  40 #include <QtCore/QString>
  41 #include <QtCore/QList>
  42 #include <QtCore/QVector>
  43
  44 QT_BEGIN_NAMESPACE
  45 class QTextCharFormat;
  46 class QSettings;
  47 class QFont;
  48 QT_END_NAMESPACE
  49
  50 namespace TextEditor {
  51
  52 class FormatDescription;
  53
  54 /**
  55  * Font settings (default font and enumerated list of formats).
  56  */
  57 class TEXTEDITOR_EXPORT FontSettings
  58 {
  59 public:
  60     typedef QList<FormatDescription> FormatDescriptions;
  61
  62     FontSettings();
  63     void clear();
  64     inline bool isEmpty() const { return m_scheme.isEmpty(); }
  65
  66     void toSettings(const QString &category,
  67                     QSettings *s) const;
  68
  69     bool fromSettings(const QString &category,
  70                       const FormatDescriptions &descriptions,
  71                       const QSettings *s);
  72
  73     QVector<QTextCharFormat> toTextCharFormats(const QVector<QString> &categories) const;
  74     QTextCharFormat toTextCharFormat(const QString &category) const;
  75
  76     QString family() const;
  77     void setFamily(const QString &family);
  78
  79     int fontSize() const;
  80     void setFontSize(int size);
  81
  82     int fontZoom() const;
  83     void setFontZoom(int zoom);
  84
  85     QFont font() const;
  86
  87     bool antialias() const;
  88     void setAntialias(bool antialias);
  89
  90     Format &formatFor(const QString &category);
  91
  92     QString colorSchemeFileName() const;
  93     void setColorSchemeFileName(const QString &fileName);
  94     bool loadColorScheme(const QString &fileName, const FormatDescriptions &descriptions);
  95     bool saveColorScheme(const QString &fileName);
  96
  97     const ColorScheme &colorScheme() const;
  98     void setColorScheme(const ColorScheme &scheme);
  99
 100     bool equals(const FontSettings &f) const;
 101
 102     static QString defaultFixedFontFamily();
 103     static int defaultFontSize();
 104
 105     static QString defaultSchemeFileName(const QString &fileName = QString());
 106
 107 private:
 108     QString m_family;
 109     QString m_schemeFileName;
 110     int m_fontSize;
 111     int m_fontZoom;
 112     bool m_antialias;
 113     ColorScheme m_scheme;
 114 };
 115
 116 inline bool operator==(const FontSettings &f1, const FontSettings &f2) { return f1.equals(f2); }
 117 inline bool operator!=(const FontSettings &f1, const FontSettings &f2) { return !f1.equals(f2); }
 118
 119 } // namespace TextEditor
 120
 121 #endif // FONTSETTINGS_H