dfontproperties.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2008-12-23
 * Description : a widget to change font properties.
 *
 * Copyright (C) 2008-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C)      1996 by Bernd Johannes Wuebben  <wuebben at kde dot org>
 * Copyright (c)      1999 by Preston Brown <pbrown at kde dot org>
 * Copyright (c)      1999 by Mario Weilguni <mweilguni at kde dot org>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_DFONT_PROPERTIES_H
#define DIGIKAM_DFONT_PROPERTIES_H
 
// Qt includes
 
#include <QWidget>
#include <QColor>
#include <QFont>
#include <QStringList>
 
// Local includes
 
#include "digikam_export.h"
 
class QFont;
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DFontProperties : public QWidget
{
    Q_OBJECT
    Q_PROPERTY(QFont font READ font WRITE setFont NOTIFY fontSelected USER true)
    Q_PROPERTY(QColor color READ color WRITE setColor)
    Q_PROPERTY(QColor backgroundColor READ backgroundColor WRITE setBackgroundColor)
    Q_PROPERTY(Qt::CheckState sizeIsRelative READ sizeIsRelative WRITE setSizeIsRelative)
    Q_PROPERTY(QString sampleText READ sampleText WRITE setSampleText)
 
public:
 
    enum FontColumn
    {
        FamilyList = 0x01,
        StyleList  = 0x02,
        SizeList   = 0x04
    };
 
    enum FontDiff
    {
        NoFontDiffFlags = 0,
        FontDiffFamily  = 1,
        FontDiffStyle   = 2,
        FontDiffSize    = 4,
        AllFontDiffs    = FontDiffFamily | FontDiffStyle | FontDiffSize
    };
    Q_DECLARE_FLAGS(FontDiffFlags, FontDiff)
 
    
    enum DisplayFlag
    {
        NoDisplayFlags  = 0,
        FixedFontsOnly  = 1,
        DisplayFrame    = 2,
        ShowDifferences = 4
    };
    Q_DECLARE_FLAGS(DisplayFlags, DisplayFlag)
 
    
    enum FontListCriteria
    {
        FixedWidthFonts     = 0x01,
        ScalableFonts       = 0x02,
        SmoothScalableFonts = 0x04
    };
 
public:
 
    explicit DFontProperties(QWidget* const parent = nullptr,
                             const DisplayFlags& flags = DisplayFrame,
                             const QStringList& fontList = QStringList(),
                             int visibleListSize = 8,
                             Qt::CheckState* const sizeIsRelativeState = nullptr);
 
    ~DFontProperties() override;
 
    void enableColumn(int column, bool state);
 
    void makeColumnVisible(int column, bool state);
 
    void setFont(const QFont& font, bool onlyFixed = false);
 
    FontDiffFlags fontDiffFlags() const;
 
    QFont font() const;
 
    void setColor(const QColor& col);
 
    QColor color() const;
 
    void setBackgroundColor(const QColor& col);
 
    QColor backgroundColor() const;
 
    void setSizeIsRelative(Qt::CheckState relative);
 
    Qt::CheckState sizeIsRelative() const;
 
    QString sampleText() const;
 
    void setSampleText(const QString& text);
 
    void setSampleBoxVisible(bool visible);
 
    static void getFontList(QStringList& list, uint fontListCriteria);
 
    QSize sizeHint(void) const override;
 
Q_SIGNALS:
 
    void fontSelected(const QFont& font);
 
private:
 
    class Private;
    Private* const d;
 
    Q_DISABLE_COPY(DFontProperties)
 
    Q_PRIVATE_SLOT(d, void _d_toggled_checkbox())
    Q_PRIVATE_SLOT(d, void _d_family_chosen_slot(const QString&))
    Q_PRIVATE_SLOT(d, void _d_size_chosen_slot(const QString&))
    Q_PRIVATE_SLOT(d, void _d_style_chosen_slot(const QString&))
    Q_PRIVATE_SLOT(d, void _d_displaySample(const QFont& font))
    Q_PRIVATE_SLOT(d, void _d_size_value_slot(double))
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS(DFontProperties::DisplayFlags)
 
} // namespace Digikam
 
#endif // DIGIKAM_DFONT_PROPERTIES_H