qgsbrowserwidget.h

Go to the documentation of this file.

/***************************************************************************
    qgsbrowserwidget.h
    ---------------------
    begin                : July 2011
    copyright            : (C) 2011 by Martin Dobias
    email                : wonder dot sk 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 QGSBROWSERWIDGET_H
#define QGSBROWSERWIDGET_H
 
#include "ui_qgsbrowserwidgetbase.h"
 
#include "qgis_gui.h"
#include "qgsmimedatautils.h"
#include "qgspanelwidget.h"
 
class QgsBrowserGuiModel;
class QgsDockBrowserTreeView;
class QgsLayerItem;
class QgsDataItem;
class QgsBrowserProxyModel;
class QgsMessageBar;
class QgsMapCanvas;
class QgsDataItemGuiContext;
 
class QModelIndex;
class QItemSelection;

class GUI_EXPORT QgsBrowserWidget : public QgsPanelWidget, private Ui::QgsBrowserWidgetBase
{
    Q_OBJECT
  public:
    explicit QgsBrowserWidget( QgsBrowserGuiModel *browserModel, QWidget *parent SIP_TRANSFERTHIS = nullptr );
    ~QgsBrowserWidget() override;

    void setMessageBar( QgsMessageBar *bar );

    QgsMessageBar *messageBar();

    void setMapCanvas( QgsMapCanvas *canvas );

    QgsMapCanvas *mapCanvas();

    void setDisabledDataItemsKeys( const QStringList &filter );
 
  public slots:

    void updateProjectHome() SIP_SKIP;

    void setActiveIndex( const QModelIndex &index ) SIP_SKIP;

    void refresh();
 
    // keep the stable API slim for now!
#ifndef SIP_RUN
 
  signals:
    void openFile( const QString &fileName, const QString &fileTypeHint = QString() );
    void handleDropUriList( const QgsMimeDataUtils::UriList & );
    void connectionsChanged();
 
#endif
 
  protected:
    void showEvent( QShowEvent *event ) override;
 
  private slots:
    void itemDoubleClicked( const QModelIndex &index );
    void onOptionsChanged();

    void showContextMenu( QPoint );

    void showFilterWidget( bool visible );
    void enablePropertiesWidget( bool enable );
 
    void propertiesWidgetToggled( bool enabled );

    void setFilterSyntax( QAction * );
    void setCaseSensitive( bool caseSensitive );
    void setFilter();

    void addSelectedLayers();
    void showProperties();
    void hideItem();
 
  private:
    void selectionChanged( const QItemSelection &selected, const QItemSelection &deselected );
    void splitterMoved();
    void refreshModel( const QModelIndex &index );
    void addLayer( QgsLayerItem *layerItem );
    void clearPropertiesWidget();
    void setPropertiesWidget();

    int selectedItemsCount();
    QString settingsSection() { return objectName().toLower(); }
 
    QgsDataItemGuiContext createContext();
 
    QgsDockBrowserTreeView *mBrowserView = nullptr;
    QgsBrowserGuiModel *mModel = nullptr;
    QgsBrowserProxyModel *mProxyModel = nullptr;
    QString mInitPath;
 
    QgsMessageBar *mMessageBar = nullptr;
    QgsMapCanvas *mMapCanvas = nullptr;
    QStringList mDisabledDataItemsKeys;
 
    friend class QgsBrowserDockWidget;
};
 
#endif // QGSBROWSERWIDGET_H