QgsSublayersDialog Class Reference

#include <qgssublayersdialog.h>

Inheritance diagram for QgsSublayersDialog:

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

Public Types
typedef QList< QgsSublayersDialog::LayerDefinition >	LayerDefinitionList
	List of layer definitions for the purpose of this dialog. More...
enum	ProviderType { Ogr, Gdal, Vsifile }

Public Slots
int	exec () override

Public Member Functions
	QgsSublayersDialog (ProviderType providerType, const QString &name, QWidget *parent=nullptr, Qt::WindowFlags fl=nullptr)
	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
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

typedef QList<QgsSublayersDialog::LayerDefinition> QgsSublayersDialog::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

enum QgsSublayersDialog::ProviderType

Enumerator
Ogr
Gdal
Vsifile

Definition at line 34 of file qgssublayersdialog.h.

Constructor & Destructor Documentation

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

Constructor for QgsSublayersDialog.

Definition at line 44 of file qgssublayersdialog.cpp.

QgsSublayersDialog::~QgsSublayersDialog ( )

override

Definition at line 87 of file qgssublayersdialog.cpp.

Member Function Documentation

bool QgsSublayersDialog::addToGroupCheckbox ( ) const

inline

If we should add layers in a group.

Since

QGIS 3.0

Definition at line 95 of file qgssublayersdialog.h.

int QgsSublayersDialog::countColumn ( ) const

inline

Returns column with count or -1.

Since

QGIS 3.0

Definition at line 101 of file qgssublayersdialog.h.

int QgsSublayersDialog::exec ( )

overrideslot

Definition at line 163 of file qgssublayersdialog.cpp.

void QgsSublayersDialog::populateLayerTable

(

const LayerDefinitionList &

list

)

Populate the table with layers.

Since

QGIS 2.16

Definition at line 132 of file qgssublayersdialog.cpp.

QgsSublayersDialog::LayerDefinitionList QgsSublayersDialog::selection

(

)

Returns list of selected layers.

Since

QGIS 2.16

Definition at line 108 of file qgssublayersdialog.cpp.

void QgsSublayersDialog::setShowAddToGroupCheckbox ( bool  showAddToGroupCheckbox )

inline

Set if we should display the add to group checkbox.

Since

QGIS 3.0

Definition at line 83 of file qgssublayersdialog.h.

bool QgsSublayersDialog::showAddToGroupCheckbox ( ) const

inline

If we should display the add to group checkbox.

Since

QGIS 3.0

Definition at line 89 of file qgssublayersdialog.h.

Member Data Documentation

QString QgsSublayersDialog::mName

protected

Definition at line 107 of file qgssublayersdialog.h.

QStringList QgsSublayersDialog::mSelectedSubLayers

protected

Definition at line 108 of file qgssublayersdialog.h.

bool QgsSublayersDialog::mShowCount = false

protected

Whether to show number of features in the table.

Definition at line 109 of file qgssublayersdialog.h.

bool QgsSublayersDialog::mShowType = false

protected

Whether to show type in the table.

Definition at line 110 of file qgssublayersdialog.h.

---

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

• /build/qgis-3.4.15+24xenial/src/gui/qgssublayersdialog.h
• /build/qgis-3.4.15+24xenial/src/gui/qgssublayersdialog.cpp