QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Public Slots | Public Member Functions | Protected Member Functions | List of all members
QgsLayerMetadataSearchWidget Class Reference

The QgsLayerMetadataSearchWidget class offers layer metadata search and filtering. More...

#include <qgslayermetadatasearchwidget.h>

Inheritance diagram for QgsLayerMetadataSearchWidget:
Inheritance graph
[legend]

Public Slots

void addButtonClicked () override
 
void refresh () override
 
void reset () override
 
void updateExtentFilter (int index)
 Updates the extent filter based on the combo box current item index. More...
 
- Public Slots inherited from QgsAbstractDataSourceWidget
virtual void addButtonClicked ()
 Triggered when the add button is clicked, the add layer signal is emitted Concrete classes should implement the right behavior depending on the layer being added. More...
 
virtual void refresh ()
 Triggered when the provider's connections need to be refreshed The default implementation does nothing. More...
 
virtual void reset ()
 Called when this source select widget is being shown in a "new and clean" dialog. More...
 

Public Member Functions

 QgsLayerMetadataSearchWidget (QWidget *parent=nullptr, Qt::WindowFlags fl=Qt::WindowFlags(), QgsProviderRegistry::WidgetMode widgetMode=QgsProviderRegistry::WidgetMode::None)
 Creates a new QgsLayerMetadataSearchWidget. More...
 
void setMapCanvas (QgsMapCanvas *mapCanvas) override
 Sets the dialog map canvas. More...
 
- Public Member Functions inherited from QgsAbstractDataSourceWidget
virtual QgsMapCanvasmapCanvas ()
 Returns the dialog map canvas. More...
 
virtual void setBrowserModel (QgsBrowserModel *model)
 Sets a browser model to use with the widget. More...
 
virtual void setMapCanvas (QgsMapCanvas *mapCanvas)
 Sets the dialog map canvas. More...
 

Protected Member Functions

void showEvent (QShowEvent *event) override
 
- Protected Member Functions inherited from QgsAbstractDataSourceWidget
 QgsAbstractDataSourceWidget (QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags, QgsProviderRegistry::WidgetMode widgetMode=QgsProviderRegistry::WidgetMode::None)
 Constructor. More...
 
QPushButton * addButton () const
 Returns the add Button. More...
 
QgsBrowserModelbrowserModel ()
 Returns the associated browser model (may be nullptr). More...
 
void setupButtons (QDialogButtonBox *buttonBox)
 Connect the ok and apply/add buttons to the slots. More...
 
QgsProviderRegistry::WidgetMode widgetMode () const
 Returns the widget mode. More...
 

Additional Inherited Members

- Signals inherited from QgsAbstractDataSourceWidget
void addDatabaseLayers (const QStringList &paths, const QString &providerKey)
 Emitted when a DB layer has been selected for addition. More...
 
void addMeshLayer (const QString &url, const QString &baseName, const QString &providerKey)
 Emitted when a mesh layer has been selected for addition. More...
 
void addPointCloudLayer (const QString &url, const QString &baseName, const QString &providerKey)
 Emitted when a point cloud layer has been selected for addition. More...
 
void addRasterLayer (const QString &rasterLayerPath, const QString &baseName, const QString &providerKey)
 Emitted when a raster layer has been selected for addition. More...
 
void addRasterLayers (const QStringList &layersList)
 Emitted when one or more GDAL supported layers are selected for addition. More...
 
void addVectorLayer (const QString &uri, const QString &layerName, const QString &providerKey=QString())
 Emitted when a vector layer has been selected for addition. More...
 
void addVectorLayers (const QStringList &layerList, const QString &encoding, const QString &dataSourceType)
 Emitted when one or more OGR supported layers are selected for addition. More...
 
void addVectorTileLayer (const QString &url, const QString &baseName)
 Emitted when a vector tile layer has been selected for addition. More...
 
void connectionsChanged ()
 Emitted when the provider's connections have changed This signal is normally forwarded the app and used to refresh browser items. More...
 
void enableButtons (bool enable)
 Emitted when the ok/add buttons should be enabled/disabled. More...
 
Q_DECL_DEPRECATED void progress (int, int)
 Emitted when a progress dialog is shown by the provider dialog. More...
 
void progressMessage (QString message)
 Emitted when a progress dialog is shown by the provider dialog. More...
 
void pushMessage (const QString &title, const QString &message, const Qgis::MessageLevel level=Qgis::MessageLevel::Info)
 Emitted when a message with title and level must be shown to the user using the parent visible message bar. More...
 
void replaceVectorLayer (const QString &oldId, const QString &source, const QString &name, const QString &provider)
 Emitted when a layer needs to be replaced. More...
 

Detailed Description

The QgsLayerMetadataSearchWidget class offers layer metadata search and filtering.

It is designed to be embedded in the data source manager dialog.

Since
QGIS 3.28

Definition at line 36 of file qgslayermetadatasearchwidget.h.

Constructor & Destructor Documentation

◆ QgsLayerMetadataSearchWidget()

QgsLayerMetadataSearchWidget::QgsLayerMetadataSearchWidget ( QWidget *  parent = nullptr,
Qt::WindowFlags  fl = Qt::WindowFlags(),
QgsProviderRegistry::WidgetMode  widgetMode = QgsProviderRegistry::WidgetMode::None 
)
explicit

Creates a new QgsLayerMetadataSearchWidget.

Definition at line 25 of file qgslayermetadatasearchwidget.cpp.

Member Function Documentation

◆ addButtonClicked

void QgsLayerMetadataSearchWidget::addButtonClicked ( )
overrideslot

Definition at line 198 of file qgslayermetadatasearchwidget.cpp.

◆ refresh

void QgsLayerMetadataSearchWidget::refresh ( )
overrideslot

Definition at line 193 of file qgslayermetadatasearchwidget.cpp.

◆ reset

void QgsLayerMetadataSearchWidget::reset ( )
overrideslot

Definition at line 233 of file qgslayermetadatasearchwidget.cpp.

◆ setMapCanvas()

void QgsLayerMetadataSearchWidget::setMapCanvas ( QgsMapCanvas mapCanvas)
overridevirtual

Sets the dialog map canvas.

See also
mapCanvas()

Reimplemented from QgsAbstractDataSourceWidget.

Definition at line 160 of file qgslayermetadatasearchwidget.cpp.

◆ showEvent()

void QgsLayerMetadataSearchWidget::showEvent ( QShowEvent *  event)
overrideprotected

Definition at line 239 of file qgslayermetadatasearchwidget.cpp.

◆ updateExtentFilter

void QgsLayerMetadataSearchWidget::updateExtentFilter ( int  index)
slot

Updates the extent filter based on the combo box current item index.

Definition at line 172 of file qgslayermetadatasearchwidget.cpp.


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