QGIS API Documentation  3.0.2-Girona (307d082)
Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
QgsBrowserDockWidget Class Reference

The QgsBrowserDockWidget class. More...

#include <qgsbrowserdockwidget.h>

Inheritance diagram for QgsBrowserDockWidget:
Inheritance graph

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)
 Set filter case sensitivity. More...
void setFilter ()
 Apply filter to the model. More...
void setFilterSyntax (QAction *)
 Set 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 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 &)
 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...

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.

QGIS 3.0

Definition at line 42 of file qgsbrowserdockwidget.h.

Constructor & Destructor Documentation

◆ QgsBrowserDockWidget()

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

Constructor for QgsBrowserDockWidget.

namename of the widget
browserModelinstance of the (shared) browser model
parentparent widget

Definition at line 42 of file qgsbrowserdockwidget.cpp.

◆ ~QgsBrowserDockWidget()

QgsBrowserDockWidget::~QgsBrowserDockWidget ( )

Definition at line 104 of file qgsbrowserdockwidget.cpp.

Member Function Documentation

◆ addFavorite

void QgsBrowserDockWidget::addFavorite ( )

Add current item to favorite.

Definition at line 262 of file qgsbrowserdockwidget.cpp.

◆ addFavoriteDirectory() [1/2]

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

Add directory to favorites.

Definition at line 285 of file qgsbrowserdockwidget.cpp.

◆ addFavoriteDirectory [2/2]

void QgsBrowserDockWidget::addFavoriteDirectory ( )

Add directory from file dialog to favorite.

Definition at line 276 of file qgsbrowserdockwidget.cpp.

◆ addLayerAtIndex

void QgsBrowserDockWidget::addLayerAtIndex ( const QModelIndex &  index)

Add layer at index.

Definition at line 352 of file qgsbrowserdockwidget.cpp.

◆ addSelectedLayers

void QgsBrowserDockWidget::addSelectedLayers ( )

Add selected layers to the project.

Definition at line 379 of file qgsbrowserdockwidget.cpp.

◆ connectionsChanged

void QgsBrowserDockWidget::connectionsChanged ( )

Connections changed in the browser.

◆ enablePropertiesWidget

void QgsBrowserDockWidget::enablePropertiesWidget ( bool  enable)

Enable/disable properties widget.

Definition at line 562 of file qgsbrowserdockwidget.cpp.

◆ handleDropUriList

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

Emitted when drop uri list needs to be handled.

◆ hideItem

void QgsBrowserDockWidget::hideItem ( )

Hide current item.

Definition at line 417 of file qgsbrowserdockwidget.cpp.

◆ openFile

void QgsBrowserDockWidget::openFile ( const QString &  )

Emitted when a file needs to be opened.

◆ refresh

void QgsBrowserDockWidget::refresh ( )

Refresh browser view model (and view)

Definition at line 295 of file qgsbrowserdockwidget.cpp.

◆ removeFavorite

void QgsBrowserDockWidget::removeFavorite ( )

Remove from favorite.

Definition at line 290 of file qgsbrowserdockwidget.cpp.

◆ selectionChanged

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

Selection has changed.

Definition at line 521 of file qgsbrowserdockwidget.cpp.

◆ setCaseSensitive

void QgsBrowserDockWidget::setCaseSensitive ( bool  caseSensitive)

Set filter case sensitivity.

Definition at line 504 of file qgsbrowserdockwidget.cpp.

◆ setFilter

void QgsBrowserDockWidget::setFilter ( )

Apply filter to the model.

Definition at line 484 of file qgsbrowserdockwidget.cpp.

◆ setFilterSyntax

void QgsBrowserDockWidget::setFilterSyntax ( QAction *  action)

Set filter syntax.

Definition at line 497 of file qgsbrowserdockwidget.cpp.

◆ showContextMenu

void QgsBrowserDockWidget::showContextMenu ( QPoint  pt)

Show context menu.

Definition at line 190 of file qgsbrowserdockwidget.cpp.

◆ showEvent()

void QgsBrowserDockWidget::showEvent ( QShowEvent *  event)

Show event override.

Definition at line 112 of file qgsbrowserdockwidget.cpp.

◆ showFilterWidget

void QgsBrowserDockWidget::showFilterWidget ( bool  visible)

Show/hide filter widget.

Definition at line 470 of file qgsbrowserdockwidget.cpp.

◆ showProperties

void QgsBrowserDockWidget::showProperties ( )

Show the layer properties.

Definition at line 430 of file qgsbrowserdockwidget.cpp.

◆ splitterMoved

void QgsBrowserDockWidget::splitterMoved ( )

Splitter has been moved.

Definition at line 575 of file qgsbrowserdockwidget.cpp.

◆ toggleFastScan

void QgsBrowserDockWidget::toggleFastScan ( )

Toggle fast scan.

Definition at line 445 of file qgsbrowserdockwidget.cpp.

◆ updateProjectHome

void QgsBrowserDockWidget::updateProjectHome ( )

Update project home directory.

Definition at line 491 of file qgsbrowserdockwidget.cpp.

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