QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Signals | Public Member Functions | List of all members
QgsProviderSublayersDialog Class Reference

Dialog for selecting provider sublayers. More...

#include <qgsprovidersublayersdialog.h>

Inheritance diagram for QgsProviderSublayersDialog:
Inheritance graph
[legend]

Signals

void layersAdded (const QList< QgsProviderSublayerDetails > &layers)
 Emitted when sublayers selected from the dialog should be added to the project. More...
 

Public Member Functions

 QgsProviderSublayersDialog (const QString &uri, const QString &providerKey, const QString &filePath, const QList< QgsProviderSublayerDetails > initialDetails=QList< QgsProviderSublayerDetails >(), const QList< Qgis::LayerType > &acceptableTypes=QList< Qgis::LayerType >(), QWidget *parent SIP_TRANSFERTHIS=nullptr, Qt::WindowFlags fl=Qt::WindowFlags())
 Constructor. More...
 
 ~QgsProviderSublayersDialog () override
 
QString groupName () const
 Returns an appropriate name for the layer group. More...
 
QList< QgsProviderSublayerDetailsselectedLayers () const
 Returns the list of selected layers. More...
 
QList< QgsProviderSublayerModel::NonLayerItemselectedNonLayerItems () const
 Returns the list of selected non-layer items (e.g. More...
 
void setGroupName (const QString &groupNameIn)
 Sets an appropriate name for the layer group. More...
 
void setNonLayerItems (const QList< QgsProviderSublayerModel::NonLayerItem > &items)
 Set list of non-layer items (e.g. More...
 

Detailed Description

Dialog for selecting provider sublayers.

Since
QGIS 3.30

Definition at line 72 of file qgsprovidersublayersdialog.h.

Constructor & Destructor Documentation

◆ QgsProviderSublayersDialog()

QgsProviderSublayersDialog::QgsProviderSublayersDialog ( const QString &  uri,
const QString &  providerKey,
const QString &  filePath,
const QList< QgsProviderSublayerDetails initialDetails = QList< QgsProviderSublayerDetails>(),
const QList< Qgis::LayerType > &  acceptableTypes = QList< Qgis::LayerType >(),
QWidget *parent  SIP_TRANSFERTHIS = nullptr,
Qt::WindowFlags  fl = Qt::WindowFlags() 
)

Constructor.

Definition at line 115 of file qgsprovidersublayersdialog.cpp.

◆ ~QgsProviderSublayersDialog()

QgsProviderSublayersDialog::~QgsProviderSublayersDialog ( )
override

Definition at line 232 of file qgsprovidersublayersdialog.cpp.

Member Function Documentation

◆ groupName()

QString QgsProviderSublayersDialog::groupName ( ) const

Returns an appropriate name for the layer group.

Definition at line 284 of file qgsprovidersublayersdialog.cpp.

◆ layersAdded

void QgsProviderSublayersDialog::layersAdded ( const QList< QgsProviderSublayerDetails > &  layers)
signal

Emitted when sublayers selected from the dialog should be added to the project.

◆ selectedLayers()

QList< QgsProviderSublayerDetails > QgsProviderSublayersDialog::selectedLayers ( ) const

Returns the list of selected layers.

Definition at line 242 of file qgsprovidersublayersdialog.cpp.

◆ selectedNonLayerItems()

QList< QgsProviderSublayerModel::NonLayerItem > QgsProviderSublayersDialog::selectedNonLayerItems ( ) const

Returns the list of selected non-layer items (e.g.

embedded QGIS project items).

Definition at line 257 of file qgsprovidersublayersdialog.cpp.

◆ setGroupName()

void QgsProviderSublayersDialog::setGroupName ( const QString &  groupNameIn)

Sets an appropriate name for the layer group.

Definition at line 272 of file qgsprovidersublayersdialog.cpp.

◆ setNonLayerItems()

void QgsProviderSublayersDialog::setNonLayerItems ( const QList< QgsProviderSublayerModel::NonLayerItem > &  items)

Set list of non-layer items (e.g.

embedded QGIS project items).

Definition at line 224 of file qgsprovidersublayersdialog.cpp.


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