QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
gui
qgsrelationwidgetregistry.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsrelationwidgetregistry.h
3
----------------------
4
begin : October 2020
5
copyright : (C) 2020 by Ivan Ivanov
6
email : ivan@opengis.ch
7
***************************************************************************/
8
9
/***************************************************************************
10
* *
11
* This program is free software; you can redistribute it and/or modify *
12
* it under the terms of the GNU General Public License as published by *
13
* the Free Software Foundation; either version 2 of the License, or *
14
* (at your option) any later version. *
15
* *
16
***************************************************************************/
17
18
#ifndef QGSRELATIONWIDGETREGISTRY_H
19
#define QGSRELATIONWIDGETREGISTRY_H
20
21
#include "qgis_gui.h"
22
#include "
qgsabstractrelationeditorwidget.h
"
23
34
class
GUI_EXPORT
QgsRelationWidgetRegistry
35
{
36
public
:
40
QgsRelationWidgetRegistry
();
41
42
~QgsRelationWidgetRegistry
();
43
47
void
addRelationWidget
(
QgsAbstractRelationEditorWidgetFactory
*widgetFactory
SIP_TRANSFER
);
48
52
void
removeRelationWidget
(
const
QString &widgetType );
53
57
QStringList
relationWidgetNames
()
const
;
58
62
QMap<QString, QgsAbstractRelationEditorWidgetFactory *>
factories
()
const
;
63
71
QgsAbstractRelationEditorWidget
*
create
(
const
QString &widgetType,
const
QVariantMap &config, QWidget *parent =
nullptr
)
const
SIP_TRANSFERBACK
;
72
80
QgsAbstractRelationEditorConfigWidget
*
createConfigWidget
(
const
QString &widgetType,
const
QgsRelation
&relation, QWidget *parent =
nullptr
)
const
SIP_TRANSFERBACK
;
81
82
88
void
setDefaultWidgetType
(
const
QString &widgetType );
89
94
QString
defaultWidgetType
()
const
;
95
96
private
:
97
QMap<QString, QgsAbstractRelationEditorWidgetFactory *> mRelationWidgetFactories;
98
99
QString mDefaultWidgetType;
100
};
101
102
#endif
// QGSRELATIONWIDGETREGISTRY_H
QgsAbstractRelationEditorConfigWidget
Abstract base class for configurable relation widget types.
Definition
qgsabstractrelationeditorwidget.h:341
QgsAbstractRelationEditorWidgetFactory
Factory class for creating relation widgets and their corresponding config widgets.
Definition
qgsabstractrelationeditorwidget.h:420
QgsAbstractRelationEditorWidget
Base class to build new relation widgets.
Definition
qgsabstractrelationeditorwidget.h:46
QgsRelationWidgetRegistry::setDefaultWidgetType
void setDefaultWidgetType(const QString &widgetType)
Sets the default editor widget type.
Definition
qgsrelationwidgetregistry.cpp:60
QgsRelationWidgetRegistry::factories
QMap< QString, QgsAbstractRelationEditorWidgetFactory * > factories() const
Gets access to all registered factories.
Definition
qgsrelationwidgetregistry.cpp:73
QgsRelationWidgetRegistry::QgsRelationWidgetRegistry
QgsRelationWidgetRegistry()
Constructor.
Definition
qgsrelationwidgetregistry.cpp:22
QgsRelationWidgetRegistry::addRelationWidget
void addRelationWidget(QgsAbstractRelationEditorWidgetFactory *widgetFactory)
Adds a new registered relation widgetFactory.
Definition
qgsrelationwidgetregistry.cpp:35
QgsRelationWidgetRegistry::relationWidgetNames
QStringList relationWidgetNames() const
Returns a list of names of registered relation widgets.
Definition
qgsrelationwidgetregistry.cpp:55
QgsRelationWidgetRegistry::createConfigWidget
QgsAbstractRelationEditorConfigWidget * createConfigWidget(const QString &widgetType, const QgsRelation &relation, QWidget *parent=nullptr) const
Creates a configuration widget.
Definition
qgsrelationwidgetregistry.cpp:87
QgsRelationWidgetRegistry::removeRelationWidget
void removeRelationWidget(const QString &widgetType)
Removes a registered relation widget with given widgetType.
Definition
qgsrelationwidgetregistry.cpp:46
QgsRelationWidgetRegistry::create
QgsAbstractRelationEditorWidget * create(const QString &widgetType, const QVariantMap &config, QWidget *parent=nullptr) const
Create a relation widget of a given type for a given field.
Definition
qgsrelationwidgetregistry.cpp:78
QgsRelationWidgetRegistry::defaultWidgetType
QString defaultWidgetType() const
Returns the default editor widget type.
Definition
qgsrelationwidgetregistry.cpp:68
QgsRelation
Represents a relationship between two vector layers.
Definition
qgsrelation.h:42
SIP_TRANSFER
#define SIP_TRANSFER
Definition
qgis_sip.h:35
SIP_TRANSFERBACK
#define SIP_TRANSFERBACK
Definition
qgis_sip.h:47
qgsabstractrelationeditorwidget.h
Generated on
for QGIS API Documentation by
1.17.0