Added deprecation note for QgsLabel::layerAttributes and suggest using QgsLabel::labelAttributes rather

timlinux · timlinux · commit 5ca66c8b75fb · 2009-10-31T22:03:48.000Z
git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@11873 c8812cc2-4d05-0410-92ff-de0c093fc19c
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 );
 

Original file line number	Diff line number	Diff line change
`@@ -508,6 +508,11 @@ QString QgsLabel::labelField( int attr ) const`
`508`	`508`	`return mField[fieldIndex].name();`
`509`	`509`	`}`
`510`	`510`
	`511`	`+QgsLabelAttributes *QgsLabel::labelAttributes( void )`
	`512`	`+{`
	`513`	`+ return mLabelAttributes;`
	`514`	`+}`
	`515`	`+// @note this will be deprecated use attributes rather`
`511`	`516`	`QgsLabelAttributes *QgsLabel::layerAttributes( void )`
`512`	`517`	`{`
`513`	`518`	`return mLabelAttributes;`