Skip to content

Commit a5f0de9

Browse files
ccrookccrook
committedSep 30, 2014
API fixes to use Legend instead of Label where it makes more sense
·
ltr-3_40archive/master_2
1 parent 21ddf12 commit a5f0de9

File tree

6 files changed

+65
-62
lines changed

6 files changed

+65
-62
lines changed
 

‎python/core/symbology-ng/qgsgraduatedsymbolrendererv2.sip

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,19 @@ class QgsRendererRangeV2
3939

4040
typedef QList<QgsRendererRangeV2> QgsRangeList;
4141

42-
class QgsRendererRangeV2LabelFormat
42+
43+
// @note added in 2.6
44+
class QgsRendererRangeV2LegendFormat
4345
{
4446
%TypeHeaderCode
4547
#include <qgsgraduatedsymbolrendererv2.h>
4648
%End
4749
public:
48-
QgsRendererRangeV2LabelFormat();
49-
QgsRendererRangeV2LabelFormat( QString format, int decimalPlaces=4, bool trimTrailingZeroes=false );
50+
QgsRendererRangeV2LegendFormat();
51+
QgsRendererRangeV2LegendFormat( QString format, int precision = 4, bool trimTrailingZeroes = false );
5052

51-
bool operator==( const QgsRendererRangeV2LabelFormat & other ) const;
52-
bool operator!=( const QgsRendererRangeV2LabelFormat & other ) const;
53+
bool operator==( const QgsRendererRangeV2LegendFormat & other ) const;
54+
bool operator!=( const QgsRendererRangeV2LegendFormat & other ) const;
5355

5456
QString format() const;
5557
void setFormat( QString format );
@@ -61,8 +63,9 @@ class QgsRendererRangeV2LabelFormat
6163
void setTrimTrailingZeroes( bool trimTrailingZeroes );
6264

6365
//! @note labelForLowerUpper in python bindings
64-
QString labelForRange( double lower, double upper ) /PyName=labelForLowerUpper/;
65-
QString labelForRange( const QgsRendererRangeV2 &range );
66+
QString legendForRange( double lower, double upper ) const;
67+
QString legendForRange( const QgsRendererRangeV2 &range ) const;
68+
QString formatNumber( double value ) const;
6669

6770
void setFromDomElement( QDomElement &element );
6871
void saveToDomElement( QDomElement &element );
@@ -153,17 +156,17 @@ class QgsGraduatedSymbolRendererV2 : QgsFeatureRendererV2
153156

154157
//! Return the label format used to generate default classification labels
155158
//! @note Added in 2.6
156-
const QgsRendererRangeV2LabelFormat &labelFormat();
159+
const QgsRendererRangeV2LegendFormat &legendFormat() const;
157160
//! Set the label format used to generate default classification labels
158161
//! @param labelFormat The string appended to classification labels
159162
//! @param updateRanges If true then ranges ending with the old unit string are updated to the new.
160163
//! @note Added in 2.6
161-
void setLabelFormat( const QgsRendererRangeV2LabelFormat &labelFormat, bool updateRanges=true );
164+
void setLegendFormat( const QgsRendererRangeV2LegendFormat &legendFormat, bool updateRanges = true );
162165

163166
//! Reset the label decimal places to a numberbased on the minimum class interval
164167
//! @param updateRanges if true then ranges currently using the default label will be updated
165168
//! @note Added in 2.6
166-
void calculateLabelDecimalPlaces( bool updateRanges=true );
169+
void calculateLabelPrecision( bool updateRanges = true );
167170

168171
static QgsGraduatedSymbolRendererV2* createRenderer(
169172
QgsVectorLayer* vlayer,
@@ -173,7 +176,7 @@ class QgsGraduatedSymbolRendererV2 : QgsFeatureRendererV2
173176
QgsSymbolV2* symbol /Transfer/,
174177
QgsVectorColorRampV2* ramp /Transfer/,
175178
bool inverted = false,
176-
QgsRendererRangeV2LabelFormat labelFormat=QgsRendererRangeV2LabelFormat()
179+
QgsRendererRangeV2LegendFormat labelFormat=QgsRendererRangeV2LegendFormat()
177180
);
178181

179182
//! create renderer from XML element

‎src/core/symbology-ng/qgsgraduatedsymbolrendererv2.cpp

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -169,10 +169,10 @@ void QgsRendererRangeV2::toSld( QDomDocument &doc, QDomElement &element, QgsStri
169169

170170
///////////
171171

172-
int QgsRendererRangeV2LabelFormat::MaxPrecision=15;
173-
int QgsRendererRangeV2LabelFormat::MinPrecision=-6;
172+
int QgsRendererRangeV2LegendFormat::MaxPrecision=15;
173+
int QgsRendererRangeV2LegendFormat::MinPrecision=-6;
174174

175-
QgsRendererRangeV2LabelFormat::QgsRendererRangeV2LabelFormat():
175+
QgsRendererRangeV2LegendFormat::QgsRendererRangeV2LegendFormat():
176176
mFormat( " %1 - %2 " ),
177177
mPrecision( 4 ),
178178
mTrimTrailingZeroes( false ),
@@ -182,7 +182,7 @@ QgsRendererRangeV2LabelFormat::QgsRendererRangeV2LabelFormat():
182182
{
183183
}
184184

185-
QgsRendererRangeV2LabelFormat::QgsRendererRangeV2LabelFormat( QString format, int precision, bool trimTrailingZeroes ):
185+
QgsRendererRangeV2LegendFormat::QgsRendererRangeV2LegendFormat( QString format, int precision, bool trimTrailingZeroes ):
186186
mReTrailingZeroes( "[.,]?0*$" )
187187
{
188188
setFormat( format );
@@ -191,20 +191,20 @@ QgsRendererRangeV2LabelFormat::QgsRendererRangeV2LabelFormat( QString format, in
191191
}
192192

193193

194-
bool QgsRendererRangeV2LabelFormat::operator==( const QgsRendererRangeV2LabelFormat &other ) const
194+
bool QgsRendererRangeV2LegendFormat::operator==( const QgsRendererRangeV2LegendFormat &other ) const
195195
{
196196
return
197197
format() == other.format() &&
198198
precision() == other.precision() &&
199199
trimTrailingZeroes() == other.trimTrailingZeroes();
200200
}
201201

202-
bool QgsRendererRangeV2LabelFormat::operator!=( const QgsRendererRangeV2LabelFormat &other ) const
202+
bool QgsRendererRangeV2LegendFormat::operator!=( const QgsRendererRangeV2LegendFormat &other ) const
203203
{
204204
return !( *this == other );
205205
}
206206

207-
void QgsRendererRangeV2LabelFormat::setPrecision( int precision )
207+
void QgsRendererRangeV2LegendFormat::setPrecision( int precision )
208208
{
209209
// Limit the range of decimal places to a reasonable range
210210
if ( precision < MinPrecision ) precision = MinPrecision;
@@ -220,12 +220,12 @@ void QgsRendererRangeV2LabelFormat::setPrecision( int precision )
220220
}
221221
}
222222

223-
QString QgsRendererRangeV2LabelFormat::labelForRange( const QgsRendererRangeV2 &range ) const
223+
QString QgsRendererRangeV2LegendFormat::legendForRange( const QgsRendererRangeV2 &range ) const
224224
{
225-
return labelForRange( range.lowerValue(), range.upperValue() );
225+
return legendForRange( range.lowerValue(), range.upperValue() );
226226
}
227227

228-
QString QgsRendererRangeV2LabelFormat::formatNumber( double value ) const
228+
QString QgsRendererRangeV2LegendFormat::formatNumber( double value ) const
229229
{
230230
if( mPrecision > 0 )
231231
{
@@ -241,7 +241,7 @@ QString QgsRendererRangeV2LabelFormat::formatNumber( double value ) const
241241
}
242242
}
243243

244-
QString QgsRendererRangeV2LabelFormat::labelForRange( double lower, double upper ) const
244+
QString QgsRendererRangeV2LegendFormat::legendForRange( double lower, double upper ) const
245245
{
246246
QString lowerStr=formatNumber(lower);
247247
QString upperStr=formatNumber(upper);
@@ -250,7 +250,7 @@ QString QgsRendererRangeV2LabelFormat::labelForRange( double lower, double upper
250250
return legend.replace( "%1",lowerStr).replace("%2",upperStr );
251251
}
252252

253-
void QgsRendererRangeV2LabelFormat::setFromDomElement( QDomElement &element )
253+
void QgsRendererRangeV2LegendFormat::setFromDomElement( QDomElement &element )
254254
{
255255
mFormat = element.attribute( "format",
256256
element.attribute( "prefix", " " ) + "%1" +
@@ -261,7 +261,7 @@ void QgsRendererRangeV2LabelFormat::setFromDomElement( QDomElement &element )
261261
mTrimTrailingZeroes = element.attribute( "trimtrailingzeroes", "false" ) == "true";
262262
}
263263

264-
void QgsRendererRangeV2LabelFormat::saveToDomElement( QDomElement &element )
264+
void QgsRendererRangeV2LegendFormat::saveToDomElement( QDomElement &element )
265265
{
266266
element.setAttribute( "format", mFormat );
267267
element.setAttribute( "decimalplaces", mPrecision );
@@ -450,9 +450,9 @@ bool QgsGraduatedSymbolRendererV2::updateRangeUpperValue( int rangeIndex, double
450450
if ( rangeIndex < 0 || rangeIndex >= mRanges.size() )
451451
return false;
452452
QgsRendererRangeV2 &range = mRanges[rangeIndex];
453-
bool isDefaultLabel = range.label() == mLabelFormat.labelForRange( range );
453+
bool isDefaultLabel = range.label() == mLabelFormat.legendForRange( range );
454454
range.setUpperValue( value );
455-
if ( isDefaultLabel ) range.setLabel( mLabelFormat.labelForRange( range ) );
455+
if ( isDefaultLabel ) range.setLabel( mLabelFormat.legendForRange( range ) );
456456
return true;
457457
}
458458

@@ -461,9 +461,9 @@ bool QgsGraduatedSymbolRendererV2::updateRangeLowerValue( int rangeIndex, double
461461
if ( rangeIndex < 0 || rangeIndex >= mRanges.size() )
462462
return false;
463463
QgsRendererRangeV2 &range = mRanges[rangeIndex];
464-
bool isDefaultLabel = range.label() == mLabelFormat.labelForRange( range );
464+
bool isDefaultLabel = range.label() == mLabelFormat.legendForRange( range );
465465
range.setLowerValue( value );
466-
if ( isDefaultLabel ) range.setLabel( mLabelFormat.labelForRange( range ) );
466+
if ( isDefaultLabel ) range.setLabel( mLabelFormat.legendForRange( range ) );
467467
return true;
468468
}
469469

@@ -498,7 +498,7 @@ QgsFeatureRendererV2* QgsGraduatedSymbolRendererV2::clone() const
498498
r->setRotationField( rotationField() );
499499
r->setSizeScaleField( sizeScaleField() );
500500
r->setScaleMethod( scaleMethod() );
501-
r->setLabelFormat( labelFormat() );
501+
r->setLegendFormat( legendFormat() );
502502
return r;
503503
}
504504

@@ -926,7 +926,7 @@ QgsGraduatedSymbolRendererV2* QgsGraduatedSymbolRendererV2::createRenderer(
926926
QgsSymbolV2* symbol,
927927
QgsVectorColorRampV2* ramp,
928928
bool inverted,
929-
QgsRendererRangeV2LabelFormat labelFormat
929+
QgsRendererRangeV2LegendFormat labelFormat
930930
)
931931
{
932932
QgsRangeList ranges;
@@ -935,7 +935,7 @@ QgsGraduatedSymbolRendererV2* QgsGraduatedSymbolRendererV2::createRenderer(
935935
r->setSourceColorRamp( ramp->clone() );
936936
r->setInvertedColorRamp( inverted );
937937
r->setMode( mode );
938-
r->setLabelFormat( labelFormat, false );
938+
r->setLegendFormat( labelFormat, false );
939939
r->updateClasses( vlayer, mode, classes );
940940
return r;
941941
}
@@ -1076,7 +1076,7 @@ void QgsGraduatedSymbolRendererV2::updateClasses( QgsVectorLayer *vlayer, Mode m
10761076
}
10771077
else
10781078
{
1079-
label = mLabelFormat.labelForRange( lower, upper );
1079+
label = mLabelFormat.legendForRange( lower, upper );
10801080
}
10811081
QgsSymbolV2* newSymbol = mSourceSymbol->clone();
10821082
addClass( QgsRendererRangeV2( lower, upper, newSymbol, label ) );
@@ -1176,9 +1176,9 @@ QgsFeatureRendererV2* QgsGraduatedSymbolRendererV2::create( QDomElement& element
11761176
QDomElement labelFormatElem = element.firstChildElement( "labelformat" );
11771177
if ( ! labelFormatElem.isNull() )
11781178
{
1179-
QgsRendererRangeV2LabelFormat labelFormat;
1179+
QgsRendererRangeV2LegendFormat labelFormat;
11801180
labelFormat.setFromDomElement( labelFormatElem );
1181-
r->setLabelFormat( labelFormat );
1181+
r->setLegendFormat( labelFormat );
11821182
}
11831183
// TODO: symbol levels
11841184
return r;
@@ -1422,7 +1422,7 @@ void QgsGraduatedSymbolRendererV2::addClass( QgsSymbolV2* symbol )
14221422
void QgsGraduatedSymbolRendererV2::addClass( double lower, double upper )
14231423
{
14241424
QgsSymbolV2* newSymbol = mSourceSymbol->clone();
1425-
QString label = mLabelFormat.labelForRange( lower, upper );
1425+
QString label = mLabelFormat.legendForRange( lower, upper );
14261426
mRanges.append( QgsRendererRangeV2( lower, upper, newSymbol, label ) );
14271427
}
14281428

@@ -1441,20 +1441,20 @@ void QgsGraduatedSymbolRendererV2::deleteAllClasses()
14411441
mRanges.clear();
14421442
}
14431443

1444-
void QgsGraduatedSymbolRendererV2::setLabelFormat( const QgsRendererRangeV2LabelFormat &labelFormat, bool updateRanges )
1444+
void QgsGraduatedSymbolRendererV2::setLegendFormat( const QgsRendererRangeV2LegendFormat &labelFormat, bool updateRanges )
14451445
{
14461446
if ( updateRanges && labelFormat != mLabelFormat )
14471447
{
14481448
for ( QgsRangeList::iterator it = mRanges.begin(); it != mRanges.end(); ++it )
14491449
{
1450-
it->setLabel( labelFormat.labelForRange( *it ) );
1450+
it->setLabel( labelFormat.legendForRange( *it ) );
14511451
}
14521452
}
14531453
mLabelFormat = labelFormat;
14541454
}
14551455

14561456

1457-
void QgsGraduatedSymbolRendererV2::calculateLabelDecimalPlaces( bool updateRanges )
1457+
void QgsGraduatedSymbolRendererV2::calculateLabelPrecision( bool updateRanges )
14581458
{
14591459
// Find the minimum size of a class
14601460
double minClassRange = 0.0;
@@ -1477,7 +1477,7 @@ void QgsGraduatedSymbolRendererV2::calculateLabelDecimalPlaces( bool updateRange
14771477
nextDpMinRange *= 10.0;
14781478
}
14791479
mLabelFormat.setPrecision( ndp );
1480-
if ( updateRanges ) setLabelFormat( mLabelFormat, true );
1480+
if ( updateRanges ) setLegendFormat( mLabelFormat, true );
14811481
}
14821482

14831483
void QgsGraduatedSymbolRendererV2::moveClass( int from, int to )

‎src/core/symbology-ng/qgsgraduatedsymbolrendererv2.h

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -67,14 +67,14 @@ typedef QList<QgsRendererRangeV2> QgsRangeList;
6767

6868

6969
// @note added in 2.6
70-
class CORE_EXPORT QgsRendererRangeV2LabelFormat
70+
class CORE_EXPORT QgsRendererRangeV2LegendFormat
7171
{
7272
public:
73-
QgsRendererRangeV2LabelFormat();
74-
QgsRendererRangeV2LabelFormat( QString format, int precision = 4, bool trimTrailingZeroes = false );
73+
QgsRendererRangeV2LegendFormat();
74+
QgsRendererRangeV2LegendFormat( QString format, int precision = 4, bool trimTrailingZeroes = false );
7575

76-
bool operator==( const QgsRendererRangeV2LabelFormat & other ) const;
77-
bool operator!=( const QgsRendererRangeV2LabelFormat & other ) const;
76+
bool operator==( const QgsRendererRangeV2LegendFormat & other ) const;
77+
bool operator!=( const QgsRendererRangeV2LegendFormat & other ) const;
7878

7979
QString format() const { return mFormat; }
8080
void setFormat( QString format ) { mFormat = format; }
@@ -86,8 +86,8 @@ class CORE_EXPORT QgsRendererRangeV2LabelFormat
8686
void setTrimTrailingZeroes( bool trimTrailingZeroes ) { mTrimTrailingZeroes = trimTrailingZeroes; }
8787

8888
//! @note labelForLowerUpper in python bindings
89-
QString labelForRange( double lower, double upper ) const;
90-
QString labelForRange( const QgsRendererRangeV2 &range ) const;
89+
QString legendForRange( double lower, double upper ) const;
90+
QString legendForRange( const QgsRendererRangeV2 &range ) const;
9191
QString formatNumber( double value ) const;
9292

9393
void setFromDomElement( QDomElement &element );
@@ -190,17 +190,17 @@ class CORE_EXPORT QgsGraduatedSymbolRendererV2 : public QgsFeatureRendererV2
190190

191191
//! Return the label format used to generate default classification labels
192192
//! @note Added in 2.6
193-
const QgsRendererRangeV2LabelFormat &labelFormat() const { return mLabelFormat; }
193+
const QgsRendererRangeV2LegendFormat &legendFormat() const { return mLabelFormat; }
194194
//! Set the label format used to generate default classification labels
195195
//! @param labelFormat The string appended to classification labels
196196
//! @param updateRanges If true then ranges ending with the old unit string are updated to the new.
197197
//! @note Added in 2.6
198-
void setLabelFormat( const QgsRendererRangeV2LabelFormat &labelFormat, bool updateRanges = true );
198+
void setLegendFormat( const QgsRendererRangeV2LegendFormat &legendFormat, bool updateRanges = true );
199199

200200
//! Reset the label decimal places to a numberbased on the minimum class interval
201201
//! @param updateRanges if true then ranges currently using the default label will be updated
202202
//! @note Added in 2.6
203-
void calculateLabelDecimalPlaces( bool updateRanges = true );
203+
void calculateLabelPrecision( bool updateRanges = true );
204204

205205
static QgsGraduatedSymbolRendererV2* createRenderer(
206206
QgsVectorLayer* vlayer,
@@ -210,7 +210,7 @@ class CORE_EXPORT QgsGraduatedSymbolRendererV2 : public QgsFeatureRendererV2
210210
QgsSymbolV2* symbol,
211211
QgsVectorColorRampV2* ramp,
212212
bool inverted = false,
213-
QgsRendererRangeV2LabelFormat labelFormat = QgsRendererRangeV2LabelFormat()
213+
QgsRendererRangeV2LegendFormat legendFormat = QgsRendererRangeV2LegendFormat()
214214
);
215215

216216
//! create renderer from XML element
@@ -287,7 +287,7 @@ class CORE_EXPORT QgsGraduatedSymbolRendererV2 : public QgsFeatureRendererV2
287287
QScopedPointer<QgsSymbolV2> mSourceSymbol;
288288
QScopedPointer<QgsVectorColorRampV2> mSourceColorRamp;
289289
bool mInvertedColorRamp;
290-
QgsRendererRangeV2LabelFormat mLabelFormat;
290+
QgsRendererRangeV2LegendFormat mLabelFormat;
291291
QScopedPointer<QgsExpression> mRotation;
292292
QScopedPointer<QgsExpression> mSizeScale;
293293
QgsSymbolV2::ScaleMethod mScaleMethod;

‎src/gui/symbology-ng/qgscategorizedsymbolrendererv2widget.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ QVariant QgsCategorizedSymbolRendererV2Model::headerData( int section, Qt::Orien
197197
{
198198
if ( orientation == Qt::Horizontal && role == Qt::DisplayRole && section >= 0 && section < 3 )
199199
{
200-
QStringList lst; lst << tr( "Symbol" ) << tr( "Value" ) << tr( "Label" );
200+
QStringList lst; lst << tr( "Symbol" ) << tr( "Value" ) << tr( "Legend" );
201201
return lst.value( section );
202202
}
203203
return QVariant();

0 commit comments

Comments
 (0)
Please sign in to comment.