QGIS API Documentation 4.0.0-Norrköping (1ddcee3d0e4)
Loading...
Searching...
No Matches
qgsannotationitemregistry.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsannotationitemregistry.cpp
3 -------------------------
4 begin : October 2019
5 copyright : (C) 2019 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"
27
28#include <QDomElement>
29#include <QString>
30
31#include "moc_qgsannotationitemregistry.cpp"
32
33using namespace Qt::StringLiterals;
34
36 : QObject( parent )
37{}
38
40{
41 qDeleteAll( mMetadata );
42}
43
45{
46 if ( !mMetadata.isEmpty() )
47 return false;
48
49 mMetadata.insert( u"marker"_s, new QgsAnnotationItemMetadata( u"marker"_s, QObject::tr( "Marker" ), QObject::tr( "Markers" ), QgsAnnotationMarkerItem::create ) );
50 mMetadata.insert( u"linestring"_s, new QgsAnnotationItemMetadata( u"linestring"_s, QObject::tr( "Polyline" ), QObject::tr( "Polylines" ), QgsAnnotationLineItem::create ) );
51 mMetadata.insert( u"polygon"_s, new QgsAnnotationItemMetadata( u"polygon"_s, QObject::tr( "Polygon" ), QObject::tr( "Polygons" ), QgsAnnotationPolygonItem::create ) );
52 mMetadata.insert( u"pointtext"_s, new QgsAnnotationItemMetadata( u"pointtext"_s, QObject::tr( "Text at point" ), QObject::tr( "Text at points" ), QgsAnnotationPointTextItem::create ) );
53 mMetadata.insert( u"linetext"_s, new QgsAnnotationItemMetadata( u"linetext"_s, QObject::tr( "Text along line" ), QObject::tr( "Text along lines" ), QgsAnnotationLineTextItem::create ) );
54 mMetadata.insert( u"recttext"_s, new QgsAnnotationItemMetadata( u"recttext"_s, QObject::tr( "Text in rectangle" ), QObject::tr( "Text in rectangles" ), QgsAnnotationRectangleTextItem::create ) );
55 mMetadata.insert( u"picture"_s, new QgsAnnotationItemMetadata( u"picture"_s, QObject::tr( "Picture" ), QObject::tr( "Pictures" ), QgsAnnotationPictureItem::create ) );
56 return true;
57}
58
60{
61 return mMetadata.value( type );
62}
63
65{
66 if ( !metadata || mMetadata.contains( metadata->type() ) )
67 return false;
68
69 mMetadata[metadata->type()] = metadata;
70 emit typeAdded( metadata->type(), metadata->visibleName() );
71 return true;
72}
73
75{
76 if ( !mMetadata.contains( type ) )
77 return nullptr;
78
79 return mMetadata[type]->createItem();
80}
81
82QMap<QString, QString> QgsAnnotationItemRegistry::itemTypes() const
83{
84 QMap<QString, QString> types;
85 for ( auto it = mMetadata.constBegin(); it != mMetadata.constEnd(); ++it )
86 {
87 types.insert( it.key(), it.value()->visibleName() );
88 }
89 return types;
90}
Stores metadata about one annotation item class.
QString type() const
Returns the unique item type string for the annotation item class.
QString visibleName() const
Returns a translated, user visible name for the annotation item class.
Convenience metadata class that uses static functions to create annotation items and their configurat...
QgsAnnotationItem * createItem(const QString &type) const
Creates a new instance of a annotation item given the item type.
QgsAnnotationItemAbstractMetadata * itemMetadata(const QString &type) const
Returns the metadata for the specified item type.
void typeAdded(const QString &type, const QString &name)
Emitted whenever a new item type is added to the registry, with the specified type and visible name.
bool populate()
Populates the registry with standard item types.
QgsAnnotationItemRegistry(QObject *parent=nullptr)
Creates a new empty item registry.
QMap< QString, QString > itemTypes() const
Returns a map of available item types to translated name.
bool addItemType(QgsAnnotationItemAbstractMetadata *metadata)
Registers a new annotation item type.
Abstract base class for annotation items which are drawn with QgsAnnotationLayers.
static QgsAnnotationLineItem * create()
Creates a new linestring annotation item.
static QgsAnnotationLineTextItem * create()
Creates a new linestring annotation item.
static QgsAnnotationMarkerItem * create()
Creates a new marker annotation item.
static QgsAnnotationPictureItem * create()
Creates a new polygon annotation item.
static QgsAnnotationPointTextItem * create()
Creates a new text at point annotation item.
static QgsAnnotationPolygonItem * create()
Creates a new polygon annotation item.
static QgsAnnotationRectangleTextItem * create()
Creates a new rectangle text annotation item.