QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
qgsannotationitemguiregistry.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsannotationitemguiregistry.cpp
3 --------------------------
4 begin : September 2021
5 copyright : (C) 2021 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
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
19#include "qgsannotationitem.h"
23
24#include <QImageReader>
25
26#include "moc_qgsannotationitemguiregistry.cpp"
27
28//
29// QgsAnnotationItemAbstractGuiMetadata
30//
31
33{
34 return QgsApplication::getThemeIcon( QStringLiteral( "/mActionAddBasicRectangle.svg" ) );
35}
36
41
46
51
55
56//
57// QgsAnnotationItemGuiMetadata
58//
59
64
69
74
80
85
86
87//
88// QgsAnnotationItemGuiRegistry
89//
90
92 : QObject( parent )
93{
94}
95
96
101
103{
104 return mMetadata.value( metadataId );
105}
106
108{
109 for ( auto it = mMetadata.constBegin(); it != mMetadata.constEnd(); ++it )
110 {
111 if ( it.value()->type() == type )
112 return it.key();
113 }
114 return -1;
115}
116
118{
119 if ( !metadata )
120 return false;
121
122 const int id = mMetadata.count();
123 mMetadata[id] = metadata;
124 emit typeAdded( id );
125 return true;
126}
127
129{
130 if ( mItemGroups.contains( group.id ) )
131 return false;
132
133 mItemGroups.insert( group.id, group );
134 return true;
135}
136
138{
139 auto iter = mItemGroups.find( id );
140 if ( iter == mItemGroups.end() )
141 {
142 static QgsAnnotationItemGuiGroup invalidGroup;
143 return invalidGroup;
144 }
145 return *iter;
146}
147
149{
150 auto it = mMetadata.constFind( metadataId );
151 if ( it == mMetadata.constEnd() )
152 return nullptr;
153
154 std::unique_ptr<QgsAnnotationItem> item( it.value()->createItem() );
155 if ( item )
156 return item.release();
157
158 const QString type = it.value()->type();
160}
161
163{
164 auto it = mMetadata.constFind( metadataId );
165 if ( it == mMetadata.constEnd() )
166 return;
167
168 it.value()->newItemAddedToLayer( item, layer );
169}
170
172{
173 if ( !item )
174 return nullptr;
175
176 const QString &type = item->type();
177 for ( auto it = mMetadata.constBegin(); it != mMetadata.constEnd(); ++it )
178 {
179 if ( it.value()->type() == type )
180 return it.value()->createItemWidget( item );
181 }
182
183 return nullptr;
184}
185
187{
188 return mMetadata.keys();
189}
190
192{
193 addAnnotationItemGuiMetadata( new QgsAnnotationItemGuiMetadata( QStringLiteral( "polygon" ), QObject::tr( "Polygon Annotation" ), QgsApplication::getThemeIcon( QStringLiteral( "/mActionAddPolygon.svg" ) ), []( QgsAnnotationItem *item ) -> QgsAnnotationItemBaseWidget * {
194 QgsAnnotationPolygonItemWidget *widget = new QgsAnnotationPolygonItemWidget( nullptr );
195 widget->setItem( item );
196 return widget; }, QString(), Qgis::AnnotationItemGuiFlags(), nullptr, []( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) -> QgsCreateAnnotationItemMapToolInterface * { return new QgsCreatePolygonItemMapTool( canvas, cadDockWidget ); } ) );
197
198 addAnnotationItemGuiMetadata( new QgsAnnotationItemGuiMetadata( QStringLiteral( "linestring" ), QObject::tr( "Line Annotation" ), QgsApplication::getThemeIcon( QStringLiteral( "/mActionAddPolyline.svg" ) ), []( QgsAnnotationItem *item ) -> QgsAnnotationItemBaseWidget * {
199 QgsAnnotationLineItemWidget *widget = new QgsAnnotationLineItemWidget( nullptr );
200 widget->setItem( item );
201 return widget; }, QString(), Qgis::AnnotationItemGuiFlags(), nullptr, []( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) -> QgsCreateAnnotationItemMapToolInterface * { return new QgsCreateLineItemMapTool( canvas, cadDockWidget ); } ) );
202
203 addAnnotationItemGuiMetadata( new QgsAnnotationItemGuiMetadata( QStringLiteral( "marker" ), QObject::tr( "Marker Annotation" ), QgsApplication::getThemeIcon( QStringLiteral( "/mActionAddMarker.svg" ) ), []( QgsAnnotationItem *item ) -> QgsAnnotationItemBaseWidget * {
204 QgsAnnotationMarkerItemWidget *widget = new QgsAnnotationMarkerItemWidget( nullptr );
205 widget->setItem( item );
206 return widget; }, QString(), Qgis::AnnotationItemGuiFlags(), nullptr, []( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) -> QgsCreateAnnotationItemMapToolInterface * { return new QgsCreateMarkerItemMapTool( canvas, cadDockWidget ); } ) );
207
208 addAnnotationItemGuiMetadata( new QgsAnnotationItemGuiMetadata( QStringLiteral( "pointtext" ), QObject::tr( "Text Annotation at Point" ), QgsApplication::getThemeIcon( QStringLiteral( "/mActionText.svg" ) ), []( QgsAnnotationItem *item ) -> QgsAnnotationItemBaseWidget * {
209 QgsAnnotationPointTextItemWidget *widget = new QgsAnnotationPointTextItemWidget( nullptr );
210 widget->setItem( item );
211 return widget; }, QString(), Qgis::AnnotationItemGuiFlags(), nullptr, []( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) -> QgsCreateAnnotationItemMapToolInterface * { return new QgsCreatePointTextItemMapTool( canvas, cadDockWidget ); } ) );
212
213 addAnnotationItemGuiMetadata( new QgsAnnotationItemGuiMetadata( QStringLiteral( "linetext" ), QObject::tr( "Text Annotation along Line" ), QgsApplication::getThemeIcon( QStringLiteral( "/mActionTextAlongLine.svg" ) ), []( QgsAnnotationItem *item ) -> QgsAnnotationItemBaseWidget * {
214 QgsAnnotationLineTextItemWidget *widget = new QgsAnnotationLineTextItemWidget( nullptr );
215 widget->setItem( item );
216 return widget; }, QString(), Qgis::AnnotationItemGuiFlags(), nullptr, []( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) -> QgsCreateAnnotationItemMapToolInterface * { return new QgsCreateLineTextItemMapTool( canvas, cadDockWidget ); } ) );
217
218 addAnnotationItemGuiMetadata( new QgsAnnotationItemGuiMetadata( QStringLiteral( "recttext" ), QObject::tr( "Text Annotation in Rectangle" ), QgsApplication::getThemeIcon( QStringLiteral( "/mActionTextInsideRect.svg" ) ), []( QgsAnnotationItem *item ) -> QgsAnnotationItemBaseWidget * {
219 QgsAnnotationRectangleTextItemWidget *widget = new QgsAnnotationRectangleTextItemWidget( nullptr );
220 widget->setItem( item );
221 return widget; }, QString(), Qgis::AnnotationItemGuiFlags(), nullptr, []( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) -> QgsCreateAnnotationItemMapToolInterface * { return new QgsCreateRectangleTextItemMapTool( canvas, cadDockWidget ); } ) );
222
223 addAnnotationItemGuiMetadata( new QgsAnnotationItemGuiMetadata( QStringLiteral( "picture" ), QObject::tr( "Picture Annotation" ), QgsApplication::getThemeIcon( QStringLiteral( "/mActionAddImage.svg" ) ), []( QgsAnnotationItem *item ) -> QgsAnnotationItemBaseWidget * {
224 QgsAnnotationPictureItemWidget *widget = new QgsAnnotationPictureItemWidget( nullptr );
225 widget->setItem( item );
226 return widget; }, QString(), Qgis::AnnotationItemGuiFlags(), nullptr, []( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) -> QgsCreateAnnotationItemMapToolInterface * { return new QgsCreatePictureItemMapTool( canvas, cadDockWidget ); } ) );
227}
QFlags< AnnotationItemGuiFlag > AnnotationItemGuiFlags
Annotation item GUI flags.
Definition qgis.h:2497
A dockable widget used to handle the CAD tools on top of a selection of map tools.
Stores GUI metadata about one annotation item class.
virtual QgsCreateAnnotationItemMapToolInterface * createMapTool(QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget)
Creates a map tool for a creating a new item of this type.
virtual QgsAnnotationItemBaseWidget * createItemWidget(QgsAnnotationItem *item)
Creates a configuration widget for an item of this type.
virtual void newItemAddedToLayer(QgsAnnotationItem *item, QgsAnnotationLayer *layer)
Called when a newly created item of the associated type has been added to a layer.
virtual QIcon creationIcon() const
Returns an icon representing creation of the annotation item type.
virtual QgsAnnotationItem * createItem()
Creates an instance of the corresponding item type.
A base class for property widgets for annotation items.
Stores GUI metadata about a group of annotation item classes.
QString id
Unique (untranslated) group ID string.
Convenience metadata class that uses static functions to handle annotation item GUI behavior.
QgsAnnotationItem * createItem() override
Creates an instance of the corresponding item type.
QgsAnnotationItemAddedToLayerFunc mAddedToLayerFunc
QgsAnnotationItemBaseWidget * createItemWidget(QgsAnnotationItem *item) override
Creates a configuration widget for an item of this type.
QgsAnnotationItemCreateFunc mCreateFunc
QIcon creationIcon() const override
Returns an icon representing creation of the annotation item type.
QgsAnnotationItemWidgetFunc mWidgetFunc
void newItemAddedToLayer(QgsAnnotationItem *item, QgsAnnotationLayer *layer) override
Called when a newly created item of the associated type has been added to a layer.
QgsCreateAnnotationItemMapToolInterface * createMapTool(QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget) override
Creates a map tool for a creating a new item of this type.
QgsCreateAnnotationItemMapToolFunc mCreateMapToolFunc
QgsAnnotationItemBaseWidget * createItemWidget(QgsAnnotationItem *item) const
Creates a new instance of an annotation item configuration widget for the specified item.
bool addItemGroup(const QgsAnnotationItemGuiGroup &group)
Registers a new item group with the registry.
QgsAnnotationItemAbstractGuiMetadata * itemMetadata(int metadataId) const
Returns the metadata for the specified item metadataId.
bool addAnnotationItemGuiMetadata(QgsAnnotationItemAbstractGuiMetadata *metadata)
Registers the gui metadata for a new annotation item type.
void addDefaultItems()
Populates the registry with default items.
QList< int > itemMetadataIds() const
Returns a list of available item metadata ids handled by the registry.
int metadataIdForItemType(const QString &type) const
Returns the GUI item metadata ID which corresponds to the specified annotation item type.
const QgsAnnotationItemGuiGroup & itemGroup(const QString &id) const
Returns a reference to the item group with matching id.
void typeAdded(int metadataId)
Emitted whenever a new item type is added to the registry, with the specified metadataId.
QgsAnnotationItem * createItem(int metadataId) const
Creates a new instance of an annotation item given the item metadata metadataId.
void newItemAddedToLayer(int metadataId, QgsAnnotationItem *item, QgsAnnotationLayer *layer)
Called when a newly created item of the associated metadata metadataId has been added to a layer.
QgsAnnotationItemGuiRegistry(QObject *parent=nullptr)
Creates a new empty item GUI registry.
QgsAnnotationItem * createItem(const QString &type) const
Creates a new instance of a annotation item given the item type.
Abstract base class for annotation items which are drawn with QgsAnnotationLayers.
virtual QString type() const =0
Returns a unique (untranslated) string identifying the type of item.
Represents a map layer containing a set of georeferenced annotations, e.g.
static QgsAnnotationItemRegistry * annotationItemRegistry()
Returns the application's annotation item registry, used for annotation item types.
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
An interface for map tools which create annotation items.
A map tool to digitize line items.
A map tool to digitize line text items.
A map tool to digitize marker items.
A map tool to digitize picture items.
A map tool to digitize point text items.
A map tool to digitize polygon items.
A map tool to digitize rectangle text items.
Map canvas is a class for displaying all GIS data types on a canvas.