qgsattributesformview.h

Go to the documentation of this file.

/***************************************************************************
    qgsattributesformview.h
    ---------------------
    begin                : June 2025
    copyright            : (C) 2025 by Germán Carrillo
    email                : german at opengis dot ch
 ***************************************************************************
 *                                                                         *
 *   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 QGSATTRIBUTESFORMVIEW_H
#define QGSATTRIBUTESFORMVIEW_H
 
// We don't want to expose this in the public API
 
#include "qgis_gui.h"
#include "qgsattributesformmodel.h"
 
#include <QTreeView>
 
#define SIP_NO_FILE
 
class QgsAttributesFormTreeViewIndicator;

class GUI_EXPORT QgsAttributesFormBaseView : public QTreeView, public QgsExpressionContextGenerator
{
    Q_OBJECT
 
  public:
    explicit QgsAttributesFormBaseView( QgsVectorLayer *layer, QWidget *parent = nullptr );

    QModelIndex firstSelectedIndex() const;
 
    // QgsExpressionContextGenerator interface
    QgsExpressionContext createExpressionContext() const override;

    const QList<QgsAttributesFormTreeViewIndicator *> indicators( const QModelIndex &index ) const;

    const QList<QgsAttributesFormTreeViewIndicator *> indicators( QgsAttributesFormItem *item ) const;

    void addIndicator( QgsAttributesFormItem *item, QgsAttributesFormTreeViewIndicator *indicator );

    void removeIndicator( QgsAttributesFormItem *item, QgsAttributesFormTreeViewIndicator *indicator );

    void removeAllIndicators();

    QgsAttributesFormModel *sourceModel() const;
 
  public slots:

    void selectFirstMatchingItem( const QgsAttributesFormData::AttributesFormItemType &itemType, const QString &itemId );

    void setFilterText( const QString &text );
 
  protected:
    QgsVectorLayer *mLayer = nullptr;
    QgsAttributesFormProxyModel *mModel = nullptr;

    QHash< QgsAttributesFormItem *, QList< QgsAttributesFormTreeViewIndicator * > > mIndicators;
};
 

class GUI_EXPORT QgsAttributesAvailableWidgetsView : public QgsAttributesFormBaseView
{
    Q_OBJECT
 
  public:
    explicit QgsAttributesAvailableWidgetsView( QgsVectorLayer *layer, QWidget *parent = nullptr );

    void setModel( QAbstractItemModel *model ) override;

    QgsAttributesAvailableWidgetsModel *availableWidgetsModel() const;
};
 

class GUI_EXPORT QgsAttributesFormLayoutView : public QgsAttributesFormBaseView
{
    Q_OBJECT
 
  public:
    explicit QgsAttributesFormLayoutView( QgsVectorLayer *layer, QWidget *parent = nullptr );

    void setModel( QAbstractItemModel *model ) override;
 
  protected:
    // Drag and drop support (to handle internal moves)
    void dragEnterEvent( QDragEnterEvent *event ) override;
    void dragMoveEvent( QDragMoveEvent *event ) override;
    void dropEvent( QDropEvent *event ) override;
 
  private slots:
    void onItemDoubleClicked( const QModelIndex &index );
    void handleExternalDroppedItems( const QModelIndexList &indexes );
    void handleInternalDroppedItems( const QModelIndexList &indexes );
 
  private:
    void selectDroppedItems( const QModelIndexList &indexes );

    void storeExpandedState( const QModelIndex &sourceIndex );

    void restoreExpandedState( const QModelIndex &sourceIndex );
 
    QHash< QgsAttributesFormItem *, bool > mDraggedExpandedState;
};
 
 
#endif // QGSATTRIBUTESFORMVIEW_H