A widget showing a browser tree view along with toolbar and toggleable properties pane.
More...
#include <qgsbrowserwidget.h>
|
void | refresh () |
| Refreshes the browser model and view.
|
|
void | setActiveIndex (const QModelIndex &index) |
| Sets the selection to index and expands it.
|
|
void | updateProjectHome () |
| Update project home directory.
|
|
void | acceptPanel () |
| Accept the panel.
|
|
void | openPanel (QgsPanelWidget *panel) |
| Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event.
|
|
|
void | showEvent (QShowEvent *event) override |
|
void | keyPressEvent (QKeyEvent *event) override |
| Overridden key press event to handle the esc event on the widget.
|
|
A widget showing a browser tree view along with toolbar and toggleable properties pane.
- Since
- QGIS 3.22
Definition at line 39 of file qgsbrowserwidget.h.
◆ QgsBrowserWidget()
QgsBrowserWidget::QgsBrowserWidget |
( |
QgsBrowserGuiModel * |
browserModel, |
|
|
QWidget * |
parent = nullptr |
|
) |
| |
|
explicit |
◆ ~QgsBrowserWidget()
QgsBrowserWidget::~QgsBrowserWidget |
( |
| ) |
|
|
overridedefault |
◆ connectionsChanged
void QgsBrowserWidget::connectionsChanged |
( |
| ) |
|
|
signal |
Connections changed in the browser.
◆ handleDropUriList
Emitted when drop uri list needs to be handled.
◆ messageBar()
◆ openFile
void QgsBrowserWidget::openFile |
( |
const QString & |
fileName, |
|
|
const QString & |
fileTypeHint = QString() |
|
) |
| |
|
signal |
Emitted when a file needs to be opened.
◆ refresh
void QgsBrowserWidget::refresh |
( |
| ) |
|
|
slot |
◆ setActiveIndex
void QgsBrowserWidget::setActiveIndex |
( |
const QModelIndex & |
index | ) |
|
|
slot |
Sets the selection to index and expands it.
- Note
- Not available in Python bindings.
Definition at line 533 of file qgsbrowserwidget.cpp.
◆ setDisabledDataItemsKeys()
void QgsBrowserWidget::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 277 of file qgsbrowserwidget.cpp.
◆ setMessageBar()
Sets a message bar to use alongside the widget.
Setting this allows items to utilize the message bar to provide non-blocking feedback to users, e.g. success or failure of actions.
- See also
- messageBar()
Definition at line 266 of file qgsbrowserwidget.cpp.
◆ showEvent()
void QgsBrowserWidget::showEvent |
( |
QShowEvent * |
event | ) |
|
|
overrideprotected |
◆ updateProjectHome
void QgsBrowserWidget::updateProjectHome |
( |
| ) |
|
|
slot |
Update project home directory.
- Note
- Not available in Python bindings.
Definition at line 431 of file qgsbrowserwidget.cpp.
◆ QgsBrowserDockWidget
The documentation for this class was generated from the following files: