QGIS API Documentation 3.41.0-Master (57ec4277f5e)
Loading...
Searching...
No Matches
qgssublayersdialog.h
Go to the documentation of this file.
1/***************************************************************************
2 qgssublayersdialog.h - dialog for selecting sublayers
3 ---------------------
4 begin : January 2009
5 copyright : (C) 2009 by Florian El Ahdab
6 email : felahdab at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSSUBLAYERSDIALOG_H
17#define QGSSUBLAYERSDIALOG_H
18
19#include <QDialog>
20#include <QCheckBox>
21#include "ui_qgssublayersdialogbase.h"
22#include "qgis_sip.h"
23#include "qgis_gui.h"
24#include "qgis.h"
25
31class GUI_EXPORT QgsSublayersDialog : public QDialog, private Ui::QgsSublayersDialogBase
32{
33 Q_OBJECT
34 public:
40 {
41
46
51
56
60 PromptLoadAll
61 };
62 Q_ENUM( PromptMode )
63
65 {
69 Mdal
70 };
71
76 {
78 int layerId = -1;
79
81 QString layerName;
82
84 int count = -1;
85
87 QString type;
88
94 QString description;
95 };
96
100 typedef QList<QgsSublayersDialog::LayerDefinition> LayerDefinitionList;
101
103
115 Q_DECL_DEPRECATED QgsSublayersDialog( ProviderType providerType, const QString &name, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags fl = Qt::WindowFlags(), const QString &dataSourceUri = QString() ) SIP_DEPRECATED;
116
117 ~QgsSublayersDialog() override;
118
122 void populateLayerTable( const LayerDefinitionList &list );
123
127 LayerDefinitionList selection();
128
132 void setShowAddToGroupCheckbox( bool showAddToGroupCheckbox ) { mShowAddToGroupCheckbox = showAddToGroupCheckbox; }
133
137 bool showAddToGroupCheckbox() const { return mShowAddToGroupCheckbox; }
138
142 bool addToGroupCheckbox() const { return mCbxAddToGroup->isChecked(); }
143
147 int countColumn() const { return mShowCount ? 2 : -1; }
148
149 public slots:
150 int exec() override;
151
152 private slots:
153 void layersTable_selectionChanged( const QItemSelection &, const QItemSelection & );
154 void mBtnDeselectAll_pressed();
155
156 protected:
160 QString mName;
162
164 bool mShowCount = false;
166 bool mShowType = false;
168 bool mShowDescription = false;
169
170 private:
172 bool mShowAddToGroupCheckbox = false;
173};
174
175#endif
QList< QgsSublayersDialog::LayerDefinition > LayerDefinitionList
List of layer definitions for the purpose of this dialog.
PromptMode
Prompt behavior of the QgsSublayersDialog.
@ PromptNever
never prompt, will not load anything
@ PromptAlways
always ask if there are existing sublayers
@ PromptIfNeeded
always ask if there are existing sublayers, but skip if there are bands for rasters
bool showAddToGroupCheckbox() const
If we should display the add to group checkbox.
int countColumn() const
Returns column with count or -1.
bool addToGroupCheckbox() const
If we should add layers in a group.
QString mName
Provider type name.
#define SIP_DEPRECATED
Definition qgis_sip.h:106
#define SIP_TRANSFERTHIS
Definition qgis_sip.h:53
A structure that defines layers for the purpose of this dialog.
QString layerName
Name of the layer (not necessarily unique)
QString type
Extra type depending on the use (e.g. geometry type for vector sublayers)