qgsfontbutton.h

Go to the documentation of this file.

/***************************************************************************
     qgsfontbutton.h
     ---------------
    Date                 : May 2017
    Copyright            : (C) 2017 by Nyall Dawson
    Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSFONTBUTTON_H
#define QGSFONTBUTTON_H

#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgstextrenderer.h"

#include <QToolButton>

class QgsExpressionContextGenerator;
class QgsMapCanvas;
class QgsMessageBar;

class GUI_EXPORT QgsFontButton : public QToolButton
{
    Q_OBJECT

    Q_PROPERTY( Mode mode READ mode WRITE setMode )
    Q_PROPERTY( QString dialogTitle READ dialogTitle WRITE setDialogTitle )
    Q_PROPERTY( QFont currentFont READ currentFont WRITE setCurrentFont NOTIFY changed )
    Q_PROPERTY( QgsTextFormat textFormat READ textFormat WRITE setTextFormat NOTIFY changed )

  public:

    enum Mode
    {
      ModeTextRenderer,  
      ModeQFont, 
    };

    Q_ENUM( Mode )

    
    QgsFontButton( QWidget *parent SIP_TRANSFERTHIS = nullptr, const QString &dialogTitle = QString() );

    QSize minimumSizeHint() const override;
    QSize sizeHint() const override;

    QgsFontButton::Mode mode() const;

    void setMode( Mode mode );

    void setDialogTitle( const QString &title );

    QString dialogTitle() const;

    QgsMapCanvas *mapCanvas() const;

    void setMapCanvas( QgsMapCanvas *canvas );

    void setMessageBar( QgsMessageBar *bar );

    QgsMessageBar *messageBar() const;

    QgsTextFormat textFormat() const { return mFormat; }

    QFont currentFont() const;

    QgsVectorLayer *layer() const;

    void setLayer( QgsVectorLayer *layer );

    void registerExpressionContextGenerator( QgsExpressionContextGenerator *generator );

  public slots:

    void setTextFormat( const QgsTextFormat &format );

    void setCurrentFont( const QFont &font );

    void setColor( const QColor &color );

    void copyFormat();

    void pasteFormat();

    void copyColor();

    void pasteColor();

  signals:

    void changed();

  protected:

    bool event( QEvent *e ) override;
    void changeEvent( QEvent *e ) override;
    void showEvent( QShowEvent *e ) override;
    void resizeEvent( QResizeEvent *event ) override;

    // Reimplemented to detect right mouse button clicks on the color button and allow dragging colors
    void mousePressEvent( QMouseEvent *e ) override;
    // Reimplemented to allow dragging fonts from button
    void mouseMoveEvent( QMouseEvent *e ) override;

    // Reimplemented to accept dragged colors
    void dragEnterEvent( QDragEnterEvent *e ) override;

    // Reimplemented to reset button appearance after drag leave
    void dragLeaveEvent( QDragLeaveEvent *e ) override;

    // Reimplemented to accept dropped colors
    void dropEvent( QDropEvent *e ) override;

    void wheelEvent( QWheelEvent *event ) override;

  private slots:

    void showSettingsDialog();

    void prepareMenu();

    void addRecentColor( const QColor &color );

  private:

    QSize mSizeHint;

    Mode mMode = ModeTextRenderer;

    QString mDialogTitle;
    QgsTextFormat mFormat;
    QFont mFont;

    QgsMapCanvas *mMapCanvas = nullptr;
    QgsMessageBar *mMessageBar = nullptr;

    QPoint mDragStartPosition;

    QMenu *mMenu = nullptr;

    QPointer< QgsVectorLayer > mLayer;

    QSize mIconSize;

    QgsExpressionContextGenerator *mExpressionContextGenerator = nullptr;

    bool formatFromMimeData( const QMimeData *mimeData, QgsTextFormat &resultFormat ) const;


    bool fontFromMimeData( const QMimeData *mimeData, QFont &resultFont ) const;

    bool colorFromMimeData( const QMimeData *mimeData, QColor &resultColor, bool &hasAlpha );

    QPixmap createColorIcon( const QColor &color ) const;

    QPixmap createDragIcon( QSize size = QSize( 50, 50 ), const QgsTextFormat *tempFormat = nullptr, const QFont *tempFont = nullptr ) const;

    void updatePreview( const QColor &color = QColor(), QgsTextFormat *tempFormat = nullptr, QFont *tempFont = nullptr );
};

#endif // QGSFONTBUTTON_H