QGIS API Documentation  3.27.0-Master (e113457133)
Classes | Public Types | Public Slots | Public Member Functions | Protected Attributes | List of all members
QgsSublayersDialog Class Reference

#include <qgssublayersdialog.h>

Inheritance diagram for QgsSublayersDialog:
Inheritance graph
[legend]

Classes

struct  LayerDefinition
 A structure that defines layers for the purpose of this dialog. More...
 

Public Types

typedef QList< QgsSublayersDialog::LayerDefinitionLayerDefinitionList
 List of layer definitions for the purpose of this dialog. More...
 
enum  PromptMode { PromptAlways , PromptIfNeeded , PromptNever , PromptLoadAll }
 Prompt behavior of the QgsSublayersDialog. More...
 
enum  ProviderType { Ogr , Gdal , Vsifile , Mdal }
 

Public Slots

int exec () override
 

Public Member Functions

Q_DECL_DEPRECATED QgsSublayersDialog (ProviderType providerType, const QString &name, QWidget *parent=nullptr, Qt::WindowFlags fl=Qt::WindowFlags(), const QString &dataSourceUri=QString())
 Constructor for QgsSublayersDialog. More...
 
 ~QgsSublayersDialog () override
 
bool addToGroupCheckbox () const
 If we should add layers in a group. More...
 
int countColumn () const
 Returns column with count or -1. More...
 
void populateLayerTable (const LayerDefinitionList &list)
 Populate the table with layers. More...
 
LayerDefinitionList selection ()
 Returns list of selected layers. More...
 
void setShowAddToGroupCheckbox (bool showAddToGroupCheckbox)
 Set if we should display the add to group checkbox. More...
 
bool showAddToGroupCheckbox () const
 If we should display the add to group checkbox. More...
 

Protected Attributes

QString mName
 Provider type name. More...
 
QStringList mSelectedSubLayers
 
bool mShowCount = false
 Whether to show number of features in the table. More...
 
bool mShowDescription = false
 Whether to show description in the table. More...
 
bool mShowType = false
 Whether to show type in the table. More...
 

Detailed Description

Deprecated:
Will be removed in QGIS 4.0

Definition at line 31 of file qgssublayersdialog.h.

Member Typedef Documentation

◆ LayerDefinitionList

List of layer definitions for the purpose of this dialog.

Since
QGIS 2.16

Definition at line 103 of file qgssublayersdialog.h.

Member Enumeration Documentation

◆ PromptMode

Prompt behavior of the QgsSublayersDialog.

Deprecated:
Use Qgis::SublayerPromptMode instead
Enumerator
PromptAlways 

always ask if there are existing sublayers

PromptIfNeeded 

always ask if there are existing sublayers, but skip if there are bands for rasters

PromptNever 

never prompt, will not load anything

PromptLoadAll 

never prompt, but load all sublayers

Definition at line 40 of file qgssublayersdialog.h.

◆ ProviderType

Enumerator
Ogr 
Gdal 
Vsifile 
Mdal 
Since
QGIS 3.14

Definition at line 65 of file qgssublayersdialog.h.

Constructor & Destructor Documentation

◆ QgsSublayersDialog()

QgsSublayersDialog::QgsSublayersDialog ( ProviderType  providerType,
const QString &  name,
QWidget *  parent = nullptr,
Qt::WindowFlags  fl = Qt::WindowFlags(),
const QString &  dataSourceUri = QString() 
)

Constructor for QgsSublayersDialog.

Construct a new QgsSublayersDialog object - a dialog to select which sub layers to be imported from a data source (e.g. from geopackage or zipfile)

Parameters
providerTypeprovider type
nameprovider type name
parentparent widget of the dialog
flwindow flags
dataSourceUridata source URI
Deprecated:
Will be removed in QGIS 4.0

Definition at line 46 of file qgssublayersdialog.cpp.

◆ ~QgsSublayersDialog()

QgsSublayersDialog::~QgsSublayersDialog ( )
override

Definition at line 100 of file qgssublayersdialog.cpp.

Member Function Documentation

◆ addToGroupCheckbox()

bool QgsSublayersDialog::addToGroupCheckbox ( ) const
inline

If we should add layers in a group.

Since
QGIS 3.0

Definition at line 154 of file qgssublayersdialog.h.

◆ countColumn()

int QgsSublayersDialog::countColumn ( ) const
inline

Returns column with count or -1.

Since
QGIS 3.0

Definition at line 160 of file qgssublayersdialog.h.

◆ exec

int QgsSublayersDialog::exec ( )
overrideslot

Definition at line 183 of file qgssublayersdialog.cpp.

◆ populateLayerTable()

void QgsSublayersDialog::populateLayerTable ( const LayerDefinitionList list)

Populate the table with layers.

Since
QGIS 2.16

Definition at line 146 of file qgssublayersdialog.cpp.

◆ selection()

QgsSublayersDialog::LayerDefinitionList QgsSublayersDialog::selection ( )

Returns list of selected layers.

Since
QGIS 2.16

Definition at line 122 of file qgssublayersdialog.cpp.

◆ setShowAddToGroupCheckbox()

void QgsSublayersDialog::setShowAddToGroupCheckbox ( bool  showAddToGroupCheckbox)
inline

Set if we should display the add to group checkbox.

Since
QGIS 3.0

Definition at line 142 of file qgssublayersdialog.h.

◆ showAddToGroupCheckbox()

bool QgsSublayersDialog::showAddToGroupCheckbox ( ) const
inline

If we should display the add to group checkbox.

Since
QGIS 3.0

Definition at line 148 of file qgssublayersdialog.h.

Member Data Documentation

◆ mName

QString QgsSublayersDialog::mName
protected

Provider type name.

Definition at line 174 of file qgssublayersdialog.h.

◆ mSelectedSubLayers

QStringList QgsSublayersDialog::mSelectedSubLayers
protected

Definition at line 175 of file qgssublayersdialog.h.

◆ mShowCount

bool QgsSublayersDialog::mShowCount = false
protected

Whether to show number of features in the table.

Definition at line 178 of file qgssublayersdialog.h.

◆ mShowDescription

bool QgsSublayersDialog::mShowDescription = false
protected

Whether to show description in the table.

Definition at line 182 of file qgssublayersdialog.h.

◆ mShowType

bool QgsSublayersDialog::mShowType = false
protected

Whether to show type in the table.

Definition at line 180 of file qgssublayersdialog.h.


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