QGIS API Documentation
3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
src
core
numericformats
qgsnumericformatregistry.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsnumericformatregistry.h
3
--------------------------
4
begin : January 2020
5
copyright : (C) 2020 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
#ifndef QGSNUMERICFORMATREGISTRY_H
16
#define QGSNUMERICFORMATREGISTRY_H
17
18
#include "qgis_core.h"
19
#include "
qgis_sip.h
"
20
21
#include <QHash>
22
#include <QObject>
23
#include <QString>
24
25
class
QgsNumericFormat
;
26
class
QDomElement;
27
class
QgsReadWriteContext
;
28
38
class
CORE_EXPORT
QgsNumericFormatRegistry
39
{
40
41
public
:
42
48
explicit
QgsNumericFormatRegistry
();
49
~QgsNumericFormatRegistry
();
50
54
QStringList
formats
()
const
;
55
61
void
addFormat
(
QgsNumericFormat
*
format
SIP_TRANSFER
);
62
66
void
removeFormat
(
const
QString &
id
);
67
74
QgsNumericFormat
*
format
(
const
QString &
id
)
const
SIP_TRANSFERBACK
;
75
82
QgsNumericFormat
*
create
(
const
QString &
id
,
const
QVariantMap &configuration,
const
QgsReadWriteContext
&context )
const
SIP_TRANSFERBACK
;
83
90
QgsNumericFormat
*
createFromXml
(
const
QDomElement &element,
const
QgsReadWriteContext
&context )
const
SIP_TRANSFERBACK
;
91
98
QgsNumericFormat
*
fallbackFormat
()
const
SIP_FACTORY
;
99
103
QString
visibleName
(
const
QString &
id
)
const
;
104
108
int
sortKey
(
const
QString &
id
)
const
;
109
110
private
:
111
QHash<QString, QgsNumericFormat *> mFormats;
112
};
113
114
#endif
// QGSNUMERICFORMATREGISTRY_H
QgsNumericFormatRegistry::sortKey
int sortKey(const QString &id) const
Returns the sorting key for the format with matching id.
Definition
qgsnumericformatregistry.cpp:108
QgsNumericFormatRegistry::fallbackFormat
QgsNumericFormat * fallbackFormat() const
Returns a basic numeric formatter which can be used to represent any number in an default manner.
Definition
qgsnumericformatregistry.cpp:95
QgsNumericFormatRegistry::removeFormat
void removeFormat(const QString &id)
Removes the format with matching id from the registry.
Definition
qgsnumericformatregistry.cpp:60
QgsNumericFormatRegistry::visibleName
QString visibleName(const QString &id) const
Returns the translated, user-visible name for the format with matching id.
Definition
qgsnumericformatregistry.cpp:100
QgsNumericFormatRegistry::format
QgsNumericFormat * format(const QString &id) const
Creates a new numeric format by id.
Definition
qgsnumericformatregistry.cpp:68
QgsNumericFormatRegistry::formats
QStringList formats() const
Returns a list of the format IDs currently contained in the registry.
Definition
qgsnumericformatregistry.cpp:47
QgsNumericFormatRegistry::createFromXml
QgsNumericFormat * createFromXml(const QDomElement &element, const QgsReadWriteContext &context) const
Creates a new numeric format from an XML element.
Definition
qgsnumericformatregistry.cpp:84
QgsNumericFormatRegistry::QgsNumericFormatRegistry
QgsNumericFormatRegistry()
You should not normally need to create your own numeric format registry.
Definition
qgsnumericformatregistry.cpp:29
QgsNumericFormatRegistry::addFormat
void addFormat(QgsNumericFormat *format)
Adds a new format to the registry.
Definition
qgsnumericformatregistry.cpp:52
QgsNumericFormatRegistry::create
QgsNumericFormat * create(const QString &id, const QVariantMap &configuration, const QgsReadWriteContext &context) const
Creates a new numeric format by id, using the supplied configuration.
Definition
qgsnumericformatregistry.cpp:76
QgsNumericFormat
Abstract base class for numeric formatters, which allow for formatting a numeric value for display.
Definition
qgsnumericformat.h:279
QgsReadWriteContext
A container for the context for various read/write operations on objects.
Definition
qgsreadwritecontext.h:34
qgis_sip.h
SIP_TRANSFER
#define SIP_TRANSFER
Definition
qgis_sip.h:36
SIP_TRANSFERBACK
#define SIP_TRANSFERBACK
Definition
qgis_sip.h:48
SIP_FACTORY
#define SIP_FACTORY
Definition
qgis_sip.h:84
Generated on
for QGIS API Documentation by
1.15.0