A dock widget containing a QgsBrowserWidget for navigating and managing data sources. More...

#include <qgsbrowserdockwidget.h>

Inheritance diagram for QgsBrowserDockWidget:

[legend]

Public Slots
Q_DECL_DEPRECATED void	addFavorite ()
	Add current item to favorite.
Q_DECL_DEPRECATED void	addFavoriteDirectory ()
	Add directory from file dialog to favorite.
Q_DECL_DEPRECATED bool	addLayerAtIndex (const QModelIndex &index)
	Adds the layer corresponding to the specified model index.
Q_DECL_DEPRECATED void	addSelectedLayers ()
	Add selected layers to the project.
Q_DECL_DEPRECATED void	enablePropertiesWidget (bool enable)
	Enable/disable properties widget.
Q_DECL_DEPRECATED void	hideItem ()
	Hide current item.
void	refresh ()
	Refresh the browser model and view.
Q_DECL_DEPRECATED void	removeFavorite ()
	Remove from favorite.
Q_DECL_DEPRECATED void	selectionChanged (const QItemSelection &selected, const QItemSelection &deselected)
	Selection has changed.
Q_DECL_DEPRECATED void	setActiveIndex (const QModelIndex &index)
	Sets the selection to index and expand it.
Q_DECL_DEPRECATED void	setCaseSensitive (bool caseSensitive)
	Sets filter case sensitivity.
Q_DECL_DEPRECATED void	setFilter ()
	Apply filter to the model.
Q_DECL_DEPRECATED void	setFilterSyntax (QAction *)
	Sets filter syntax.
Q_DECL_DEPRECATED void	showContextMenu (QPoint)
	Show context menu.
Q_DECL_DEPRECATED void	showFilterWidget (bool visible)
	Show/hide filter widget.
Q_DECL_DEPRECATED void	showProperties ()
	Show the layer properties.
Q_DECL_DEPRECATED void	splitterMoved ()
	Splitter has been moved.
Q_DECL_DEPRECATED void	toggleFastScan ()
	Toggle fast scan.
Q_DECL_DEPRECATED void	updateProjectHome ()
	Update project home directory.
Public Slots inherited from QgsDockWidget
void	setUserVisible (bool visible)
	Sets the dock widget as visible to a user, ie both shown and raised to the front.
void	toggleUserVisible ()
	Toggles whether the dock is user visible.

Signals
void	connectionsChanged ()
	Connections changed in the browser.
void	handleDropUriList (const QgsMimeDataUtils::UriList &uris)
	Emitted when drop uri list needs to be handled.
void	openFile (const QString &fileName, const QString &fileTypeHint=QString())
	Emitted when a file needs to be opened.
Signals inherited from QgsDockWidget
void	closed ()
	Emitted when dock widget is closed.
void	closedStateChanged (bool wasClosed)
	Emitted when dock widget is closed (or opened).
void	opened ()
	Emitted when dock widget is opened.
void	openedStateChanged (bool wasOpened)
	Emitted when dock widget is opened (or closed).

Public Member Functions
	QgsBrowserDockWidget (const QString &name, QgsBrowserGuiModel browserModel, QWidget parent=nullptr)
	Constructor for QgsBrowserDockWidget.
	~QgsBrowserDockWidget () override
Q_DECL_DEPRECATED void	addFavoriteDirectory (const QString &favDir, const QString &name=QString())
	Add directory to favorites.
QgsBrowserWidget *	browserWidget ()
	Returns a pointer to the QgsBrowserWidget used by the dock widget.
QgsMapCanvas *	mapCanvas ()
	Returns the map canvas associated with the dock.
QgsMessageBar *	messageBar ()
	Returns the message bar associated with the dock.
void	setDisabledDataItemsKeys (const QStringList &filter)
	Sets the customization for data items based on item's data provider key.
void	setMapCanvas (QgsMapCanvas *canvas)
	Sets a map canvas to use alongside the dock.
void	setMessageBar (QgsMessageBar *bar)
	Sets a message bar to use alongside the dock widget.
Public Member Functions inherited from QgsDockWidget
	QgsDockWidget (const QString &title, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
	Constructor for QgsDockWidget.
	QgsDockWidget (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
	Constructor for QgsDockWidget.
bool	isUserVisible () const
	Returns `true` if the dock is both opened and raised to the front (ie not hidden by any other tabs.
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).
QAction *	toggleVisibilityAction ()
	Returns the action linked to the dock.

Additional Inherited Members
Protected Member Functions inherited from QgsDockWidget
void	closeEvent (QCloseEvent *) override
void	showEvent (QShowEvent *event) override

Detailed Description

A dock widget containing a QgsBrowserWidget for navigating and managing data sources.

Definition at line 31 of file qgsbrowserdockwidget.h.

Constructor & Destructor Documentation

◆ QgsBrowserDockWidget()

QgsBrowserDockWidget::QgsBrowserDockWidget	(	const QString &	name,
		QgsBrowserGuiModel *	browserModel,
		QWidget *	parent = nullptr )

explicit

Constructor for QgsBrowserDockWidget.

Parameters

name	name of the widget
browserModel	instance of the (shared) browser model
parent	parent widget

Definition at line 30 of file qgsbrowserdockwidget.cpp.

◆ ~QgsBrowserDockWidget()

QgsBrowserDockWidget::~QgsBrowserDockWidget ( )

overridedefault

Member Function Documentation

◆ addFavorite

void QgsBrowserDockWidget::addFavorite ( )

slot

Add current item to favorite.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead.

Definition at line 62 of file qgsbrowserdockwidget.cpp.

◆ addFavoriteDirectory [1/2]

void QgsBrowserDockWidget::addFavoriteDirectory ( )

slot

Add directory from file dialog to favorite.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead.

Definition at line 78 of file qgsbrowserdockwidget.cpp.

◆ addFavoriteDirectory() [2/2]

void QgsBrowserDockWidget::addFavoriteDirectory	(	const QString &	favDir,
		const QString &	name = QString() )

Add directory to favorites.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead.

Definition at line 89 of file qgsbrowserdockwidget.cpp.

◆ addLayerAtIndex

bool QgsBrowserDockWidget::addLayerAtIndex ( const QModelIndex & index )

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.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 - retrieve the QgsLayerItem itself and manually add to project.

Definition at line 129 of file qgsbrowserdockwidget.cpp.

◆ addSelectedLayers

void QgsBrowserDockWidget::addSelectedLayers ( )

slot

Add selected layers to the project.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 – this method is not intended for public use.

Definition at line 159 of file qgsbrowserdockwidget.cpp.

◆ browserWidget()

QgsBrowserWidget * QgsBrowserDockWidget::browserWidget ( )

Returns a pointer to the QgsBrowserWidget used by the dock widget.

Since: QGIS 3.22

Definition at line 52 of file qgsbrowserdockwidget.cpp.

◆ connectionsChanged

void QgsBrowserDockWidget::connectionsChanged ( )

signal

Connections changed in the browser.

◆ enablePropertiesWidget

void QgsBrowserDockWidget::enablePropertiesWidget ( bool enable )

slot

Enable/disable properties widget.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 – this method is not intended for public use.

Definition at line 228 of file qgsbrowserdockwidget.cpp.

◆ handleDropUriList

void QgsBrowserDockWidget::handleDropUriList ( const QgsMimeDataUtils::UriList & uris )

signal

Emitted when drop uri list needs to be handled.

◆ hideItem

void QgsBrowserDockWidget::hideItem ( )

slot

Hide current item.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 – this method is not intended for public use.

Definition at line 164 of file qgsbrowserdockwidget.cpp.

◆ mapCanvas()

QgsMapCanvas * QgsBrowserDockWidget::mapCanvas ( )

Returns the map canvas associated with the dock.

See also: setMapCanvas()

Since: QGIS 3.44

Definition at line 109 of file qgsbrowserdockwidget.cpp.

◆ messageBar()

QgsMessageBar * QgsBrowserDockWidget::messageBar ( )

Returns the message bar associated with the dock.

See also: setMessageBar()

Since: QGIS 3.6

Definition at line 99 of file qgsbrowserdockwidget.cpp.

◆ openFile

void QgsBrowserDockWidget::openFile	(	const QString &	fileName,
		const QString &	fileTypeHint = QString() )

signal

Emitted when a file needs to be opened.

◆ refresh

void QgsBrowserDockWidget::refresh ( )

slot

Refresh the browser model and view.

Definition at line 124 of file qgsbrowserdockwidget.cpp.

◆ removeFavorite

void QgsBrowserDockWidget::removeFavorite ( )

slot

Remove from favorite.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead.

Definition at line 119 of file qgsbrowserdockwidget.cpp.

◆ selectionChanged

void QgsBrowserDockWidget::selectionChanged	(	const QItemSelection &	selected,
		const QItemSelection &	deselected )

slot

Selection has changed.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 – this method is not intended for public use.

Definition at line 223 of file qgsbrowserdockwidget.cpp.

◆ setActiveIndex

void QgsBrowserDockWidget::setActiveIndex ( const QModelIndex & index )

slot

Sets the selection to index and expand it.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 – this method is not intended for public use.

Definition at line 233 of file qgsbrowserdockwidget.cpp.

◆ setCaseSensitive

void QgsBrowserDockWidget::setCaseSensitive ( bool caseSensitive )

slot

Sets filter case sensitivity.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 – this method is not intended for public use.

Definition at line 218 of file qgsbrowserdockwidget.cpp.

◆ setDisabledDataItemsKeys()

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

Since: QGIS 3.12

Definition at line 114 of file qgsbrowserdockwidget.cpp.

◆ setFilter

void QgsBrowserDockWidget::setFilter ( )

slot

Apply filter to the model.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 – this method is not intended for public use.

Definition at line 203 of file qgsbrowserdockwidget.cpp.

◆ setFilterSyntax

void QgsBrowserDockWidget::setFilterSyntax ( QAction * action )

slot

Sets filter syntax.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 – this method is not intended for public use.

Definition at line 213 of file qgsbrowserdockwidget.cpp.

◆ setMapCanvas()

void QgsBrowserDockWidget::setMapCanvas ( QgsMapCanvas * canvas )

Sets a map canvas to use alongside the dock.

Setting this allows items to utilize the canvas during GUI operations.

See also: mapCanvas()

Since: QGIS 3.44

Definition at line 104 of file qgsbrowserdockwidget.cpp.

◆ setMessageBar()

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.

See also: messageBar()

Since: QGIS 3.6

Definition at line 94 of file qgsbrowserdockwidget.cpp.

◆ showContextMenu

void QgsBrowserDockWidget::showContextMenu ( QPoint pt )

slot

Show context menu.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 – this method is not intended for public use.

Definition at line 57 of file qgsbrowserdockwidget.cpp.

◆ showFilterWidget

void QgsBrowserDockWidget::showFilterWidget ( bool visible )

slot

Show/hide filter widget.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 – this method is not intended for public use.

Definition at line 198 of file qgsbrowserdockwidget.cpp.

◆ showProperties

void QgsBrowserDockWidget::showProperties ( )

slot

Show the layer properties.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 – this method is not intended for public use.

Definition at line 169 of file qgsbrowserdockwidget.cpp.

◆ splitterMoved

void QgsBrowserDockWidget::splitterMoved ( )

slot

Splitter has been moved.

Deprecated: QGIS 3.40. No longer used.

Definition at line 238 of file qgsbrowserdockwidget.cpp.

◆ toggleFastScan

void QgsBrowserDockWidget::toggleFastScan ( )

slot

Toggle fast scan.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0.

Definition at line 174 of file qgsbrowserdockwidget.cpp.

◆ updateProjectHome

void QgsBrowserDockWidget::updateProjectHome ( )

slot

Update project home directory.

Deprecated: QGIS 3.40. Will be removed in QGIS 4.0 – this method is not intended for public use.

Definition at line 208 of file qgsbrowserdockwidget.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.99.0+git20251207+21b3aa880ba+99sid/src/gui/qgsbrowserdockwidget.h
/build/qgis-3.99.0+git20251207+21b3aa880ba+99sid/src/gui/qgsbrowserdockwidget.cpp

Public Slots

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsBrowserDockWidget()

◆ ~QgsBrowserDockWidget()

Member Function Documentation

◆ addFavorite

◆ addFavoriteDirectory [1/2]

◆ addFavoriteDirectory() [2/2]

◆ addLayerAtIndex

◆ addSelectedLayers

◆ browserWidget()

◆ connectionsChanged

◆ enablePropertiesWidget

◆ handleDropUriList

◆ hideItem

◆ mapCanvas()

◆ messageBar()

◆ openFile

◆ refresh

◆ removeFavorite

◆ selectionChanged

◆ setActiveIndex

◆ setCaseSensitive

◆ setDisabledDataItemsKeys()

◆ setFilter

◆ setFilterSyntax

◆ setMapCanvas()

◆ setMessageBar()

◆ showContextMenu

◆ showFilterWidget

◆ showProperties

◆ splitterMoved

◆ toggleFastScan

◆ updateProjectHome