qgslabelingengineruleswidget.h

Go to the documentation of this file.

/***************************************************************************
    qgslabelingengineruleswidget.h
    ------------------------
    begin                : September 2024
    copyright            : (C) 2024 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 QGSLABELINGENGINERULESWIDGET_H
#define QGSLABELINGENGINERULESWIDGET_H
 
#include "ui_qgslabelingengineruleswidgetbase.h"
 
#include "qgis_sip.h"
#include "qgsguiutils.h"
#include "qgspanelwidget.h"
 
#include <QAbstractItemModel>
#include <QDialog>
 
class QgsAbstractLabelingEngineRule;
class QDialogButtonBox;
 
#ifndef SIP_RUN
class QgsLabelingEngineRulesModel : public QAbstractItemModel
{
    Q_OBJECT
 
  public:
    explicit QgsLabelingEngineRulesModel( QObject *parent SIP_TRANSFERTHIS = nullptr );
    ~QgsLabelingEngineRulesModel() override;
 
    // QAbstractItemModel interface
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    QModelIndex parent( const QModelIndex &child ) const override;
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;
    QModelIndex index( int row, int column, const QModelIndex &parent ) const override;
    bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override;
    bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;

    void setRules( const QList<QgsAbstractLabelingEngineRule *> &rules );

    void addRule( std::unique_ptr<QgsAbstractLabelingEngineRule> &rule );

    QgsAbstractLabelingEngineRule *ruleAtIndex( const QModelIndex &index ) const;

    void changeRule( const QModelIndex &index, std::unique_ptr<QgsAbstractLabelingEngineRule> &rule );

    QList<QgsAbstractLabelingEngineRule *> rules() const;
 
  private:
    std::vector<std::unique_ptr<QgsAbstractLabelingEngineRule>> mRules;
};
 
#endif
 

class GUI_EXPORT QgsLabelingEngineRulesWidget : public QgsPanelWidget, private Ui_QgsLabelingEngineRulesWidgetBase
{
    Q_OBJECT
 
  public:
    QgsLabelingEngineRulesWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void setRules( const QList<QgsAbstractLabelingEngineRule *> &rules );

    QList<QgsAbstractLabelingEngineRule *> rules() const SIP_TRANSFERBACK;
 
  signals:

    void changed();
 
  private slots:
 
    void createTypesMenu();
    void createRule( const QString &id );
    void editSelectedRule();
    void editRule( const QModelIndex &index );
    void removeRules();
 
  private:
    QgsLabelingEngineRulesModel *mModel = nullptr;
    QMenu *mAddRuleMenu = nullptr;
};
 

class GUI_EXPORT QgsLabelingEngineRulesDialog : public QDialog
{
    Q_OBJECT
 
  public:
    QgsLabelingEngineRulesDialog( QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = QgsGuiUtils::ModalDialogFlags );

    void setRules( const QList<QgsAbstractLabelingEngineRule *> &rules );

    QList<QgsAbstractLabelingEngineRule *> rules() const SIP_TRANSFERBACK;
 
  private:
    QgsLabelingEngineRulesWidget *mWidget = nullptr;
    QDialogButtonBox *mButtonBox = nullptr;
};
 
 
#endif // QGSLABELINGENGINERULESWIDGET_H