Added deprecation note for QgsLabel::layerAttributes and suggest usin…

…g QgsLabel::labelAttributes rather git-svn-id: http://svn.osgeo.org/qgis/trunk@11873 c8812cc2-4d05-0410-92ff-de0c093fc19c
qgis · Oct 31, 2009 · 5dca02a · 5dca02a
1 parent 68f0ad0
commit 5dca02a
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 3 deletions.
diff --git a/python/core/qgslabel.sip b/python/core/qgslabel.sip
@@ -81,8 +81,17 @@ public:
     //! Available vector fields
     QMap<int, QgsField> & fields ( );
 
-    //! Pointer to default attributes
-    QgsLabelAttributes *layerAttributes ( );
+    /** Pointer to default attributes.
+     * @note this will be deprecated in version 2 as it is 
+     * badly named. Rather use attributes.
+     * @see labelAttributes method rather */
+    QgsLabelAttributes *layerAttributes( void );
+
+    /** Pointer to default attributes.
+     * @note this replaces the to-be-deprecated layerAttributes method.
+     * @note introduced in QGIS 1.4
+     */
+    QgsLabelAttributes *labelAttributes( void );
 
     //! Set label field
     void setLabelField ( int attr, int fieldId );

diff --git a/src/core/qgslabel.cpp b/src/core/qgslabel.cpp
@@ -508,6 +508,11 @@ QString QgsLabel::labelField( int attr ) const
   return mField[fieldIndex].name();
 }
 
+QgsLabelAttributes *QgsLabel::labelAttributes( void )
+{
+  return mLabelAttributes;
+}
+// @note this will be deprecated use attributes rather
 QgsLabelAttributes *QgsLabel::layerAttributes( void )
 {
   return mLabelAttributes;

diff --git a/src/core/qgslabel.h b/src/core/qgslabel.h
@@ -132,9 +132,18 @@ class CORE_EXPORT QgsLabel
     //! Available vector fields
     QgsFieldMap & fields( void );
 
-    //! Pointer to default attributes
+    /** Pointer to default attributes.
+     * @note this will be deprecated in version 2 as it is 
+     * badly named. Rather use attributes.
+     * @see labelAttributes method rather */
     QgsLabelAttributes *layerAttributes( void );
 
+    /** Pointer to default attributes.
+     * @note this replaces the to-be-deprecated layerAttributes method.
+     * @note introduced in QGIS 1.4
+     */
+    QgsLabelAttributes *labelAttributes( void );
+
     //! Set label field
     void setLabelField( int attr, int fieldIndex );