QGIS API Documentation 3.99.0-Master (26c88405ac0)
Loading...
Searching...
No Matches
qgsbrowserdockwidget.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsbrowserdockwidget.h
3 ---------------------
4 begin : July 2011
5 copyright : (C) 2011 by Martin Dobias
6 email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15#ifndef QGSBROWSERDOCKWIDGET_H
16#define QGSBROWSERDOCKWIDGET_H
17
18#include "qgis_gui.h"
19#include "qgsbrowsertreeview.h"
20#include "qgsdockwidget.h"
21#include "qgsmimedatautils.h"
22
23class QgsMessageBar;
25class QgsMapCanvas;
26
31class GUI_EXPORT QgsBrowserDockWidget : public QgsDockWidget
32{
33 Q_OBJECT
34 public:
35
42 explicit QgsBrowserDockWidget( const QString &name, QgsBrowserGuiModel *browserModel, QWidget *parent SIP_TRANSFERTHIS = nullptr );
44
51
56 Q_DECL_DEPRECATED void addFavoriteDirectory( const QString &favDir, const QString &name = QString() ) SIP_DEPRECATED;
57
67 void setMessageBar( QgsMessageBar *bar );
68
77
86 void setMapCanvas( QgsMapCanvas *canvas );
87
95
108 void setDisabledDataItemsKeys( const QStringList &filter );
109
110 public slots:
111
120 Q_DECL_DEPRECATED bool addLayerAtIndex( const QModelIndex &index ) SIP_DEPRECATED;
121
127 Q_DECL_DEPRECATED void showContextMenu( QPoint ) SIP_DEPRECATED;
128
133 Q_DECL_DEPRECATED void addFavorite() SIP_DEPRECATED;
134
139 Q_DECL_DEPRECATED void addFavoriteDirectory() SIP_DEPRECATED;
140
145 Q_DECL_DEPRECATED void removeFavorite() SIP_DEPRECATED;
146
150 void refresh();
151
157 Q_DECL_DEPRECATED void showFilterWidget( bool visible ) SIP_DEPRECATED;
158
164 Q_DECL_DEPRECATED void enablePropertiesWidget( bool enable ) SIP_DEPRECATED;
165
171 Q_DECL_DEPRECATED void setFilterSyntax( QAction * ) SIP_DEPRECATED;
172
178 Q_DECL_DEPRECATED void setCaseSensitive( bool caseSensitive ) SIP_DEPRECATED;
179
185 Q_DECL_DEPRECATED void setFilter() SIP_DEPRECATED;
186
192 Q_DECL_DEPRECATED void setActiveIndex( const QModelIndex &index ) SIP_DEPRECATED;
193
199 Q_DECL_DEPRECATED void updateProjectHome() SIP_DEPRECATED;
200
206 Q_DECL_DEPRECATED void addSelectedLayers() SIP_DEPRECATED;
207
213 Q_DECL_DEPRECATED void showProperties() SIP_DEPRECATED;
214
220 Q_DECL_DEPRECATED void hideItem() SIP_DEPRECATED;
221
226 Q_DECL_DEPRECATED void toggleFastScan() SIP_DEPRECATED;
227
233 Q_DECL_DEPRECATED void selectionChanged( const QItemSelection &selected, const QItemSelection &deselected ) SIP_DEPRECATED;
234
240 Q_DECL_DEPRECATED void splitterMoved() SIP_DEPRECATED;
241
242 signals:
244 void openFile( const QString &fileName, const QString &fileTypeHint = QString() );
246 void handleDropUriList( const QgsMimeDataUtils::UriList &uris );
249
250 private:
251 QgsBrowserWidget *mWidget = nullptr;
252};
253
254#endif // QGSBROWSERDOCKWIDGET_H
void refresh()
Refresh the browser model and view.
Q_DECL_DEPRECATED void enablePropertiesWidget(bool enable)
Enable/disable properties widget.
Q_DECL_DEPRECATED void addSelectedLayers()
Add selected layers to the project.
Q_DECL_DEPRECATED void toggleFastScan()
Toggle fast scan.
Q_DECL_DEPRECATED void addFavoriteDirectory(const QString &favDir, const QString &name=QString())
Add directory to favorites.
QgsMapCanvas * mapCanvas()
Returns the map canvas associated with the dock.
~QgsBrowserDockWidget() override
QgsBrowserDockWidget(const QString &name, QgsBrowserGuiModel *browserModel, QWidget *parent=nullptr)
Constructor for QgsBrowserDockWidget.
void connectionsChanged()
Connections changed in the browser.
Q_DECL_DEPRECATED void showContextMenu(QPoint)
Show context menu.
Q_DECL_DEPRECATED void showProperties()
Show the layer properties.
Q_DECL_DEPRECATED void setActiveIndex(const QModelIndex &index)
Sets the selection to index and expand it.
void setMapCanvas(QgsMapCanvas *canvas)
Sets a map canvas to use alongside the dock.
Q_DECL_DEPRECATED void removeFavorite()
Remove from favorite.
Q_DECL_DEPRECATED void setFilter()
Apply filter to the model.
QgsBrowserWidget * browserWidget()
Returns a pointer to the QgsBrowserWidget used by the dock widget.
QgsMessageBar * messageBar()
Returns the message bar associated with the dock.
Q_DECL_DEPRECATED void setCaseSensitive(bool caseSensitive)
Sets filter case sensitivity.
void handleDropUriList(const QgsMimeDataUtils::UriList &uris)
Emitted when drop uri list needs to be handled.
Q_DECL_DEPRECATED void hideItem()
Hide current item.
void setMessageBar(QgsMessageBar *bar)
Sets a message bar to use alongside the dock widget.
Q_DECL_DEPRECATED void addFavorite()
Add current item to favorite.
Q_DECL_DEPRECATED void showFilterWidget(bool visible)
Show/hide filter widget.
Q_DECL_DEPRECATED void selectionChanged(const QItemSelection &selected, const QItemSelection &deselected)
Selection has changed.
Q_DECL_DEPRECATED void setFilterSyntax(QAction *)
Sets filter syntax.
Q_DECL_DEPRECATED void updateProjectHome()
Update project home directory.
void openFile(const QString &fileName, const QString &fileTypeHint=QString())
Emitted when a file needs to be opened.
Q_DECL_DEPRECATED void splitterMoved()
Splitter has been moved.
Q_DECL_DEPRECATED bool addLayerAtIndex(const QModelIndex &index)
Adds the layer corresponding to the specified model index.
void setDisabledDataItemsKeys(const QStringList &filter)
Sets the customization for data items based on item's data provider key.
A model for showing available data sources and other items in a structured tree.
A widget showing a browser tree view along with toolbar and toggleable properties pane.
QgsDockWidget(QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
Constructor for QgsDockWidget.
Map canvas is a class for displaying all GIS data types on a canvas.
A bar for displaying non-blocking messages to the user.
Contains utility functions for working with MIME data.
#define SIP_DEPRECATED
Definition qgis_sip.h:114
#define SIP_TRANSFERTHIS
Definition qgis_sip.h:53