qgsprocessingmodelcomponent.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingmodelcomponent.h
                         -----------------------------
    begin                : June 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 QGSPROCESSINGMODELCOMPONENT_H
#define QGSPROCESSINGMODELCOMPONENT_H
 
#include "qgis.h"
#include "qgis_core.h"
 
#include <QColor>
#include <QPointF>
#include <QSizeF>
 
class QgsProcessingModelComment;


class CORE_EXPORT QgsProcessingModelComponent
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast<QgsProcessingModelChildAlgorithm *>( sipCpp ) != NULL )
      sipType = sipType_QgsProcessingModelChildAlgorithm;
    else if ( dynamic_cast<QgsProcessingModelComment *>( sipCpp ) != NULL )
      sipType = sipType_QgsProcessingModelComment;
    else if ( dynamic_cast<QgsProcessingModelGroupBox *>( sipCpp ) != NULL )
      sipType = sipType_QgsProcessingModelGroupBox;
    else if ( dynamic_cast<QgsProcessingModelOutput *>( sipCpp ) != NULL )
      sipType = sipType_QgsProcessingModelOutput;
    else if ( dynamic_cast<QgsProcessingModelParameter *>( sipCpp ) != NULL )
      sipType = sipType_QgsProcessingModelParameter;
    else
      sipType = NULL;
  SIP_END
#endif
 
  public:
 
    virtual ~QgsProcessingModelComponent() = default;

    QString description() const;

    void setDescription( const QString &description );

    QPointF position() const;

    void setPosition( QPointF position );

    QSizeF size() const;

    void setSize( QSizeF size );

    QColor color() const;

    void setColor( const QColor &color );

    bool linksCollapsed( Qt::Edge edge ) const;

    void setLinksCollapsed( Qt::Edge edge, bool collapsed );

    SIP_SKIP virtual const QgsProcessingModelComment *comment() const { return nullptr; }

    virtual QgsProcessingModelComment *comment() { return nullptr; }

    virtual void setComment( const QgsProcessingModelComment &comment );

    virtual QgsProcessingModelComponent *clone() const = 0 SIP_FACTORY;
 
  protected:
    QgsProcessingModelComponent( const QString &description = QString() );

    QgsProcessingModelComponent( const QgsProcessingModelComponent &other ) = default;

    QgsProcessingModelComponent &operator=( const QgsProcessingModelComponent &other ) = default;

    void saveCommonProperties( QVariantMap &map ) const;

    void restoreCommonProperties( const QVariantMap &map );

    void copyNonDefinitionProperties( const QgsProcessingModelComponent &other );
 
  private:
    static constexpr double DEFAULT_COMPONENT_WIDTH = 200;
    static constexpr double DEFAULT_COMPONENT_HEIGHT = 30;

    QPointF mPosition;
 
    QString mDescription;
 
    QSizeF mSize = QSizeF( DEFAULT_COMPONENT_WIDTH, DEFAULT_COMPONENT_HEIGHT );
    QColor mColor;
 
    bool mTopEdgeLinksCollapsed = true;
    bool mBottomEdgeLinksCollapsed = true;
};

 
#endif // QGSPROCESSINGMODELCOMPONENT_H