/****************************************************************************

**

** Copyright (C) 2016 The Qt Company Ltd.

** Contact: https://www.qt.io/licensing/

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** Commercial License Usage

** Licensees holding valid commercial Qt licenses may use this file in

** accordance with the commercial license agreement provided with the

** Software or, alternatively, in accordance with the terms contained in

** a written agreement between you and The Qt Company. For licensing terms

** and conditions see https://www.qt.io/terms-conditions. For further

** information use the contact form at https://www.qt.io/contact-us.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 3 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL3 included in the

** packaging of this file. Please review the following information to

** ensure the GNU Lesser General Public License version 3 requirements

** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.

**

** GNU General Public License Usage

** Alternatively, this file may be used under the terms of the GNU

** General Public License version 2.0 or (at your option) the GNU General

** Public license version 3 or any later version approved by the KDE Free

** Qt Foundation. The licenses are as published by the Free Software

** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3

** included in the packaging of this file. Please review the following

** information to ensure the GNU General Public License requirements will

** be met: https://www.gnu.org/licenses/gpl-2.0.html and

** https://www.gnu.org/licenses/gpl-3.0.html.

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QFONT_H

#define QFONT_H

#include <QtGui/qtguiglobal.h>

#include <QtGui/qwindowdefs.h>

#include <QtCore/qstring.h>

#include <QtCore/qsharedpointer.h>

QT_BEGIN_NAMESPACE

class QFontPrivate;                                     /* don't touch */

class QStringList;

class QVariant;

class Q_GUI_EXPORT QFont

{

    Q_GADGET

public:

    enum StyleHint {

        Helvetica,  SansSerif = Helvetica,

        Times,      Serif = Times,

        Courier,    TypeWriter = Courier,

        OldEnglish, Decorative = OldEnglish,

        System,

        AnyStyle,

        Cursive,

        Monospace,

        Fantasy

    };

    Q_ENUM(StyleHint)

    enum StyleStrategy {

        PreferDefault       = 0x0001,

        PreferBitmap        = 0x0002,

        PreferDevice        = 0x0004,

        PreferOutline       = 0x0008,

        ForceOutline        = 0x0010,

        PreferMatch         = 0x0020,

        PreferQuality       = 0x0040,

        PreferAntialias     = 0x0080,

        NoAntialias         = 0x0100,

#if QT_DEPRECATED_SINCE(5, 15)

        OpenGLCompatible Q_DECL_ENUMERATOR_DEPRECATED = 0x0200,

        ForceIntegerMetrics Q_DECL_ENUMERATOR_DEPRECATED = 0x0400,

#endif

        NoSubpixelAntialias = 0x0800,

        PreferNoShaping     = 0x1000,

        NoFontMerging       = 0x8000

    };

    Q_ENUM(StyleStrategy)

    enum HintingPreference {

        PreferDefaultHinting        = 0,

        PreferNoHinting             = 1,

        PreferVerticalHinting       = 2,

        PreferFullHinting           = 3

    };

    Q_ENUM(HintingPreference)

    // Mapping OpenType weight value.

    enum Weight {

        Thin     = 0,    // 100

        ExtraLight = 12, // 200

        Light    = 25,   // 300

        Normal   = 50,   // 400

        Medium   = 57,   // 500

        DemiBold = 63,   // 600

        Bold     = 75,   // 700

        ExtraBold = 81,  // 800

        Black    = 87    // 900

    };

    Q_ENUM(Weight)

    enum Style {

        StyleNormal,

        StyleItalic,

        StyleOblique

    };

    Q_ENUM(Style)

    enum Stretch {

        AnyStretch     =   0,

        UltraCondensed =  50,

        ExtraCondensed =  62,

        Condensed      =  75,

        SemiCondensed  =  87,

        Unstretched    = 100,

        SemiExpanded   = 112,

        Expanded       = 125,

        ExtraExpanded  = 150,

        UltraExpanded  = 200

    };

    Q_ENUM(Stretch)

    enum Capitalization {

        MixedCase,

        AllUppercase,

        AllLowercase,

        SmallCaps,

        Capitalize

    };

    Q_ENUM(Capitalization)

    enum SpacingType {

        PercentageSpacing,

        AbsoluteSpacing

    };

    Q_ENUM(SpacingType)

    enum ResolveProperties {

        NoPropertiesResolved        = 0x0000,

        FamilyResolved              = 0x0001,

        SizeResolved                = 0x0002,

        StyleHintResolved           = 0x0004,

        StyleStrategyResolved       = 0x0008,

        WeightResolved              = 0x0010,

        StyleResolved               = 0x0020,

        UnderlineResolved           = 0x0040,

        OverlineResolved            = 0x0080,

        StrikeOutResolved           = 0x0100,

        FixedPitchResolved          = 0x0200,

        StretchResolved             = 0x0400,

        KerningResolved             = 0x0800,

        CapitalizationResolved      = 0x1000,

        LetterSpacingResolved       = 0x2000,

        WordSpacingResolved         = 0x4000,

        HintingPreferenceResolved   = 0x8000,

        StyleNameResolved           = 0x10000,

        FamiliesResolved            = 0x20000,

        AllPropertiesResolved       = 0x3ffff

    };

    Q_ENUM(ResolveProperties)

    QFont();

    QFont(const QString &family, int pointSize = -1, int weight = -1, bool italic = false);

#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)

    QFont(const QFont &font, QPaintDevice *pd);

#endif

    QFont(const QFont &font, const QPaintDevice *pd);

    QFont(const QFont &font);

    ~QFont();

    void swap(QFont &other)

    { qSwap(d, other.d); qSwap(resolve_mask, other.resolve_mask); }

    QString family() const;

    void setFamily(const QString &);

    QStringList families() const;

    void setFamilies(const QStringList &);

    QString styleName() const;

    void setStyleName(const QString &);

    int pointSize() const;

    void setPointSize(int);

    qreal pointSizeF() const;

    void setPointSizeF(qreal);

    int pixelSize() const;

    void setPixelSize(int);

    int weight() const;

    void setWeight(int);

    inline bool bold() const;

    inline void setBold(bool);

    void setStyle(Style style);

    Style style() const;

    inline bool italic() const;

    inline void setItalic(bool b);

    bool underline() const;

    void setUnderline(bool);

    bool overline() const;

    void setOverline(bool);

    bool strikeOut() const;

    void setStrikeOut(bool);

    bool fixedPitch() const;

    void setFixedPitch(bool);

    bool kerning() const;

    void setKerning(bool);

    StyleHint styleHint() const;

    StyleStrategy styleStrategy() const;

    void setStyleHint(StyleHint, StyleStrategy = PreferDefault);

    void setStyleStrategy(StyleStrategy s);

    int stretch() const;

    void setStretch(int);

    qreal letterSpacing() const;

    SpacingType letterSpacingType() const;

    void setLetterSpacing(SpacingType type, qreal spacing);

    qreal wordSpacing() const;

    void setWordSpacing(qreal spacing);

    void setCapitalization(Capitalization);

    Capitalization capitalization() const;

    void setHintingPreference(HintingPreference hintingPreference);

    HintingPreference hintingPreference() const;

#if QT_DEPRECATED_SINCE(5, 5)

    bool rawMode() const;

    void setRawMode(bool);

#endif

    // dupicated from QFontInfo

    bool exactMatch() const;

    QFont &operator=(const QFont &);

    bool operator==(const QFont &) const;

    bool operator!=(const QFont &) const;

    bool operator<(const QFont &) const;

    operator QVariant() const;

    bool isCopyOf(const QFont &) const;

    inline QFont &operator=(QFont &&other) noexcept

    { qSwap(d, other.d); qSwap(resolve_mask, other.resolve_mask);  return *this; }

#if QT_DEPRECATED_SINCE(5, 3)

    // needed for X11

    QT_DEPRECATED void setRawName(const QString &);

    QT_DEPRECATED QString rawName() const;

#endif

    QString key() const;

    QString toString() const;

    bool fromString(const QString &);

    static QString substitute(const QString &);

    static QStringList substitutes(const QString &);

    static QStringList substitutions();

    static void insertSubstitution(const QString&, const QString &);

    static void insertSubstitutions(const QString&, const QStringList &);

    static void removeSubstitutions(const QString &);

#if QT_DEPRECATED_SINCE(5, 0)

    static QT_DEPRECATED void removeSubstitution(const QString &family) { removeSubstitutions(family); }

#endif

    static void initialize();

    static void cleanup();

    static void cacheStatistics();

    QString defaultFamily() const;

#if QT_DEPRECATED_SINCE(5, 13)

    QT_DEPRECATED QString lastResortFamily() const;

    QT_DEPRECATED QString lastResortFont() const;

#endif

    QFont resolve(const QFont &) const;

    inline uint resolve() const { return resolve_mask; }

    inline void resolve(uint mask) { resolve_mask = mask; }

private:

    explicit QFont(QFontPrivate *);

    void detach();

    friend class QFontPrivate;

    friend class QFontDialogPrivate;

    friend class QFontMetrics;

    friend class QFontMetricsF;

    friend class QFontInfo;

    friend class QPainter;

    friend class QPainterPrivate;

    friend class QApplication;

    friend class QWidget;

    friend class QWidgetPrivate;

    friend class QTextLayout;

    friend class QTextEngine;

    friend class QStackTextEngine;

    friend class QTextLine;

    friend struct QScriptLine;

    friend class QOpenGLContext;

    friend class QWin32PaintEngine;

    friend class QAlphaPaintEngine;

    friend class QPainterPath;

    friend class QTextItemInt;

    friend class QPicturePaintEngine;

    friend class QPainterReplayer;

    friend class QPaintBufferEngine;

    friend class QCommandLinkButtonPrivate;

    friend class QFontEngine;

#ifndef QT_NO_DATASTREAM

    friend Q_GUI_EXPORT QDataStream &operator<<(QDataStream &, const QFont &);

    friend Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QFont &);

#endif

#ifndef QT_NO_DEBUG_STREAM

    friend Q_GUI_EXPORT QDebug operator<<(QDebug, const QFont &);

#endif

    QExplicitlySharedDataPointer<QFontPrivate> d;

    uint resolve_mask;

};

Q_DECLARE_SHARED(QFont)

Q_GUI_EXPORT uint qHash(const QFont &font, uint seed = 0) noexcept;

inline bool QFont::bold() const

{ return weight() > Medium; }

inline void QFont::setBold(bool enable)

{ setWeight(enable ? Bold : Normal); }

inline bool QFont::italic() const

{

    return (style() != StyleNormal);

}

inline void QFont::setItalic(bool b) {

    setStyle(b ? StyleItalic : StyleNormal);

}

/*****************************************************************************

  QFont stream functions

 *****************************************************************************/

#ifndef QT_NO_DATASTREAM

Q_GUI_EXPORT QDataStream &operator<<(QDataStream &, const QFont &);

Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QFont &);

#endif

#ifndef QT_NO_DEBUG_STREAM

Q_GUI_EXPORT QDebug operator<<(QDebug, const QFont &);

#endif

QT_END_NAMESPACE

#endif // QFONT_H