#include <qgsbrowserdockwidget.h>

Inheritance diagram for QgsBrowserDockWidget:

Public Slots
void	addFavorite ()
	Add current item to favorite. More...

void	addFavoriteDirectory ()
	Add directory from file dialog to favorite. More...

void	addLayerAtIndex (const QModelIndex &index)
	Add layer at index. More...

void	addSelectedLayers ()
	Add selected layers to the project. More...

void	enablePropertiesWidget (bool enable)
	Enable/disable properties widget. More...

void	hideItem ()
	Hide current item. More...

void	refresh ()
	Refresh browser view model (and view) More...

void	removeFavorite ()
	Remove from favorite. More...

void	selectionChanged (const QItemSelection &selected, const QItemSelection &deselected)
	Selection has changed. More...

void	setCaseSensitive (bool caseSensitive)
	Sets filter case sensitivity. More...

void	setFilter ()
	Apply filter to the model. More...

void	setFilterSyntax (QAction *)
	Sets filter syntax. More...

void	showContextMenu (QPoint)
	Show context menu. More...

void	showFilterWidget (bool visible)
	Show/hide filter widget. More...

void	showProperties ()
	Show the layer properties. More...

void	splitterMoved ()
	Splitter has been moved. More...

void	toggleFastScan ()
	Toggle fast scan. More...

void	updateProjectHome ()
	Update project home directory. More...

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. 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...

Signals inherited from QgsDockWidget
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, QgsBrowserModel browserModel, QWidget parent=nullptr)
	Constructor for QgsBrowserDockWidget. More...

	~QgsBrowserDockWidget () override

void	addFavoriteDirectory (const QString &favDir, const QString &name=QString())
	Add directory to favorites. More...

Public Member Functions inherited from QgsDockWidget
	QgsDockWidget (QWidget *parent=nullptr, Qt::WindowFlags flags=nullptr)
	Constructor for QgsDockWidget. More...

	QgsDockWidget (const QString &title, QWidget *parent=nullptr, Qt::WindowFlags flags=nullptr)
	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...

Protected Member Functions
void	showEvent (QShowEvent *event) override
	Show event override. More...

Protected Member Functions inherited from QgsDockWidget
void	closeEvent (QCloseEvent *) override

void	showEvent (QShowEvent *event) override

Detailed Description

The QgsBrowserDockWidget class.

Since: QGIS 3.0

Definition at line 42 of file qgsbrowserdockwidget.h.

Constructor & Destructor Documentation

QgsBrowserDockWidget::QgsBrowserDockWidget	(	const QString &	name,
		QgsBrowserModel *	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 43 of file qgsbrowserdockwidget.cpp.

QgsBrowserDockWidget::~QgsBrowserDockWidget ( )

override

Definition at line 105 of file qgsbrowserdockwidget.cpp.

Member Function Documentation

void QgsBrowserDockWidget::addFavorite ( )

slot

Add current item to favorite.

Definition at line 267 of file qgsbrowserdockwidget.cpp.

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

Add directory to favorites.

Definition at line 290 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::addFavoriteDirectory ( )

slot

Add directory from file dialog to favorite.

Definition at line 281 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::addLayerAtIndex ( const QModelIndex & index )

slot

Add layer at index.

Definition at line 357 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::addSelectedLayers ( )

slot

Add selected layers to the project.

Definition at line 384 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::connectionsChanged ( )

signal

Connections changed in the browser.

void QgsBrowserDockWidget::enablePropertiesWidget ( bool enable )

slot

Enable/disable properties widget.

Definition at line 569 of file qgsbrowserdockwidget.cpp.

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

signal

Emitted when drop uri list needs to be handled.

void QgsBrowserDockWidget::hideItem ( )

slot

Hide current item.

Definition at line 422 of file qgsbrowserdockwidget.cpp.

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

signal

Emitted when a file needs to be opened.

void QgsBrowserDockWidget::refresh ( )

slot

Refresh browser view model (and view)

Definition at line 300 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::removeFavorite ( )

slot

Remove from favorite.

Definition at line 295 of file qgsbrowserdockwidget.cpp.

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

slot

Selection has changed.

Definition at line 528 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::setCaseSensitive ( bool caseSensitive )

slot

Sets filter case sensitivity.

Definition at line 511 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::setFilter ( )

slot

Apply filter to the model.

Definition at line 490 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::setFilterSyntax ( QAction * action )

slot

Sets filter syntax.

Definition at line 503 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::showContextMenu ( QPoint pt )

slot

Show context menu.

Definition at line 191 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::showEvent ( QShowEvent * event )

overrideprotected

Show event override.

Definition at line 113 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::showFilterWidget ( bool visible )

slot

Show/hide filter widget.

Definition at line 476 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::showProperties ( )

slot

Show the layer properties.

Definition at line 435 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::splitterMoved ( )

slot

Splitter has been moved.

Definition at line 582 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::toggleFastScan ( )

slot

Toggle fast scan.

Definition at line 451 of file qgsbrowserdockwidget.cpp.

void QgsBrowserDockWidget::updateProjectHome ( )

slot

Update project home directory.

Definition at line 497 of file qgsbrowserdockwidget.cpp.

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

/build/qgis-3.4.15+24xenial/src/gui/qgsbrowserdockwidget.h
/build/qgis-3.4.15+24xenial/src/gui/qgsbrowserdockwidget.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation