QGIS API Documentation  2.6.0-Brighton
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
qgslabel.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslabel.h - render vector labels
3  -------------------
4  begin : August 2004
5  copyright : (C) 2004 by Radim Blazek
6  email : blazek@itc.it
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 #ifndef QGSLABEL_H
17 #define QGSLABEL_H
18 
19 #include <vector>
20 
21 #include <QColor>
22 #include <QList>
23 #include <QMap>
24 
25 #include "qgspoint.h"
26 
27 class QDomNode;
28 class QDomDocument;
29 class QDomElement;
30 class QString;
31 class QPainter;
32 class QPaintDevice;
33 
34 class QgsFeature;
35 class QgsField;
37 
38 #include "qgsfield.h"
39 #include "qgsrectangle.h"
40 #include "qgsrendercontext.h"
41 
42 typedef QList<int> QgsAttributeList;
43 
44 class QgsFields;
45 
51 class CORE_EXPORT QgsLabel
52 {
53  public:
54  QgsLabel( const QgsFields & fields );
55 
56  ~QgsLabel();
57 
58  /* Fields */
60  {
61  Text = 0,
84  LabelFieldCount
85  };
86 
87  struct labelpoint
88  {
90  double angle;
91  };
92 
99  void renderLabel( QgsRenderContext &renderContext, QgsFeature &feature, bool selected, QgsLabelAttributes *classAttributes = 0 );
100 
104  void readXML( const QDomNode& node );
105 
107  void writeXML( QDomNode & label_node, QDomDocument & document ) const;
108 
110  void addRequiredFields( QgsAttributeList& fields ) const;
111 
113  void setFields( const QgsFields & fields );
114 
116  QgsFields & fields();
117 
122  QgsLabelAttributes *labelAttributes();
123 
125  void setLabelField( int attr, int fieldIndex );
126 
128  QString labelField( int attr ) const;
129 
135  QString fieldValue( int attr, QgsFeature& feature );
136 
138  void setMinScale( float theMinScale );
139  float minScale() const;
140 
142  void setMaxScale( float theMaxScale );
143  float maxScale() const;
144 
146  void setScaleBasedVisibility( bool theVisibilityFlag );
147  bool scaleBasedVisibility() const;
148 
149  private:
153  void renderLabel( QgsRenderContext &renderContext, QgsPoint point,
154  QString text, QFont font, QPen pen,
155  int dx, int dy,
156  double xoffset, double yoffset,
157  double ang,
158  int width, int height, int alignment );
159 
160  bool readLabelField( QDomElement &el, int attr, QString prefix );
161 
163  void labelPoint( std::vector<labelpoint>&, QgsFeature &feature );
164 
166  const unsigned char* labelPoint( labelpoint& point, const unsigned char* wkb, size_t wkblen );
167 
169  QColor mSelectionColor;
170 
172  QgsLabelAttributes *mLabelAttributes;
173 
175  QgsFields mFields;
176 
178  std::vector<QString> mLabelField;
179 
181  std::vector<int> mLabelFieldIdx;
182 
184  float mMinScale;
186  float mMaxScale;
188  bool mScaleBasedVisibility;
189 };
190 
191 #endif