qgsmodelgraphicitem.h

Go to the documentation of this file.

/***************************************************************************
                             qgsmodelgraphicitem.h
                             ----------------------------------
    Date                 : February 2020
    Copyright            : (C) 2020 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 QGSMODELGRAPHICITEM_H
#define QGSMODELGRAPHICITEM_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgsmodelcomponentgraphicitem.h"
 
#include <QGraphicsObject>
#include <QPicture>
 
class QgsModelGraphicsView;
class QgsModelViewMouseEvent;

 

class GUI_EXPORT QgsModelDesignerFlatButtonGraphicItem : public QGraphicsObject
{
    Q_OBJECT
  public:
    QgsModelDesignerFlatButtonGraphicItem( QGraphicsItem *parent SIP_TRANSFERTHIS, const QPicture &picture, const QPointF &position, const QSizeF &size = QSizeF( 16, 16 ) );
 
    void paint( QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr ) override;
    QRectF boundingRect() const override;
    void hoverEnterEvent( QGraphicsSceneHoverEvent *event ) override;
    void hoverLeaveEvent( QGraphicsSceneHoverEvent *event ) override;
    void mousePressEvent( QGraphicsSceneMouseEvent *event ) override;
 
#ifndef SIP_RUN

    virtual void modelHoverEnterEvent( QgsModelViewMouseEvent *event );

    virtual void modelHoverLeaveEvent( QgsModelViewMouseEvent *event );

    virtual void modelPressEvent( QgsModelViewMouseEvent *event );
#endif

    QPointF position() const { return mPosition; };
 

    void setPosition( const QPointF &position );

    QgsModelGraphicsView *view();
 
  signals:

    void clicked();
 
  protected:
    void setPicture( const QPicture &picture );
    bool mHoverState = false;
 
  private:
    QPicture mPicture;
    QPointF mPosition;
    QSizeF mSize;
};
 

class GUI_EXPORT QgsModelDesignerFoldButtonGraphicItem : public QgsModelDesignerFlatButtonGraphicItem
{
    Q_OBJECT
  public:
    QgsModelDesignerFoldButtonGraphicItem( QGraphicsItem *parent SIP_TRANSFERTHIS, bool folded, const QPointF &position, const QSizeF &size = QSizeF( 11, 11 ) );
 
    void mousePressEvent( QGraphicsSceneMouseEvent *event ) override;
#ifndef SIP_RUN
    void modelPressEvent( QgsModelViewMouseEvent *event ) override;
#endif
 
  signals:

    void folded( bool folded );
 
  private:
    QPicture mPlusPicture;
    QPicture mMinusPicture;
    bool mFolded = false;
};
 

class GUI_EXPORT QgsModelDesignerSocketGraphicItem : public QgsModelDesignerFlatButtonGraphicItem
{
    Q_OBJECT
  public:
    QgsModelDesignerSocketGraphicItem( QgsModelComponentGraphicItem *parent SIP_TRANSFERTHIS, QgsProcessingModelComponent *component, int index, const QPointF &position, Qt::Edge edge, const QSizeF &size = QSizeF( 11, 11 ) );
 
    void paint( QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr ) override;

    int index() const { return mIndex; };

    Qt::Edge edge() const { return mEdge; };

    bool isInput() const { return mEdge == Qt::TopEdge; };

    QgsProcessingModelComponent *component() { return mComponent; };

    QgsModelComponentGraphicItem *componentItem() { return mComponentItem; };
 
    /*
     * Returns the color of the socket based on the type of data the param corresponds to.
     * \since QGIS 4.0
     */
    QColor socketColor() const;
 
    /*
     * Returns TRUE if the parameter is set to the default parameter value.
     * \since QGIS 4.0
     */
    bool isDefaultParameterValue() const;
 
  signals:
 
 
  private:
    QgsModelComponentGraphicItem *mComponentItem = nullptr;
    QgsProcessingModelComponent *mComponent = nullptr;
    int mIndex = -1;
    Qt::Edge mEdge = Qt::Edge::TopEdge;
    float mSocketOutlineWidth = 1.5;
};

 
#endif // QGSMODELGRAPHICITEM_H