QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgsformannotation.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsformannotation.cpp
3 ------------------------
4 begin : February 26, 2010
5 copyright : (C) 2010 by Marco Hugentobler
6 email : marco dot hugentobler at hugis dot net
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#include "qgsformannotation.h"
22#include "qgsfeature.h"
23#include "qgsfeatureiterator.h"
24#include "qgslogger.h"
25#include "qgsmapcanvas.h"
26#include "qgsproject.h"
27#include "qgsmaptool.h"
28#include "qgsvectorlayer.h"
29#include "qgsgui.h"
30#include "qgsfillsymbol.h"
31
32#include <QDomElement>
33#include <QDir>
34#include <QFile>
35#include <QFileInfo>
36#include <QGraphicsProxyWidget>
37#include <QPainter>
38#include <QSettings>
39#include <QUiLoader>
40#include <QWidget>
41
43 : QgsAnnotation( parent )
44{}
45
47{
48 std::unique_ptr< QgsFormAnnotation > c( new QgsFormAnnotation() );
49 copyCommonProperties( c.get() );
50 c->setDesignerForm( mDesignerForm );
51 return c.release();
52}
53
54void QgsFormAnnotation::setDesignerForm( const QString &uiFile )
55{
56 mDesignerForm = uiFile;
57 mDesignerWidget.reset( createDesignerWidget( uiFile ) );
58 if ( mDesignerWidget )
59 {
60 mMinimumSize = mDesignerWidget->minimumSize();
61 if ( auto *lFillSymbol = fillSymbol() )
62 {
63 QgsFillSymbol *newFill = lFillSymbol->clone();
64 newFill->setColor( mDesignerWidget->palette().color( QPalette::Window ) );
65 setFillSymbol( newFill );
66 }
67 // convert from size in pixels at 96 dpi to mm
68 setFrameSizeMm( preferredFrameSize() / 3.7795275 );
69 }
70 emit appearanceChanged();
71}
72
73QWidget *QgsFormAnnotation::createDesignerWidget( const QString &filePath )
74{
75 QFile file( filePath );
76 if ( !file.open( QFile::ReadOnly ) )
77 {
78 return nullptr;
79 }
80
81 QUiLoader loader;
82 const QFileInfo fi( file );
83 loader.setWorkingDirectory( fi.dir() );
84 QWidget *widget = loader.load( &file, nullptr );
85 file.close();
86
87 //get feature and set attribute information
88 const QgsAttributeEditorContext context;
89 QgsVectorLayer *vectorLayer = qobject_cast< QgsVectorLayer * >( mapLayer() );
90 if ( vectorLayer && associatedFeature().isValid() )
91 {
92 const QgsFields fields = vectorLayer->fields();
94 for ( int i = 0; i < attrs.count(); ++i )
95 {
96 if ( i < fields.count() )
97 {
98 QWidget *attWidget = widget->findChild<QWidget *>( fields.at( i ).name() );
99 if ( attWidget )
100 {
101 QgsEditorWidgetWrapper *eww = QgsGui::editorWidgetRegistry()->create( vectorLayer, i, attWidget, widget, context );
102 if ( eww )
103 {
104 const QStringList additionalFields = eww->additionalFields();
105 QVariantList additionalFieldValues;
106 for ( const QString &additionalField : additionalFields )
107 {
108 const int index = vectorLayer->fields().indexFromName( additionalField );
109 additionalFieldValues.insert( index, attrs.at( index ) );
110 }
111 eww->setValues( attrs.at( i ), additionalFieldValues );
112 }
113 }
114 }
115 }
116 }
117 return widget;
118}
119
120void QgsFormAnnotation::renderAnnotation( QgsRenderContext &context, QSizeF size ) const
121{
122 if ( !mDesignerWidget || !context.painter() || ( context.feedback() && context.feedback()->isCanceled() ) )
123 return;
124
125 // scale painter back to 96 dpi, so that forms look good even in layout prints
126 const QgsScopedQPainterState painterState( context.painter() );
127 const double scaleFactor = context.painter()->device()->logicalDpiX() / 96.0;
128 context.painter()->scale( scaleFactor, scaleFactor );
129 size /= scaleFactor;
130
131 mDesignerWidget->setFixedSize( size.toSize() );
132 context.painter()->setBrush( Qt::NoBrush );
133 context.painter()->setPen( Qt::NoPen );
134 mDesignerWidget->render( context.painter(), QPoint( 0, 0 ) );
135}
136
138{
139 if ( mDesignerWidget )
140 {
141 const QSizeF widgetMinSize = mMinimumSize;
142 return QSizeF( contentsMargin().left() + contentsMargin().right() + widgetMinSize.width(),
143 contentsMargin().top() + contentsMargin().bottom() + widgetMinSize.height() );
144 }
145 else
146 {
147 return QSizeF( 0, 0 );
148 }
149}
150
152{
153 if ( mDesignerWidget )
154 {
155 return mDesignerWidget->sizeHint();
156 }
157 else
158 {
159 return QSizeF( 0, 0 );
160 }
161}
162
163void QgsFormAnnotation::writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const
164{
165 QDomElement formAnnotationElem = doc.createElement( QStringLiteral( "FormAnnotationItem" ) );
166 formAnnotationElem.setAttribute( QStringLiteral( "designerForm" ), mDesignerForm );
167 _writeXml( formAnnotationElem, doc, context );
168 elem.appendChild( formAnnotationElem );
169}
170
171void QgsFormAnnotation::readXml( const QDomElement &itemElem, const QgsReadWriteContext &context )
172{
173 mDesignerForm = itemElem.attribute( QStringLiteral( "designerForm" ), QString() );
174 const QDomElement annotationElem = itemElem.firstChildElement( QStringLiteral( "AnnotationItem" ) );
175 if ( !annotationElem.isNull() )
176 {
177 _readXml( annotationElem, context );
178 }
179 // upgrade old layer
180 if ( !mapLayer() && itemElem.hasAttribute( QStringLiteral( "vectorLayer" ) ) )
181 {
182 setMapLayer( QgsProject::instance()->mapLayer( itemElem.attribute( QStringLiteral( "vectorLayer" ) ) ) );
183 }
184
185 mDesignerWidget.reset( createDesignerWidget( mDesignerForm ) );
186 if ( mDesignerWidget && fillSymbol() )
187 {
188 QgsFillSymbol *newFill = fillSymbol()->clone();
189 newFill->setColor( mDesignerWidget->palette().color( QPalette::Window ) );
190 setFillSymbol( newFill );
191 }
192}
193
195{
197
198 //create new embedded widget
199 mDesignerWidget.reset( createDesignerWidget( mDesignerForm ) );
200 if ( mDesignerWidget && fillSymbol() )
201 {
202 QgsFillSymbol *newFill = fillSymbol()->clone();
203 newFill->setColor( mDesignerWidget->palette().color( QPalette::Window ) );
204 setFillSymbol( newFill );
205 }
206 emit appearanceChanged();
207}
208
209
210
Abstract base class for annotation items which are drawn over a map.
Definition: qgsannotation.h:53
void appearanceChanged()
Emitted whenever the annotation's appearance changes.
void setFillSymbol(QgsFillSymbol *symbol)
Sets the fill symbol used for rendering the annotation frame.
QgsMargins contentsMargin() const
Returns the margins (in millimeters) between the outside of the frame and the annotation content.
void _writeXml(QDomElement &itemElem, QDomDocument &doc, const QgsReadWriteContext &context) const
Writes common annotation properties to a DOM element.
QgsMapLayer * mapLayer() const
Returns the map layer associated with the annotation.
void setFrameSizeMm(QSizeF size)
Sets the size (in millimeters) of the annotation's frame (the main area in which the annotation's con...
virtual void setAssociatedFeature(const QgsFeature &feature)
Sets the feature associated with the annotation.
QgsFeature associatedFeature() const
Returns the feature associated with the annotation, or an invalid feature if none has been set.
void _readXml(const QDomElement &annotationElem, const QgsReadWriteContext &context)
Reads common annotation properties from a DOM element.
void copyCommonProperties(QgsAnnotation *target) const
Copies common annotation properties to the targe annotation.
QgsFillSymbol * fillSymbol() const
Returns the symbol that is used for rendering the annotation frame.
void setMapLayer(QgsMapLayer *layer)
Sets the map layer associated with the annotation.
This class contains context information for attribute editor widgets.
A vector of attributes.
Definition: qgsattributes.h:59
QgsEditorWidgetWrapper * create(const QString &widgetId, QgsVectorLayer *vl, int fieldIdx, const QVariantMap &config, QWidget *editor, QWidget *parent, const QgsAttributeEditorContext &context=QgsAttributeEditorContext())
Create an attribute editor widget wrapper of a given type for a given field.
Manages an editor widget Widget and wrapper share the same parent.
virtual QStringList additionalFields() const
Returns the list of additional fields which the editor handles.
void setValues(const QVariant &value, const QVariantList &additionalValues)
Is called when the value of the widget or additional field values needs to be changed.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
QgsAttributes attributes
Definition: qgsfeature.h:65
bool isCanceled() const
Tells whether the operation has been canceled already.
Definition: qgsfeedback.h:53
QString name
Definition: qgsfield.h:62
Container of fields for a vector layer.
Definition: qgsfields.h:45
int indexFromName(const QString &fieldName) const
Gets the field index from the field name.
Definition: qgsfields.cpp:202
int count() const
Returns number of items.
Definition: qgsfields.cpp:133
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
Definition: qgsfields.cpp:163
A fill symbol type, for rendering Polygon and MultiPolygon geometries.
Definition: qgsfillsymbol.h:30
QgsFillSymbol * clone() const override
Returns a deep copy of this symbol.
An annotation item that embeds a designer form showing the feature attribute.
QgsFormAnnotation * clone() const override
Clones the annotation, returning a new copy of the annotation reflecting the annotation's current sta...
void renderAnnotation(QgsRenderContext &context, QSizeF size) const override
Renders the annotation's contents to a target /a context at the specified /a size.
QgsFormAnnotation(QObject *parent=nullptr)
Constructor for QgsFormAnnotation.
void setAssociatedFeature(const QgsFeature &feature) override
Sets the feature associated with the annotation.
void writeXml(QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context) const override
Writes the annotation state to a DOM element.
void readXml(const QDomElement &itemElem, const QgsReadWriteContext &context) override
Restores the annotation's state from a DOM element.
QSizeF minimumFrameSize() const override
Returns the minimum frame size for the annotation.
void setDesignerForm(const QString &uiFile)
Sets the path to the Qt Designer UI file to show in the annotation.
QSizeF preferredFrameSize() const
Returns the optimal frame size.
static QgsEditorWidgetRegistry * editorWidgetRegistry()
Returns the global editor widget registry, used for managing all known edit widget factories.
Definition: qgsgui.cpp:89
static QgsProject * instance()
Returns the QgsProject singleton instance.
Definition: qgsproject.cpp:481
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.
QPainter * painter()
Returns the destination QPainter for the render operation.
QgsFeedback * feedback() const
Returns the feedback object that can be queried regularly during rendering to check if rendering shou...
Scoped object for saving and restoring a QPainter object's state.
void setColor(const QColor &color) const
Sets the color for the symbol.
Definition: qgssymbol.cpp:902
Represents a vector layer which manages a vector based data sets.
QgsFields fields() const FINAL
Returns the list of fields of this layer.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c