QGIS API Documentation 3.43.0-Master (58029bba303)
qgslabelsettingswidgetbase.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgslabelsettingswidgetbase.h
3 ----------------------
4 begin : December 2019
5 copyright : (C) 2019 by Nyall Dawson
6 email : nyall dot dawson 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
18#include "moc_qgslabelsettingswidgetbase.cpp"
23#include "qgsauxiliarystorage.h"
24#include "qgsgui.h"
25
26
28 : QgsPanelWidget( parent )
29 , mLayer( vl )
30{
31}
32
34{
35 mContext = context;
36}
37
42
46
48{
49 if ( auto *lExpressionContext = mContext.expressionContext() )
50 return *lExpressionContext;
51
52 QgsExpressionContext expContext( mContext.globalProjectAtlasMapLayerScopes( mLayer ) );
55 expContext << symbolScope;
56
57 // additional scopes
58 const auto constAdditionalExpressionContextScopes = mContext.additionalExpressionContextScopes();
59 for ( const QgsExpressionContextScope &scope : constAdditionalExpressionContextScopes )
60 {
61 expContext.appendScope( new QgsExpressionContextScope( scope ) );
62 }
63
64 //TODO - show actual value
65 expContext.setOriginalValueVariable( QVariant() );
66
68
69 return expContext;
70}
71
72void QgsLabelSettingsWidgetBase::createAuxiliaryField()
73{
74 auto vectorLayer = qobject_cast< QgsVectorLayer * >( mLayer );
75 if ( !vectorLayer )
76 return;
77
78 // try to create an auxiliary layer if not yet created
79 if ( !vectorLayer->auxiliaryLayer() )
80 {
81 QgsNewAuxiliaryLayerDialog dlg( vectorLayer, this );
82 dlg.exec();
83 }
84
85 // return if still not exists
86 if ( !vectorLayer->auxiliaryLayer() )
87 return;
88
89 QgsPropertyOverrideButton *button = qobject_cast<QgsPropertyOverrideButton *>( sender() );
92
93 // create property in auxiliary storage if necessary
94 if ( !vectorLayer->auxiliaryLayer()->exists( def ) )
95 {
96 QgsNewAuxiliaryFieldDialog dlg( def, vectorLayer, true, this );
97 if ( dlg.exec() == QDialog::Accepted )
98 def = dlg.propertyDefinition();
99 }
100
101 // return if still not exist
102 if ( !vectorLayer->auxiliaryLayer()->exists( def ) )
103 return;
104
105 // update property with join field name from auxiliary storage
106 QgsProperty property = button->toProperty();
107 property.setField( QgsAuxiliaryLayer::nameFromProperty( def, true ) );
108 property.setActive( true );
109 button->updateFieldLists();
110 button->setToProperty( property );
111
113
115
116 emit changed();
117}
118
119void QgsLabelSettingsWidgetBase::updateDataDefinedProperty()
120{
121 QgsPropertyOverrideButton *button = qobject_cast<QgsPropertyOverrideButton *>( sender() );
122 const QgsPalLayerSettings::Property key = static_cast<QgsPalLayerSettings::Property>( button->propertyKey() );
124 emit changed();
125}
126
131
133{
135
136 const auto overrideButtons = findChildren<QgsPropertyOverrideButton *>();
137 for ( QgsPropertyOverrideButton *button : overrideButtons )
138 {
139 const QgsPalLayerSettings::Property key = static_cast<QgsPalLayerSettings::Property>( button->propertyKey() );
141 }
142}
143
147
149{
150 auto vectorLayer = qobject_cast< QgsVectorLayer * >( mLayer );
151
152 button->init( static_cast<int>( key ), mDataDefinedProperties, QgsPalLayerSettings::propertyDefinitions(), vectorLayer, true );
153 connect( button, &QgsPropertyOverrideButton::changed, this, &QgsLabelSettingsWidgetBase::updateDataDefinedProperty );
154 connect( button, &QgsPropertyOverrideButton::createAuxiliaryField, this, &QgsLabelSettingsWidgetBase::createAuxiliaryField );
155
157}
158
159
160//
161// QgsLabelSettingsWidgetDialog
162//
163
165 : QDialog( parent )
166{
167 setWindowTitle( widget->windowTitle() );
168 QVBoxLayout *vLayout = new QVBoxLayout();
169 vLayout->addWidget( widget );
170 mButtonBox = new QDialogButtonBox( QDialogButtonBox::Ok | QDialogButtonBox::Cancel, Qt::Horizontal );
171 connect( mButtonBox, &QDialogButtonBox::accepted, this, &QDialog::accept );
172 connect( mButtonBox, &QDialogButtonBox::rejected, this, &QDialog::reject );
173 vLayout->addWidget( mButtonBox );
174 setLayout( vLayout );
175
176 setObjectName( QStringLiteral( "QgsLabelSettingsWidgetDialog" ) );
178}
179
181{
182 return mButtonBox;
183}
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition qgis.h:337
static QString nameFromProperty(const QgsPropertyDefinition &def, bool joined=false)
Returns the name of the auxiliary field for a property definition.
Single scope for storing variables and functions for use within a QgsExpressionContext.
void addVariable(const QgsExpressionContextScope::StaticVariable &variable)
Adds a variable into the context scope.
static QgsExpressionContextScope * updateSymbolScope(const QgsSymbol *symbol, QgsExpressionContextScope *symbolScope=nullptr)
Updates a symbol scope related to a QgsSymbol to an expression context.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void setOriginalValueVariable(const QVariant &value)
Sets the original value variable value for the context.
static const QString EXPR_SYMBOL_COLOR
Inbuilt variable name for symbol color variable.
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
void setHighlightedVariables(const QStringList &variableNames)
Sets the list of variable names within the context intended to be highlighted to the user.
static const QString EXPR_ORIGINAL_VALUE
Inbuilt variable name for value original value variable.
static void enableAutoGeometryRestore(QWidget *widget, const QString &key=QString())
Register the widget to allow its position to be automatically saved and restored when open and closed...
Definition qgsgui.cpp:210
Base class for widgets which allow customization of label engine properties, such as label placement ...
QgsLabelSettingsWidgetBase(QWidget *parent=nullptr, QgsMapLayer *vl=nullptr)
Constructor for QgsLabelSettingsWidgetBase.
virtual void updateDataDefinedProperties(QgsPropertyCollection &properties)
Updates a data defined properties collection, correctly setting the values for any properties related...
void changed()
Emitted when any of the settings described by the widget are changed.
QgsSymbolWidgetContext context() const
Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expressi...
void registerDataDefinedButton(QgsPropertyOverrideButton *button, QgsPalLayerSettings::Property key)
Registers a data defined override button.
virtual void setContext(const QgsSymbolWidgetContext &context)
Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression ...
QgsPropertyCollection mDataDefinedProperties
Contains the data defined properties defined by the widget.
virtual void setGeometryType(Qgis::GeometryType type)
Sets the geometry type of the features to customize the widget accordingly.
void auxiliaryFieldCreated()
Emitted when an auxiliary field is created in the widget.
void setDataDefinedProperties(const QgsPropertyCollection &dataDefinedProperties)
Sets the current data defined properties to show in the widget.
QgsPropertyCollection dataDefinedProperties() const
Returns the current data defined properties state as specified in the widget.
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
QgsLabelSettingsWidgetDialog(QgsLabelSettingsWidgetBase *widget, QWidget *parent=nullptr)
Constructor for QgsLabelSettingsWidgetDialog.
QDialogButtonBox * buttonBox()
Returns the dialog's button box.
Base class for all map layer types.
Definition qgsmaplayer.h:77
A dialog to create a new auxiliary field.
A dialog to create a new auxiliary layer.
Property
Data definable properties.
static const QgsPropertiesDefinition & propertyDefinitions()
Returns the labeling property definitions.
Base class for any widget that can be shown as an inline panel.
A grouped map of multiple QgsProperty objects, each referenced by an integer key value.
void setProperty(int key, const QgsProperty &property)
Adds a property to the collection and takes ownership of it.
QgsProperty property(int key) const final
Returns a matching property from the collection, if one exists.
Definition for a property.
Definition qgsproperty.h:45
A button for controlling property overrides which may apply to a widget.
QgsProperty toProperty() const
Returns a QgsProperty object encapsulating the current state of the widget.
void updateFieldLists()
Updates list of fields.
void changed()
Emitted when property definition changes.
void init(int propertyKey, const QgsProperty &property, const QgsPropertiesDefinition &definitions, const QgsVectorLayer *layer=nullptr, bool auxiliaryStorageEnabled=false)
Initialize a newly constructed property button (useful if button was included in a UI layout).
void registerExpressionContextGenerator(QgsExpressionContextGenerator *generator)
Register an expression context generator class that will be used to retrieve an expression context fo...
int propertyKey() const
Returns the property key linked to the button.
void setToProperty(const QgsProperty &property)
Sets the widget to reflect the current state of a QgsProperty.
void createAuxiliaryField()
Emitted when creating a new auxiliary field.
A store for object properties.
void setField(const QString &field)
Sets the field name the property references.
Contains settings which reflect the context in which a symbol (or renderer) widget is shown,...
QList< QgsExpressionContextScope > additionalExpressionContextScopes() const
Returns the list of additional expression context scopes to show as available within the layer.
QList< QgsExpressionContextScope * > globalProjectAtlasMapLayerScopes(const QgsMapLayer *layer) const
Returns list of scopes: global, project, atlas, map, layer.
QgsExpressionContext * expressionContext() const
Returns the expression context used for the widget, if set.
Single variable definition for use within a QgsExpressionContextScope.