setAttributeAlias is now setFieldAlias

m-kuhn · m-kuhn · commit ff52a9f29bb3 · 2016-10-01T15:39:03.000+02:00
diff --git a/doc/api_break.dox b/doc/api_break.dox
@@ -1416,8 +1416,8 @@ displayExpression instead. For the map tip use mapTipTemplate() instead.</li>
 <li>editFormConfig() returns a copy instead of direct access (Use setEditFormConfig to update)
 <li>Removed valueRelation(), replaced with QgsEditFormConfig::editorWidgetConfig
 <li>Removed fieldNameIndex(), use fields().lookupField() or fields().indexFromName() instead
-<li>Renamed addAttributeAlias() to setAttributeAlias()
-<li>Renamed remAttributeAlias() to removeAttributeAlias()
+<li>Renamed addAttributeAlias() to setFieldAlias()
+<li>Renamed remAttributeAlias() to removeFieldAlias()
 </ul>
 
 \subsection qgis_api_break_3_0_QgsVectorLayerEditBuffer QgsVectorLayerEditBuffer
diff --git a/python/core/qgsvectorlayer.sip b/python/core/qgsvectorlayer.sip
@@ -1078,32 +1078,32 @@ class QgsVectorLayer : QgsMapLayer
      *
      * @note Added in QGIS 3.0
      */
-    void setAttributeAlias( int index, const QString& aliasString );
+    void setFieldAlias( int index, const QString& aliasString );
 
     /**
      * Removes an alias (a display name) for attributes to display in dialogs
      *
      * @note Added in QGIS 3.0
      */
-    void removeAttributeAlias( int index );
+    void removeFieldAlias( int index );
 
     /** Renames an attribute field  (but does not commit it).
      * @param attIndex attribute index
      * @param newName new name of field
      * @note added in QGIS 2.16
      */
-    bool renameAttribute( int attIndex, const QString& newName );
+    bool renameAttribute( int index, const QString& newName );
 
     /**
      * Returns the alias of an attribute name or a null string if there is no alias.
      *
      * @see {attributeDisplayName( int attributeIndex )} which returns the field name
      *      if no alias is defined.
      */
-    QString attributeAlias( int attributeIndex ) const;
+    QString attributeAlias( int index ) const;
 
     /** Convenience function that returns the attribute alias if defined or the field name else */
-    QString attributeDisplayName( int attributeIndex ) const;
+    QString attributeDisplayName( int index ) const;
 
     const QMap< QString, QString >& attributeAliases() const;
 
diff --git a/src/app/qgsfieldsproperties.cpp b/src/app/qgsfieldsproperties.cpp
@@ -765,11 +765,11 @@ void QgsFieldsProperties::attributesListCellChanged( int row, int column )
     {
       if ( !aliasItem->text().trimmed().isEmpty() )
       {
-        mLayer->setAttributeAlias( idx, aliasItem->text() );
+        mLayer->setFieldAlias( idx, aliasItem->text() );
       }
       else
       {
-        mLayer->removeAttributeAlias( idx );
+        mLayer->removeFieldAlias( idx );
       }
     }
   }
diff --git a/src/core/qgsvectorlayer.cpp b/src/core/qgsvectorlayer.cpp
@@ -2107,7 +2107,7 @@ bool QgsVectorLayer::addAttribute( const QgsField &field )
   return mEditBuffer->addAttribute( field );
 }
 
-void QgsVectorLayer::removeAttributeAlias( int attIndex )
+void QgsVectorLayer::removeFieldAlias( int attIndex )
 {
   if ( attIndex < 0 || attIndex >= fields().count() )
     return;
@@ -2123,15 +2123,15 @@ void QgsVectorLayer::removeAttributeAlias( int attIndex )
   }
 }
 
-bool QgsVectorLayer::renameAttribute( int attIndex, const QString& newName )
+bool QgsVectorLayer::renameAttribute( int index, const QString& newName )
 {
   if ( !mEditBuffer || !mDataProvider )
     return false;
 
-  return mEditBuffer->renameAttribute( attIndex, newName );
+  return mEditBuffer->renameAttribute( index, newName );
 }
 
-void QgsVectorLayer::setAttributeAlias( int attIndex, const QString& aliasString )
+void QgsVectorLayer::setFieldAlias( int attIndex, const QString& aliasString )
 {
   if ( attIndex < 0 || attIndex >= fields().count() )
     return;
@@ -2144,18 +2144,18 @@ void QgsVectorLayer::setAttributeAlias( int attIndex, const QString& aliasString
   emit layerModified(); // TODO[MD]: should have a different signal?
 }
 
-QString QgsVectorLayer::attributeAlias( int attributeIndex ) const
+QString QgsVectorLayer::attributeAlias( int index ) const
 {
-  if ( attributeIndex < 0 || attributeIndex >= fields().count() )
+  if ( index < 0 || index >= fields().count() )
     return QString();
 
-  return fields().at( attributeIndex ).alias();
+  return fields().at( index ).alias();
 }
 
-QString QgsVectorLayer::attributeDisplayName( int attributeIndex ) const
+QString QgsVectorLayer::attributeDisplayName( int index ) const
 {
-  if ( attributeIndex >= 0 && attributeIndex < mFields.count() )
-    return mFields.at( attributeIndex ).displayName();
+  if ( index >= 0 && index < mFields.count() )
+    return mFields.at( index ).displayName();
   else
     return QString();
 }
diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h
@@ -1202,32 +1202,32 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
      *
      * @note Added in QGIS 3.0
      */
-    void setAttributeAlias( int index, const QString& aliasString );
+    void setFieldAlias( int index, const QString& aliasString );
 
     /**
      * Removes an alias (a display name) for attributes to display in dialogs
      *
      * @note Added in QGIS 3.0
      */
-    void removeAttributeAlias( int index );
+    void removeFieldAlias( int index );
 
     /** Renames an attribute field  (but does not commit it).
-     * @param attIndex attribute index
+     * @param index attribute index
      * @param newName new name of field
      * @note added in QGIS 2.16
      */
-    bool renameAttribute( int attIndex, const QString& newName );
+    bool renameAttribute( int index, const QString& newName );
 
     /**
      * Returns the alias of an attribute name or a null string if there is no alias.
      *
      * @see {attributeDisplayName( int attributeIndex )} which returns the field name
      *      if no alias is defined.
      */
-    QString attributeAlias( int attributeIndex ) const;
+    QString attributeAlias( int index ) const;
 
     /** Convenience function that returns the attribute alias if defined or the field name else */
-    QString attributeDisplayName( int attributeIndex ) const;
+    QString attributeDisplayName( int index ) const;
 
     //! Returns a map of field name to attribute alias
     QgsStringMap attributeAliases() const;
diff --git a/tests/src/python/test_qgsvectorlayer.py b/tests/src/python/test_qgsvectorlayer.py
@@ -1615,27 +1615,27 @@ def testGetSetAliases(self):
         self.assertFalse(layer.attributeAlias(1))
         self.assertFalse(layer.attributeAlias(2))
 
-        layer.addAttributeAlias(0, "test")
+        layer.setFieldAlias(0, "test")
         self.assertEqual(layer.attributeAlias(0), "test")
         self.assertFalse(layer.attributeAlias(1))
         self.assertFalse(layer.attributeAlias(2))
         self.assertEqual(layer.fields().at(0).alias(), "test")
 
-        layer.addAttributeAlias(1, "test2")
+        layer.setFieldAlias(1, "test2")
         self.assertEqual(layer.attributeAlias(0), "test")
         self.assertEqual(layer.attributeAlias(1), "test2")
         self.assertFalse(layer.attributeAlias(2))
         self.assertEqual(layer.fields().at(0).alias(), "test")
         self.assertEqual(layer.fields().at(1).alias(), "test2")
 
-        layer.addAttributeAlias(1, None)
+        layer.setFieldAlias(1, None)
         self.assertEqual(layer.attributeAlias(0), "test")
         self.assertFalse(layer.attributeAlias(1))
         self.assertFalse(layer.attributeAlias(2))
         self.assertEqual(layer.fields().at(0).alias(), "test")
         self.assertFalse(layer.fields().at(1).alias())
 
-        layer.remAttributeAlias(0)
+        layer.removeFieldAlias(0)
         self.assertFalse(layer.attributeAlias(0))
         self.assertFalse(layer.attributeAlias(1))
         self.assertFalse(layer.attributeAlias(2))
@@ -1657,8 +1657,8 @@ def testSaveRestoreAliases(self):
         self.assertFalse(layer2.attributeAlias(1))
 
         # set some aliases
-        layer.addAttributeAlias(0, "test")
-        layer.addAttributeAlias(1, "test2")
+        layer.setFieldAlias(0, "test")
+        layer.setFieldAlias(1, "test2")
 
         doc = QDomDocument("testdoc")
         elem = doc.createElement("maplayer")

Original file line number	Diff line number	Diff line change
`@@ -765,11 +765,11 @@ void QgsFieldsProperties::attributesListCellChanged( int row, int column )`
`765`	`765`	`{`
`766`	`766`	`if ( !aliasItem->text().trimmed().isEmpty() )`
`767`	`767`	`{`
`768`		`- mLayer->setAttributeAlias( idx, aliasItem->text() );`
	`768`	`+ mLayer->setFieldAlias( idx, aliasItem->text() );`
`769`	`769`	`}`
`770`	`770`	`else`
`771`	`771`	`{`
`772`		`- mLayer->removeAttributeAlias( idx );`
	`772`	`+ mLayer->removeFieldAlias( idx );`
`773`	`773`	`}`
`774`	`774`	`}`
`775`	`775`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2107,7 +2107,7 @@ bool QgsVectorLayer::addAttribute( const QgsField &field )`
`2107`	`2107`	`return mEditBuffer->addAttribute( field );`
`2108`	`2108`	`}`
`2109`	`2109`
`2110`		`-void QgsVectorLayer::removeAttributeAlias( int attIndex )`
	`2110`	`+void QgsVectorLayer::removeFieldAlias( int attIndex )`
`2111`	`2111`	`{`
`2112`	`2112`	`if ( attIndex < 0 \|\| attIndex >= fields().count() )`
`2113`	`2113`	`return;`
`@@ -2123,15 +2123,15 @@ void QgsVectorLayer::removeAttributeAlias( int attIndex )`
`2123`	`2123`	`}`
`2124`	`2124`	`}`
`2125`	`2125`
`2126`		`-bool QgsVectorLayer::renameAttribute( int attIndex, const QString& newName )`
	`2126`	`+bool QgsVectorLayer::renameAttribute( int index, const QString& newName )`
`2127`	`2127`	`{`
`2128`	`2128`	`if ( !mEditBuffer \|\| !mDataProvider )`
`2129`	`2129`	`return false;`
`2130`	`2130`
`2131`		`- return mEditBuffer->renameAttribute( attIndex, newName );`
	`2131`	`+ return mEditBuffer->renameAttribute( index, newName );`
`2132`	`2132`	`}`
`2133`	`2133`
`2134`		`-void QgsVectorLayer::setAttributeAlias( int attIndex, const QString& aliasString )`
	`2134`	`+void QgsVectorLayer::setFieldAlias( int attIndex, const QString& aliasString )`
`2135`	`2135`	`{`
`2136`	`2136`	`if ( attIndex < 0 \|\| attIndex >= fields().count() )`
`2137`	`2137`	`return;`
`@@ -2144,18 +2144,18 @@ void QgsVectorLayer::setAttributeAlias( int attIndex, const QString& aliasString`
`2144`	`2144`	`emit layerModified(); // TODO[MD]: should have a different signal?`
`2145`	`2145`	`}`
`2146`	`2146`
`2147`		`-QString QgsVectorLayer::attributeAlias( int attributeIndex ) const`
	`2147`	`+QString QgsVectorLayer::attributeAlias( int index ) const`
`2148`	`2148`	`{`
`2149`		`- if ( attributeIndex < 0 \|\| attributeIndex >= fields().count() )`
	`2149`	`+ if ( index < 0 \|\| index >= fields().count() )`
`2150`	`2150`	`return QString();`
`2151`	`2151`
`2152`		`- return fields().at( attributeIndex ).alias();`
	`2152`	`+ return fields().at( index ).alias();`
`2153`	`2153`	`}`
`2154`	`2154`
`2155`		`-QString QgsVectorLayer::attributeDisplayName( int attributeIndex ) const`
	`2155`	`+QString QgsVectorLayer::attributeDisplayName( int index ) const`
`2156`	`2156`	`{`
`2157`		`- if ( attributeIndex >= 0 && attributeIndex < mFields.count() )`
`2158`		`- return mFields.at( attributeIndex ).displayName();`
	`2157`	`+ if ( index >= 0 && index < mFields.count() )`
	`2158`	`+ return mFields.at( index ).displayName();`
`2159`	`2159`	`else`
`2160`	`2160`	`return QString();`
`2161`	`2161`	`}`