QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
numericformats
qgsbearingnumericformat.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsbearingnumericformat.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 QGSBEARINGNUMERICFORMAT_H
16
#define QGSBEARINGNUMERICFORMAT_H
17
18
#include "qgis_core.h"
19
#include "
qgis_sip.h
"
20
#include "
qgsbasicnumericformat.h
"
21
28
class
CORE_EXPORT
QgsBearingNumericFormat
:
public
QgsBasicNumericFormat
29
{
30
public
:
35
enum
FormatDirectionOption
36
{
37
UseRange0To180WithEWDirectionalSuffix
= 0,
38
UseRangeNegative180ToPositive180
,
39
UseRange0To360
,
40
};
41
45
QgsBearingNumericFormat
();
46
47
QString
id
()
const override
;
48
QString
visibleName
()
const override
;
49
int
sortKey
()
override
;
50
double
suggestSampleValue
()
const override
;
51
QString
formatDouble
(
double
value,
const
QgsNumericFormatContext
&context )
const override
;
52
QgsBearingNumericFormat
*
clone
() const override
SIP_FACTORY
;
53
QgsNumericFormat
*create( const QVariantMap &configuration, const
QgsReadWriteContext
&context ) const override
SIP_FACTORY
;
54
QVariantMap configuration( const
QgsReadWriteContext
&context ) const override;
55
62
FormatDirectionOption directionFormat() const;
63
70
void
setDirectionFormat( FormatDirectionOption format );
71
72
void
setConfiguration( const QVariantMap &configuration, const
QgsReadWriteContext
&context ) override;
73
74
private:
75
FormatDirectionOption mDirectionFormat = UseRange0To180WithEWDirectionalSuffix;
76
};
77
78
#endif
// QGSBEARINGNUMERICFORMAT_H
QgsBasicNumericFormat::QgsBasicNumericFormat
QgsBasicNumericFormat()
Default constructor.
Definition
qgsbasicnumericformat.cpp:49
QgsBasicNumericFormat::id
QString id() const override
Returns a unique id for this numeric format.
Definition
qgsbasicnumericformat.cpp:52
QgsBasicNumericFormat::visibleName
QString visibleName() const override
Returns the translated, user-visible name for this format.
Definition
qgsbasicnumericformat.cpp:57
QgsBasicNumericFormat::sortKey
int sortKey() override
Returns a sorting key value, where formats with a lower sort key will be shown earlier in lists.
Definition
qgsbasicnumericformat.cpp:62
QgsBasicNumericFormat::clone
QgsNumericFormat * clone() const override
Clones the format, returning a new object.
Definition
qgsbasicnumericformat.cpp:144
QgsBasicNumericFormat::formatDouble
QString formatDouble(double value, const QgsNumericFormatContext &context) const override
Returns a formatted string representation of a numeric double value.
Definition
qgsbasicnumericformat.cpp:67
QgsBearingNumericFormat
A numeric formatter which returns a text representation of a direction/bearing.
Definition
qgsbearingnumericformat.h:29
QgsBearingNumericFormat::QgsBearingNumericFormat
QgsBearingNumericFormat()
Default constructor.
Definition
qgsbearingnumericformat.cpp:25
QgsBearingNumericFormat::FormatDirectionOption
FormatDirectionOption
Directional formatting option, which controls how bearing direction is described in the returned stri...
Definition
qgsbearingnumericformat.h:36
QgsBearingNumericFormat::UseRange0To180WithEWDirectionalSuffix
@ UseRange0To180WithEWDirectionalSuffix
Return values between 0 and 180, with a E or W directional suffix.
Definition
qgsbearingnumericformat.h:37
QgsBearingNumericFormat::UseRange0To360
@ UseRange0To360
Return values between 0 to 360.
Definition
qgsbearingnumericformat.h:39
QgsBearingNumericFormat::UseRangeNegative180ToPositive180
@ UseRangeNegative180ToPositive180
Return values between -180 and 180.
Definition
qgsbearingnumericformat.h:38
QgsNumericFormatContext
A context for numeric formats.
Definition
qgsnumericformat.h:35
QgsNumericFormat
Abstract base class for numeric formatters, which allow for formatting a numeric value for display.
Definition
qgsnumericformat.h:232
QgsNumericFormat::suggestSampleValue
virtual double suggestSampleValue() const
Returns a suggested sample value which nicely represents the current format configuration.
Definition
qgsnumericformat.cpp:59
QgsReadWriteContext
A container for the context for various read/write operations on objects.
Definition
qgsreadwritecontext.h:38
qgis_sip.h
SIP_FACTORY
#define SIP_FACTORY
Definition
qgis_sip.h:83
qgsbasicnumericformat.h
Generated on
for QGIS API Documentation by
1.17.0