QGIS API Documentation  2.99.0-Master (19b062c)
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  ProviderType { Ogr, Gdal, Vsifile }
 

Public Slots

int exec ()
 

Public Member Functions

 QgsSublayersDialog (ProviderType providerType, const QString &name, QWidget *parent=nullptr, Qt::WindowFlags fl=0)
 
 ~QgsSublayersDialog ()
 
bool addToGroupCheckbox () const
 If we should add layers in a group. More...
 
int countColumn () const
 Return 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
 
QStringList mSelectedSubLayers
 
bool mShowCount = false
 Whether to show number of features in the table. More...
 
bool mShowType = false
 Whether to show type in the table. More...
 

Detailed Description

Definition at line 29 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 57 of file qgssublayersdialog.h.

Member Enumeration Documentation

◆ ProviderType

Enumerator
Ogr 
Gdal 
Vsifile 

Definition at line 34 of file qgssublayersdialog.h.

Constructor & Destructor Documentation

◆ QgsSublayersDialog()

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

Definition at line 44 of file qgssublayersdialog.cpp.

◆ ~QgsSublayersDialog()

QgsSublayersDialog::~QgsSublayersDialog ( )

Definition at line 87 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 94 of file qgssublayersdialog.h.

◆ countColumn()

int QgsSublayersDialog::countColumn ( ) const
inline

Return column with count or -1.

Since
QGIS 3.0

Definition at line 100 of file qgssublayersdialog.h.

◆ exec

int QgsSublayersDialog::exec ( )
slot

Definition at line 163 of file qgssublayersdialog.cpp.

◆ populateLayerTable()

void QgsSublayersDialog::populateLayerTable ( const LayerDefinitionList list)

Populate the table with layers.

Since
QGIS 2.16

Definition at line 132 of file qgssublayersdialog.cpp.

◆ selection()

QgsSublayersDialog::LayerDefinitionList QgsSublayersDialog::selection ( )

Returns list of selected layers.

Since
QGIS 2.16

Definition at line 108 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 82 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 88 of file qgssublayersdialog.h.

Member Data Documentation

◆ mName

QString QgsSublayersDialog::mName
protected

Definition at line 106 of file qgssublayersdialog.h.

◆ mSelectedSubLayers

QStringList QgsSublayersDialog::mSelectedSubLayers
protected

Definition at line 107 of file qgssublayersdialog.h.

◆ mShowCount

bool QgsSublayersDialog::mShowCount = false
protected

Whether to show number of features in the table.

Definition at line 108 of file qgssublayersdialog.h.

◆ mShowType

bool QgsSublayersDialog::mShowType = false
protected

Whether to show type in the table.

Definition at line 109 of file qgssublayersdialog.h.


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