Skip to content

Commit 69d10fa

Browse files
committed
Update API break dox
1 parent 39b89d1 commit 69d10fa

1 file changed

Lines changed: 51 additions & 6 deletions

File tree

‎doc/api_break.dox‎

Lines changed: 51 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -596,6 +596,13 @@ QgsComposerNodesItem {#qgis_api_break_3_0_QgsComposerNodesItem}
596596
- _writeXMLStyle() has been renamed to _writeXMLStyle()
597597
- unselectNode() has been renamed to deselectNode() <!--#spellok-->
598598

599+
QgsComposerObject {#qgis_api_break_3_0_QgsComposerObject}
600+
-----------------
601+
602+
- dataDefinedProperty() and setDataDefinedProperty() no longer use QgsDataDefined objects.
603+
Instead these methods have been ported to the QgsProperty framework.
604+
- dataDefinedEvaluate() was removed. Use the QgsProperty evaluation methods instead.
605+
599606

600607
QgsComposerPicture {#qgis_api_break_3_0_QgsComposerPicture}
601608
------------------
@@ -640,6 +647,16 @@ QgsComposerTableV2 {#qgis_api_break_3_0_QgsComposerTableV2}
640647
- unselectNode() has been renamed to deselectNode() <!--#spellok-->
641648

642649

650+
QgsComposerUtils {#qgis_api_break_3_0_QgsComposerUtils}
651+
-----------------
652+
653+
- readDataDefinedPropertyMap() was renamed to readOldDataDefinedPropertyMap() and the signature has changed
654+
to use a QgsPropertyCollection object.
655+
- readDataDefinedProperty() was renamed to readOldDataDefinedProperty() and the signature has changed
656+
to use the QgsProperty framework objects.
657+
- writeDataDefinedPropertyMap() was removed. This is now handled by QgsPropertyCollection::writeXml()
658+
659+
643660
QgsComposition {#qgis_api_break_3_0_QgsComposition}
644661
--------------
645662

@@ -655,6 +672,8 @@ were removed. Use setSnapTolerance() and snapTolerance() instead.
655672
- addComposerTable(), composerTableAdded() were removed.
656673
- setAllUnselected() has been renamed to setAllDeselected. <!--#spellok-->
657674
- worldFileMap() and setWorldFileMap() have been renamed to referenceMap() and setReferenceMap()
675+
- dataDefinedProperty() and setDataDefinedProperty() now use the QgsProperty framework instead
676+
of QgsDataDefined objects.
658677

659678

660679
QgsCoordinateReferenceSystem {#qgis_api_break_3_0_QgsCoordinateReferenceSystem}
@@ -758,14 +777,19 @@ QgsDataDefinedButton {#qgis_api_break_3_0_QgsDataDefinedButton}
758777
- registerGetExpressionContextCallback has been removed in favor of registerExpressionContextGenerator
759778

760779

761-
762780
QgsDataDefinedSymbolDialog {#qgis_api_break_3_0_QgsDataDefinedSymbolDialog}
763781
--------------------------
764782

765783
- QgsDataDefinedSymbolDialog was removed. Code using this dialog should be reworked to use QgsDataDefinedButton
766784
instead.
767785

768786

787+
QgsDataDefinedValueDialog {#qgis_api_break_3_0_QgsDataDefinedValueDialog}
788+
--------------------------
789+
790+
- These classes and subclasses now use QgsProperty objects instead of QgsDataDefined.
791+
792+
769793
QgsDataItem {#qgis_api_break_3_0_QgsDataItem}
770794
-----------
771795

@@ -820,6 +844,7 @@ QgsDiagramRenderer {#qgis_api_break_3_0_QgsDiagramRenderer}
820844
------------------
821845
- xform, fields were no longer required and are removed.
822846
- referencedFields() no longer takes a QgsFields argument.
847+
- renderDiagram() now takes an optional data defined overrides collection argument.
823848

824849

825850
QgsDiagramLayerSettings {#qgis_api_break_3_0_QgsDiagramLayerSettings}
@@ -839,7 +864,8 @@ place of a null pointer.
839864
- The dist member variable was removed. setDistance() and distance() should be used instead.
840865
- The renderer member variable was removed, and getRenderer() was renamed to renderer()
841866
- The showAll member variable was removed. setShowAllDiagrams() and showAllDiagrams() should be used instead.
842-
- The xPosColumn, yPosColumn and showColumn attributes were removed. Use setProperties() for setting data defined properties instead.
867+
- The xPosColumn, yPosColumn and showColumn attributes were removed. Use setDataDefinedProperties() for
868+
setting data defined properties instead.
843869
- The LinePlacementFlags enum was renamed to LinePlacementFlag
844870
- The placement member variable was removed, and getPlacement() was renamed to placement()
845871
- The placementFlags member variable was removed
@@ -975,6 +1001,8 @@ QgsFeatureRendererV2 {#qgis_api_break_3_0_QgsFeatureRendererV2}
9751001
- symbolsForFeature( QgsFeature& feat ) has been removed. The symbolsForFeature( QgsFeature& feat, QgsRenderContext& context ) method should be used instead (previously available as symbolsForFeature2 in PyQGIS bindings).
9761002
- originalSymbolsForFeature( QgsFeature& feat ) has been removed. The originalSymbolsForFeature( QgsFeature& feat, QgsRenderContext& context ) method should be used instead (previously available as originalSymbolsForFeature2 in PyQGIS bindings).
9771003
- copyPaintEffect() was removed. copyRendererData() should be used instead.
1004+
- usedAttributes() now requires a QgsRenderContext argument.
1005+
9781006

9791007
QgsFeatureRequest {#qgis_api_break_3_0_QgsFeatureRequest}
9801008
-----------------
@@ -1424,6 +1452,13 @@ QgsPalLayerSettings {#qgis_api_break_3_0_QgsPalLayerSettings}
14241452
- ct is now a QgsCoordinateTransform object, not a pointer. An invalid QgsCoordinateTransform will
14251453
be used instead of a null pointer if no transformation is required.
14261454
- prepareGeometry() and geometryRequiresPreparation() now take a QgsCoordinateTransform reference, not a pointer. An invalid QgsCoordinateTransform should be used instead of a null pointer if no transformation is required.
1455+
- The DataDefinedProperties enum was renamed to Property
1456+
- dataDefinedProperty(), setDataDefinedProperty(), removeDataDefinedProperty(),
1457+
removeAllDataDefinedProperties(), updateDataDefinedString(), dataDefinedMap(),
1458+
dataDefinedValue(), dataDefinedEvaluate(), dataDefinedIsActive(),
1459+
dataDefinedUseExpression(), dataDefinedProperties() and dataDefinedNames()
1460+
members were removed. Use the QgsProperty framework through dataDefinedProperties()
1461+
and setDataDefinedProperties() instead.
14271462

14281463

14291464
QgsPanelWidgetStack {#qgis_api_break_3_0_QgsPanelWidgetStack}
@@ -1696,17 +1731,26 @@ parameters or QgsSymbol::OutputUnitList parameters now take QgsUnitTypes::Render
16961731
data defined rotation.
16971732
- setRenderHints() and renderHints() now accept and return a QgsSymbol::RenderHints flag rather
16981733
than an integer value
1734+
- usedAttributes() now requires a QgsRenderContext argument.
1735+
- setDataDefinedAngle(), dataDefinedAngle(), setDataDefinedSize(), dataDefinedSize(), setDataDefinedWidth() and dataDefinedWidth()
1736+
now work with QgsProperty objects instead of QgsDataDefined.
16991737

17001738

17011739
QgsSymbolLayer (renamed from QgsSymbolLayerV2) {#qgis_api_break_3_0_QgsSymbolLayer}
17021740
----------------------------------------------
17031741

17041742
- The deprecated prepareExpressions( const QgsFields* fields, double scale = -1.0 ) method has been removed. Use
17051743
the variant which takes QgsSymbolRenderContext instead.
1706-
- The deprecated methods dataDefinedProperty( const QString& property ) and dataDefinedPropertyString() were removed. Use getDataDefinedProperty() instead.
1707-
- setDataDefinedProperty( const QString& property, const QString& expressionString ) was removed. Use setDataDefinedProperty( const QString& property, QgsDataDefined* dataDefined ) instead.
1708-
- evaluateDataDefinedProperty( const QString& property, const QgsFeature* feature ) was removed. Use the variant which takes QgsSymbolRenderContext instead.
1709-
- expression() was removed. Use getDataDefinedProperty or evaluateDataDefinedProperty instead.
1744+
- The deprecated methods dataDefinedProperty( const QString& property ) and dataDefinedPropertyString() were removed. Use dataDefinedProperties() instead.
1745+
- setDataDefinedProperty now requires a QgsSymbolLayer.Property argument instead of the string based key.
1746+
- removeDataDefinedProperty(), removeDataDefinedProperties(), hasDataDefinedProperties(), hasDataDefinedProperty(), evaluateDataDefinedProperty()
1747+
were removed. Use the QgsProperty/QgsPropertyCollection methods instead.
1748+
- getDataDefinedProperty() was removed. Use dataDefinedProperties() instead.
1749+
- expression() was removed.
1750+
- usedAttributes() now requires a QgsRenderContext argument
1751+
- saveDataDefinedProperties() was removed. This is no longer required.
1752+
- restoreDataDefinedProperties() was renamed to restoreOldDataDefinedProperties()
1753+
17101754

17111755
QgsSymbolLayerRegistry {#qgis_api_break_3_0_QgsSymbolLayerRegistry}
17121756
----------------------
@@ -1747,6 +1791,7 @@ QgsSymbolSelectorWidget {#qgis_api_break_3_0_QgsSymbolSelectorWidget}
17471791
-----------------------
17481792

17491793
- saveSymbol() was removed.
1794+
- registerDataDefinedButton now works with QgsPropertyOverrideButton and QgsProperty keys
17501795

17511796

17521797
QgsSymbolSelectorDialog {#qgis_api_break_3_0_QgsSymbolSelectorDialog}

0 commit comments

Comments
 (0)