qgsrasterattributetablemodel.h

Go to the documentation of this file.

/***************************************************************************
  qgsrasterattributetablemodel.h - QgsRasterAttributeTableModel
 
 ---------------------
 begin                : 29.9.2022
 copyright            : (C) 2022 by Alessandro Pasotti
 email                : elpaso at itopen dot it
 ***************************************************************************
 *                                                                         *
 *   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 QGSRASTERATTRIBUTETABLEMODEL_H
#define QGSRASTERATTRIBUTETABLEMODEL_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsrasterattributetable.h"
 
#include <QAbstractTableModel>
#include <QObject>

class GUI_EXPORT QgsRasterAttributeTableModel : public QAbstractTableModel
{
    Q_OBJECT
 
  public:

    explicit QgsRasterAttributeTableModel( QgsRasterAttributeTable *rat, QObject *parent SIP_TRANSFERTHIS = nullptr );

    bool editable() const;

    void setEditable( bool editable );

    bool hasColor() const;

    bool hasRamp() const;

    QStringList headerNames() const;

    QString headerTooltip( const int section ) const;

    bool isValid( QString *errorMessage SIP_OUT = nullptr );

    bool isDirty();
 
    // Raster Attribute Table operations

    bool insertField( const int position, const QString &name, const Qgis::RasterAttributeTableFieldUsage usage, const QMetaType::Type type, QString *errorMessage SIP_OUT = nullptr );

    Q_DECL_DEPRECATED bool insertField( const int position, const QString &name, const Qgis::RasterAttributeTableFieldUsage usage, const QVariant::Type type, QString *errorMessage SIP_OUT = nullptr ) SIP_DEPRECATED;

    bool removeField( const int position, QString *errorMessage SIP_OUT = nullptr );

    bool removeColorOrRamp( QString *errorMessage SIP_OUT = nullptr );

    bool insertRow( const int position, const QVariantList &rowData, QString *errorMessage SIP_OUT = nullptr );

    bool insertColor( int position, QString *errorMessage SIP_OUT = nullptr );

    bool insertRamp( int position, QString *errorMessage SIP_OUT = nullptr );

    bool removeRow( const int position, QString *errorMessage SIP_OUT = nullptr );
 
  private:
    QgsRasterAttributeTable *mRat = nullptr;
    bool mEditable = false;
 
    // Checks for rat not nullptr and editable state
    bool editChecks( QString *errorMessage = nullptr );
 
    QString ratColorHeaderName() const;
 
    // QAbstractItemModel interface
  public:
    int rowCount( const QModelIndex &parent ) const override;
    int columnCount( const QModelIndex &parent ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role ) override;
    QVariant headerData( int section, Qt::Orientation orientation, int role ) const override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
};
 
#endif // QGSRASTERATTRIBUTETABLEMODEL_H