QGIS API Documentation 3.29.0-Master (006c3c0232)
Public Slots | Signals | Public Member Functions | List of all members
QgsBrowserDockWidget Class Reference

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

#include <qgsbrowserdockwidget.h>

Inheritance diagram for QgsBrowserDockWidget:
Inheritance graph
[legend]

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...
 
- 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, 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...
 
QgsBrowserWidgetbrowserWidget ()
 Returns a pointer to the QgsBrowserWidget used by the dock widget. More...
 
QgsMessageBarmessageBar ()
 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...
 
- Public Member Functions inherited from QgsDockWidget
 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

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

Since
QGIS 3.0

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
namename of the widget
browserModelinstance of the (shared) browser model
parentparent widget

Definition at line 27 of file qgsbrowserdockwidget.cpp.

◆ ~QgsBrowserDockWidget()

QgsBrowserDockWidget::~QgsBrowserDockWidget ( )
overridedefault

Member Function Documentation

◆ addFavorite

void QgsBrowserDockWidget::addFavorite ( )
slot

Add current item to favorite.

Deprecated:
will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead

Definition at line 59 of file qgsbrowserdockwidget.cpp.

◆ addFavoriteDirectory [1/2]

void QgsBrowserDockWidget::addFavoriteDirectory ( )
slot

Add directory from file dialog to favorite.

Deprecated:
will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead

Definition at line 75 of file qgsbrowserdockwidget.cpp.

◆ addFavoriteDirectory() [2/2]

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

Add directory to favorites.

Deprecated:
will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead

Definition at line 86 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:
will be removed in QGIS 4.0 - retrieve the QgsLayerItem itself and manually add to project.

Definition at line 116 of file qgsbrowserdockwidget.cpp.

◆ addSelectedLayers

void QgsBrowserDockWidget::addSelectedLayers ( )
slot

Add selected layers to the project.

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

Definition at line 146 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 49 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:
will be removed in QGIS 4.0 – this method is not intended for public use

Definition at line 216 of file qgsbrowserdockwidget.cpp.

◆ handleDropUriList

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

Emitted when drop uri list needs to be handled.

◆ hideItem

void QgsBrowserDockWidget::hideItem ( )
slot

Hide current item.

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

Definition at line 151 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 96 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 111 of file qgsbrowserdockwidget.cpp.

◆ removeFavorite

void QgsBrowserDockWidget::removeFavorite ( )
slot

Remove from favorite.

Deprecated:
will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead

Definition at line 106 of file qgsbrowserdockwidget.cpp.

◆ selectionChanged

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

Selection has changed.

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

Definition at line 211 of file qgsbrowserdockwidget.cpp.

◆ setActiveIndex

void QgsBrowserDockWidget::setActiveIndex ( const QModelIndex &  index)
slot

Sets the selection to index and expand it.

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

Definition at line 221 of file qgsbrowserdockwidget.cpp.

◆ setCaseSensitive

void QgsBrowserDockWidget::setCaseSensitive ( bool  caseSensitive)
slot

Sets filter case sensitivity.

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

Definition at line 206 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 101 of file qgsbrowserdockwidget.cpp.

◆ setFilter

void QgsBrowserDockWidget::setFilter ( )
slot

Apply filter to the model.

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

Definition at line 191 of file qgsbrowserdockwidget.cpp.

◆ setFilterSyntax

void QgsBrowserDockWidget::setFilterSyntax ( QAction *  action)
slot

Sets filter syntax.

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

Definition at line 201 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 91 of file qgsbrowserdockwidget.cpp.

◆ showContextMenu

void QgsBrowserDockWidget::showContextMenu ( QPoint  pt)
slot

Show context menu.

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

Definition at line 54 of file qgsbrowserdockwidget.cpp.

◆ showFilterWidget

void QgsBrowserDockWidget::showFilterWidget ( bool  visible)
slot

Show/hide filter widget.

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

Definition at line 186 of file qgsbrowserdockwidget.cpp.

◆ showProperties

void QgsBrowserDockWidget::showProperties ( )
slot

Show the layer properties.

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

Definition at line 156 of file qgsbrowserdockwidget.cpp.

◆ splitterMoved

void QgsBrowserDockWidget::splitterMoved ( )
slot

Splitter has been moved.

Deprecated:
no longer used.

Definition at line 226 of file qgsbrowserdockwidget.cpp.

◆ toggleFastScan

void QgsBrowserDockWidget::toggleFastScan ( )
slot

Toggle fast scan.

Deprecated:
will be removed in QGIS 4.0

Definition at line 161 of file qgsbrowserdockwidget.cpp.

◆ updateProjectHome

void QgsBrowserDockWidget::updateProjectHome ( )
slot

Update project home directory.

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

Definition at line 196 of file qgsbrowserdockwidget.cpp.


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