qgslayoutitemslistview.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayoutitemslistview.h
                             ------------------------
    Date                 : October 2017
    Copyright            : (C) 2017 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 QGSLAYOUTITEMSLISTVIEW_H
#define QGSLAYOUTITEMSLISTVIEW_H
 
// We don't want to expose this in the public API
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QSortFilterProxyModel>
#include <QTreeView>
 
#define SIP_NO_FILE
 
class QgsLayout;
class QgsLayoutDesignerInterface;
class QgsLayoutModel;
class QgsLayoutItem;
class QgsLayoutView;

class GUI_EXPORT QgsLayoutItemsListViewModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
  public:
    QgsLayoutItemsListViewModel( QgsLayoutModel *model, QObject *parent );

    QgsLayoutItem *itemFromIndex( const QModelIndex &index ) const;
    QModelIndex indexForItem( QgsLayoutItem *item, const int column = 0 ) const;
    QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;
 
  public slots:
    void setSelected( const QModelIndex &index );
 
  protected:
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;
 
  private:
    QgsLayoutModel *mModel = nullptr;
};

class GUI_EXPORT QgsLayoutItemsListView : public QTreeView
{
    Q_OBJECT
 
  public:
    QgsLayoutItemsListView( QWidget *parent, QgsLayoutDesignerInterface *designer );

    void setCurrentLayout( QgsLayout *layout );
 
  protected:
    void keyPressEvent( QKeyEvent *event ) override;
 
  private slots:
 
    void setLayoutView( QgsLayoutView *view );
 
    void showContextMenu( QPoint point );

    void updateSelection( const QItemSelection &selected, const QItemSelection &deselected );
    void onItemFocused( QgsLayoutItem *focusedItem );
 
  private:
    QgsLayout *mLayout = nullptr;
    QgsLayoutItemsListViewModel *mModel = nullptr;
    QgsLayoutDesignerInterface *mDesigner = nullptr;
 
    bool mUpdatingSelection = false;
    bool mUpdatingFromView = false;
 
    friend class TestQgsLayoutItemListView;
};
 
#endif // QGSLAYOUTITEMSLISTVIEW_H