QGIS API Documentation 3.30.0-'s-Hertogenbosch (f186b8efe0)
qgsattributeeditorelement.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsattributeeditorelement.cpp - QgsAttributeEditorElement
3
4 ---------------------
5 begin : 18.8.2016
6 copyright : (C) 2016 by Matthias Kuhn
8 ***************************************************************************
9 * *
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
14 * *
15 ***************************************************************************/
16
18
27#include "qgssymbollayerutils.h"
28#include "qgsfontutils.h"
29
30QDomElement QgsAttributeEditorElement::toDomElement( QDomDocument &doc ) const
31{
32 QDomElement elem = doc.createElement( typeIdentifier() );
33 elem.setAttribute( QStringLiteral( "name" ), mName );
34 elem.setAttribute( QStringLiteral( "showLabel" ), mShowLabel );
35 elem.appendChild( mLabelStyle.writeXml( doc ) );
36 saveConfiguration( elem, doc );
37 return elem;
38}
39
41{
42 return mShowLabel;
43}
44
46{
48}
49
51{
52 return mLabelStyle;
53}
54
56{
58}
59
60QgsAttributeEditorElement *QgsAttributeEditorElement::create( const QDomElement &element, const QString &layerId, const QgsFields &fields, const QgsReadWriteContext &context, QgsAttributeEditorElement *parent )
61{
62 QgsAttributeEditorElement *newElement = nullptr;
63
64 const QString name = element.attribute( QStringLiteral( "name" ) );
65
66 if ( element.tagName() == QLatin1String( "attributeEditorContainer" ) )
67 {
68 newElement = new QgsAttributeEditorContainer( context.projectTranslator()->translate( QStringLiteral( "project:layers:%1:formcontainers" ).arg( layerId ),
69 name ), parent );
70 }
71 else if ( element.tagName() == QLatin1String( "attributeEditorField" ) )
72 {
73 const int idx = fields.lookupField( name );
74 newElement = new QgsAttributeEditorField( name, idx, parent );
75 }
76 else if ( element.tagName() == QLatin1String( "attributeEditorRelation" ) )
77 {
78 // At this time, the relations are not loaded
79 // So we only grab the id and delegate the rest to onRelationsLoaded()
80 newElement = new QgsAttributeEditorRelation( element.attribute( QStringLiteral( "relation" ), QStringLiteral( "[None]" ) ), parent );
81 }
82 else if ( element.tagName() == QLatin1String( "attributeEditorQmlElement" ) )
83 {
84 newElement = new QgsAttributeEditorQmlElement( element.attribute( QStringLiteral( "name" ) ), parent );
85 }
86 else if ( element.tagName() == QLatin1String( "attributeEditorHtmlElement" ) )
87 {
88 newElement = new QgsAttributeEditorHtmlElement( element.attribute( QStringLiteral( "name" ) ), parent );
89 }
90 else if ( element.tagName() == QLatin1String( "attributeEditorTextElement" ) )
91 {
92 newElement = new QgsAttributeEditorTextElement( element.attribute( QStringLiteral( "name" ) ), parent );
93 }
94 else if ( element.tagName() == QLatin1String( "attributeEditorSpacerElement" ) )
95 {
96 newElement = new QgsAttributeEditorSpacerElement( element.attribute( QStringLiteral( "name" ) ), parent );
97 }
98 else if ( element.tagName() == QLatin1String( "attributeEditorAction" ) )
99 {
100 newElement = new QgsAttributeEditorAction( QUuid( element.attribute( QStringLiteral( "name" ) ) ), parent );
101 }
102
103 if ( newElement )
104 {
105 if ( element.hasAttribute( QStringLiteral( "showLabel" ) ) )
106 newElement->setShowLabel( element.attribute( QStringLiteral( "showLabel" ) ).toInt() );
107 else
108 newElement->setShowLabel( true );
109
110 // Label font and color
111 LabelStyle style;
112 style.readXml( element );
113 newElement->setLabelStyle( style );
114
115 newElement->loadConfiguration( element, layerId, context, fields );
116 }
117
118 return newElement;
119}
120
121
123{
124 QDomElement element { node.firstChildElement( QStringLiteral( "labelStyle" ) ) };
125
126 if ( ! element.isNull() )
127 {
128
129 // Label font and color
130 if ( element.hasAttribute( QStringLiteral( "labelColor" ) ) )
131 {
132 color = QgsSymbolLayerUtils::decodeColor( element.attribute( QStringLiteral( "labelColor" ) ) );
133 }
134
135 QFont newFont;
136 QgsFontUtils::setFromXmlChildNode( newFont, element, QStringLiteral( "labelFont" ) );
137
138 font = newFont;
139
140 if ( element.hasAttribute( QStringLiteral( "overrideLabelColor" ) ) )
141 {
142 overrideColor = element.attribute( QStringLiteral( "overrideLabelColor" ) ) == QChar( '1' );
143 }
144
145 if ( element.hasAttribute( QStringLiteral( "overrideLabelFont" ) ) )
146 {
147 overrideFont = element.attribute( QStringLiteral( "overrideLabelFont" ) ) == QChar( '1' );
148 }
149 }
150}
151
152QDomElement QgsAttributeEditorElement::LabelStyle::writeXml( QDomDocument &document ) const
153{
154 QDomElement elem { document.createElement( QStringLiteral( "labelStyle" ) ) };
155 elem.setAttribute( QStringLiteral( "labelColor" ), QgsSymbolLayerUtils::encodeColor( color ) );
156 elem.appendChild( QgsFontUtils::toXmlElement( font, document, QStringLiteral( "labelFont" ) ) );
157 elem.setAttribute( QStringLiteral( "overrideLabelColor" ), overrideColor ? QChar( '1' ) : QChar( '0' ) );
158 elem.setAttribute( QStringLiteral( "overrideLabelFont" ), overrideFont ? QChar( '1' ) : QChar( '0' ) );
159 return elem;
160}
161
163{
164 return overrideColor == other.overrideColor && overrideFont == other.overrideFont && color == other.color && font == other.font;
165}
This element will load a layer action onto the form.
This is a container for attribute editors, used to group them visually in the attribute form if it is...
This is an abstract base class for any elements of a drag and drop form.
QDomElement toDomElement(QDomDocument &doc) const
Gets the XML Dom element to save this element.
QgsAttributeEditorElement * parent() const
Gets the parent of this element.
LabelStyle labelStyle() const
Returns the label style.
void setLabelStyle(const LabelStyle &labelStyle)
Sets the labelStyle.
bool showLabel() const
Controls if this element should be labeled with a title (field, relation or groupname).
QString name() const
Returns the name of this element.
static QgsAttributeEditorElement * create(const QDomElement &element, const QString &layerId, const QgsFields &fields, const QgsReadWriteContext &context, QgsAttributeEditorElement *parent=nullptr)
Constructs the editor element from the given element.
void setShowLabel(bool showLabel)
Controls if this element should be labeled with a title (field, relation or groupname).
This element will load a field's widget onto the form.
An attribute editor widget that will represent arbitrary HTML code.
An attribute editor widget that will represent arbitrary QML code.
This element will load a relation editor onto the form.
An attribute editor widget that will represent a spacer.
An attribute editor widget that will represent arbitrary text code.
Container of fields for a vector layer.
Definition: qgsfields.h:45
int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
Definition: qgsfields.cpp:359
static bool setFromXmlChildNode(QFont &font, const QDomElement &element, const QString &childNode)
Sets the properties of a font to match the properties stored in an XML child node.
static QDomElement toXmlElement(const QFont &font, QDomDocument &document, const QString &elementName)
Returns a DOM element containing the properties of the font.
virtual QString translate(const QString &context, const QString &sourceText, const char *disambiguation=nullptr, int n=-1) const =0
The derived translate() translates with QTranslator and qm file the sourceText.
The class is used as a container of context for various read/write operations on other objects.
const QgsProjectTranslator * projectTranslator() const
Returns the project translator.
static QColor decodeColor(const QString &str)
static QString encodeColor(const QColor &color)
The TabStyle struct defines color and font overrides for form fields, tabs and groups labels.
void readXml(const QDomNode &node)
Reads configuration from node.
QDomElement writeXml(QDomDocument &document) const
Creates the XML configuration from document.
bool operator==(LabelStyle const &other) const
Returns true if the style is equal to other.