A widget showing a browser tree view along with toolbar and toggleable properties pane. More...

#include <qgsbrowserwidget.h>

Inheritance diagram for QgsBrowserWidget:

[legend]

Public Slots
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.
Public Slots inherited from QgsPanelWidget
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.

Signals
void	connectionsChanged ()
	Connections changed in the browser.
void	handleDropUriList (const QgsMimeDataUtils::UriList &)
	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 QgsPanelWidget
void	changed ()
	Emitted when the widget state changes.
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user.
void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface.
Q_DECL_DEPRECATED void	widgetChanged ()
	Emitted when the widget state changes.

Public Member Functions
	QgsBrowserWidget (QgsBrowserGuiModel browserModel, QWidget parent=nullptr)
	Constructor for QgsBrowserWidget.
	~QgsBrowserWidget () override
QgsMapCanvas *	mapCanvas ()
	Returns the map canvas associated with the widget.
QgsMessageBar *	messageBar ()
	Returns the message bar associated with the widget.
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 widget.
void	setMessageBar (QgsMessageBar *bar)
	Sets a message bar to use alongside the widget.
Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as an inline panel.
virtual bool	applySizeConstraintsToStack () const
	Returns `true` if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.
bool	autoDelete () const
	The the auto delete property on the widget.
void	connectChildPanel (QgsPanelWidget *panel)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
void	connectChildPanels (const QList< QgsPanelWidget * > &panels)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
bool	dockMode () const
	Returns the dock mode state.
virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or `nullptr` if no menu button is required.
virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel.
QString	panelTitle () const
	The title of the panel.
void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget.
virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface.

Protected Member Functions
void	showEvent (QShowEvent *event) override
Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Friends
class	QgsBrowserDockWidget
class	TestQgsCustomization

Additional Inherited Members
Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.

Detailed Description

A widget showing a browser tree view along with toolbar and toggleable properties pane.

Since: QGIS 3.22

Definition at line 41 of file qgsbrowserwidget.h.

Constructor & Destructor Documentation

◆ QgsBrowserWidget()

QgsBrowserWidget::QgsBrowserWidget	(	QgsBrowserGuiModel *	browserModel,
		QWidget *	parent = nullptr )

explicit

Constructor for QgsBrowserWidget.

Parameters

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

Definition at line 58 of file qgsbrowserwidget.cpp.

◆ ~QgsBrowserWidget()

QgsBrowserWidget::~QgsBrowserWidget ( )

overridedefault

Member Function Documentation

◆ connectionsChanged

void QgsBrowserWidget::connectionsChanged ( )

signal

Connections changed in the browser.

◆ handleDropUriList

void QgsBrowserWidget::handleDropUriList ( const QgsMimeDataUtils::UriList & )

signal

Emitted when drop uri list needs to be handled.

◆ mapCanvas()

QgsMapCanvas * QgsBrowserWidget::mapCanvas ( )

Returns the map canvas associated with the widget.

See also: setMapCanvas()

Since: QGIS 3.44

Definition at line 282 of file qgsbrowserwidget.cpp.

◆ messageBar()

QgsMessageBar * QgsBrowserWidget::messageBar ( )

Returns the message bar associated with the widget.

See also: setMessageBar()

Definition at line 271 of file qgsbrowserwidget.cpp.

◆ 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

Refreshes the browser model and view.

Definition at line 297 of file qgsbrowserwidget.cpp.

◆ 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 544 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 287 of file qgsbrowserwidget.cpp.

◆ setMapCanvas()

void QgsBrowserWidget::setMapCanvas ( QgsMapCanvas * canvas )

Sets a map canvas to use alongside the widget.

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

See also: mapCanvas()

Since: QGIS 3.44

Definition at line 276 of file qgsbrowserwidget.cpp.

◆ setMessageBar()

void QgsBrowserWidget::setMessageBar ( QgsMessageBar * bar )

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 265 of file qgsbrowserwidget.cpp.

◆ showEvent()

void QgsBrowserWidget::showEvent ( QShowEvent * event )

overrideprotected

Definition at line 121 of file qgsbrowserwidget.cpp.

◆ updateProjectHome

void QgsBrowserWidget::updateProjectHome ( )

slot

Update project home directory.

Note: Not available in Python bindings.

Definition at line 441 of file qgsbrowserwidget.cpp.

◆ QgsBrowserDockWidget

friend class QgsBrowserDockWidget

friend

Definition at line 193 of file qgsbrowserwidget.h.

◆ TestQgsCustomization

friend class TestQgsCustomization

friend

Definition at line 194 of file qgsbrowserwidget.h.

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

/build/qgis-4.3.0+git20261026+16eddb2670e+99sid/src/gui/qgsbrowserwidget.h
/build/qgis-4.3.0+git20261026+16eddb2670e+99sid/src/gui/qgsbrowserwidget.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsBrowserWidget()

◆ ~QgsBrowserWidget()

Member Function Documentation

◆ connectionsChanged

◆ handleDropUriList

◆ mapCanvas()

◆ messageBar()

◆ openFile

◆ refresh

◆ setActiveIndex

◆ setDisabledDataItemsKeys()

◆ setMapCanvas()

◆ setMessageBar()

◆ showEvent()

◆ updateProjectHome

Friends And Related Symbol Documentation

◆ QgsBrowserDockWidget

◆ TestQgsCustomization