QGIS API Documentation
3.26.3-Buenos Aires (65e4edfdad)
|
A dock widget containing a QgsBrowserWidget for navigating and managing data sources. More...
#include <qgsbrowserdockwidget.h>
Public Slots | |
Q_DECL_DEPRECATED void | addFavorite () |
Add current item to favorite. More... | |
Q_DECL_DEPRECATED void | addFavoriteDirectory () |
Add directory from file dialog to favorite. More... | |
Q_DECL_DEPRECATED bool | addLayerAtIndex (const QModelIndex &index) |
Adds the layer corresponding to the specified model index. More... | |
Q_DECL_DEPRECATED void | addSelectedLayers () |
Add selected layers to the project. More... | |
Q_DECL_DEPRECATED void | enablePropertiesWidget (bool enable) |
Enable/disable properties widget. More... | |
Q_DECL_DEPRECATED void | hideItem () |
Hide current item. More... | |
void | refresh () |
Refresh the browser model and view. More... | |
Q_DECL_DEPRECATED void | removeFavorite () |
Remove from favorite. More... | |
Q_DECL_DEPRECATED void | selectionChanged (const QItemSelection &selected, const QItemSelection &deselected) |
Selection has changed. More... | |
Q_DECL_DEPRECATED void | setActiveIndex (const QModelIndex &index) |
Sets the selection to index and expand it. More... | |
Q_DECL_DEPRECATED void | setCaseSensitive (bool caseSensitive) |
Sets filter case sensitivity. More... | |
Q_DECL_DEPRECATED void | setFilter () |
Apply filter to the model. More... | |
Q_DECL_DEPRECATED void | setFilterSyntax (QAction *) |
Sets filter syntax. More... | |
Q_DECL_DEPRECATED void | showContextMenu (QPoint) |
Show context menu. More... | |
Q_DECL_DEPRECATED void | showFilterWidget (bool visible) |
Show/hide filter widget. More... | |
Q_DECL_DEPRECATED void | showProperties () |
Show the layer properties. More... | |
Q_DECL_DEPRECATED void | splitterMoved () |
Splitter has been moved. More... | |
Q_DECL_DEPRECATED void | toggleFastScan () |
Toggle fast scan. More... | |
Q_DECL_DEPRECATED void | updateProjectHome () |
Update project home directory. More... | |
![]() | |
void | setUserVisible (bool visible) |
Sets the dock widget as visible to a user, ie both shown and raised to the front. More... | |
void | toggleUserVisible () |
Toggles whether the dock is user visible. More... | |
Signals | |
void | connectionsChanged () |
Connections changed in the browser. More... | |
void | handleDropUriList (const QgsMimeDataUtils::UriList &) |
Emitted when drop uri list needs to be handled. More... | |
void | openFile (const QString &fileName, const QString &fileTypeHint=QString()) |
Emitted when a file needs to be opened. More... | |
![]() | |
void | closed () |
Emitted when dock widget is closed. More... | |
void | closedStateChanged (bool wasClosed) |
Emitted when dock widget is closed (or opened). More... | |
void | opened () |
Emitted when dock widget is opened. More... | |
void | openedStateChanged (bool wasOpened) |
Emitted when dock widget is opened (or closed). More... | |
Public Member Functions | |
QgsBrowserDockWidget (const QString &name, QgsBrowserGuiModel *browserModel, QWidget *parent=nullptr) | |
Constructor for QgsBrowserDockWidget. More... | |
~QgsBrowserDockWidget () override | |
Q_DECL_DEPRECATED void | addFavoriteDirectory (const QString &favDir, const QString &name=QString()) |
Add directory to favorites. More... | |
QgsBrowserWidget * | browserWidget () |
Returns a pointer to the QgsBrowserWidget used by the dock widget. More... | |
QgsMessageBar * | messageBar () |
Returns the message bar associated with the dock. More... | |
void | setDisabledDataItemsKeys (const QStringList &filter) |
Sets the customization for data items based on item's data provider key. More... | |
void | setMessageBar (QgsMessageBar *bar) |
Sets a message bar to use alongside the dock widget. More... | |
![]() | |
QgsDockWidget (const QString &title, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags()) | |
Constructor for QgsDockWidget. More... | |
QgsDockWidget (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags()) | |
Constructor for QgsDockWidget. More... | |
bool | isUserVisible () const |
Returns true if the dock is both opened and raised to the front (ie not hidden by any other tabs. More... | |
void | setToggleVisibilityAction (QAction *action) |
Links an action to the dock, so that toggling the action will automatically set the dock's visibility to suit (and changing the dock visibility will update the action's state). More... | |
QAction * | toggleVisibilityAction () |
Returns the action linked to the dock. More... | |
Additional Inherited Members | |
![]() | |
void | closeEvent (QCloseEvent *) override |
void | showEvent (QShowEvent *event) override |
A dock widget containing a QgsBrowserWidget for navigating and managing data sources.
Definition at line 31 of file qgsbrowserdockwidget.h.
|
explicit |
Constructor for QgsBrowserDockWidget.
name | name of the widget |
browserModel | instance of the (shared) browser model |
parent | parent widget |
Definition at line 27 of file qgsbrowserdockwidget.cpp.
|
overridedefault |
|
slot |
Add current item to favorite.
Definition at line 59 of file qgsbrowserdockwidget.cpp.
|
slot |
Add directory from file dialog to favorite.
Definition at line 75 of file qgsbrowserdockwidget.cpp.
void QgsBrowserDockWidget::addFavoriteDirectory | ( | const QString & | favDir, |
const QString & | name = QString() |
||
) |
Add directory to favorites.
Definition at line 86 of file qgsbrowserdockwidget.cpp.
|
slot |
Adds the layer corresponding to the specified model index.
Returns true
if the index was successfully intrepreted as a map layer and loaded, or false
if the index is not a map layer or could not be loaded.
Definition at line 116 of file qgsbrowserdockwidget.cpp.
|
slot |
Add selected layers to the project.
Definition at line 146 of file qgsbrowserdockwidget.cpp.
QgsBrowserWidget * QgsBrowserDockWidget::browserWidget | ( | ) |
Returns a pointer to the QgsBrowserWidget used by the dock widget.
Definition at line 49 of file qgsbrowserdockwidget.cpp.
|
signal |
Connections changed in the browser.
|
slot |
Enable/disable properties widget.
Definition at line 216 of file qgsbrowserdockwidget.cpp.
|
signal |
Emitted when drop uri list needs to be handled.
|
slot |
Hide current item.
Definition at line 151 of file qgsbrowserdockwidget.cpp.
QgsMessageBar * QgsBrowserDockWidget::messageBar | ( | ) |
Returns the message bar associated with the dock.
Definition at line 96 of file qgsbrowserdockwidget.cpp.
|
signal |
Emitted when a file needs to be opened.
|
slot |
Refresh the browser model and view.
Definition at line 111 of file qgsbrowserdockwidget.cpp.
|
slot |
Remove from favorite.
Definition at line 106 of file qgsbrowserdockwidget.cpp.
|
slot |
Selection has changed.
Definition at line 211 of file qgsbrowserdockwidget.cpp.
|
slot |
Sets the selection to index and expand it.
Definition at line 221 of file qgsbrowserdockwidget.cpp.
|
slot |
Sets filter case sensitivity.
Definition at line 206 of file qgsbrowserdockwidget.cpp.
void QgsBrowserDockWidget::setDisabledDataItemsKeys | ( | const QStringList & | filter | ) |
Sets the customization for data items based on item's data provider key.
By default browser model shows all items from all available data items provider and few special items (e.g. Favorites). To customize the behavior, set the filter to not load certain data items. The items that are not based on data item providers (e.g. Favorites, Home) have prefix "special:"
Used in the proxy browser model to hide items
Definition at line 101 of file qgsbrowserdockwidget.cpp.
|
slot |
Apply filter to the model.
Definition at line 191 of file qgsbrowserdockwidget.cpp.
|
slot |
Sets filter syntax.
Definition at line 201 of file qgsbrowserdockwidget.cpp.
void QgsBrowserDockWidget::setMessageBar | ( | QgsMessageBar * | bar | ) |
Sets a message bar to use alongside the dock widget.
Setting this allows items to utilize the message bar to provide non-blocking feedback to users, e.g. success or failure of actions.
Definition at line 91 of file qgsbrowserdockwidget.cpp.
|
slot |
Show context menu.
Definition at line 54 of file qgsbrowserdockwidget.cpp.
|
slot |
Show/hide filter widget.
Definition at line 186 of file qgsbrowserdockwidget.cpp.
|
slot |
Show the layer properties.
Definition at line 156 of file qgsbrowserdockwidget.cpp.
|
slot |
Splitter has been moved.
Definition at line 226 of file qgsbrowserdockwidget.cpp.
|
slot |
Toggle fast scan.
Definition at line 161 of file qgsbrowserdockwidget.cpp.
|
slot |
Update project home directory.
Definition at line 196 of file qgsbrowserdockwidget.cpp.