Skip to content

Commit

Permalink
Change "added/deprecated in 2.1" notes to 2.4 for stuff related to th…
Browse files Browse the repository at this point in the history 
…reading
  • Loading branch information
@wonder-sk
wonder-sk committed Feb 21, 2014
1 parent bc07486 commit 5a4f8d0
Show file tree
Hide file tree
Showing 49 changed files with 182 additions and 182 deletions.
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposermap.sip
View file
Expand Up @@ -154,7 +154,7 @@ class QgsComposerMap : QgsComposerItem

QgsRectangle extent() const;

//! @deprecated since 2.1 - use mapSettings() - may return 0 if not initialized with QgsMapRenderer
//! @deprecated since 2.4 - use mapSettings() - may return 0 if not initialized with QgsMapRenderer
const QgsMapRenderer* mapRenderer() const /Deprecated/;

/**Sets offset values to shift image (useful for live updates when moving item content)*/
Expand Down
6 changes: 3 additions & 3 deletions python/core/composer/qgscomposition.sip
View file
Expand Up @@ -28,7 +28,7 @@ class QgsComposition : QGraphicsScene
Crosses
};

//! @deprecated since 2.1 - use the constructor with QgsMapSettings
//! @deprecated since 2.4 - use the constructor with QgsMapSettings
QgsComposition( QgsMapRenderer* mapRenderer ) /Deprecated/;
explicit QgsComposition( const QgsMapSettings& mapSettings );

Expand Down Expand Up @@ -204,11 +204,11 @@ class QgsComposition : QGraphicsScene
void setUseAdvancedEffects( bool effectsEnabled );

/**Returns pointer to map renderer of qgis map canvas*/
//! @deprecated since 2.1 - use mapSettings() instead. May return null if not initialized with QgsMapRenderer
//! @deprecated since 2.4 - use mapSettings() instead. May return null if not initialized with QgsMapRenderer
QgsMapRenderer* mapRenderer() /Deprecated/;

//! Return setting of QGIS map canvas
//! @note added in 2.1
//! @note added in 2.4
const QgsMapSettings& mapSettings() const;

QgsComposition::PlotStyle plotStyle() const;
Expand Down
2 changes: 1 addition & 1 deletion python/core/diagram/qgsdiagram.sip
View file
Expand Up @@ -6,7 +6,7 @@ class QgsDiagram
public:
virtual ~QgsDiagram();
/** Returns an instance that is equivalent to this one
* @note added in 2.1 */
* @note added in 2.4 */
virtual QgsDiagram* clone() const = 0;

void clearCache();
Expand Down
2 changes: 1 addition & 1 deletion python/core/qgsdiagramrendererv2.sip
View file
Expand Up @@ -124,7 +124,7 @@ class QgsDiagramRendererV2
virtual ~QgsDiagramRendererV2();

/** Returns new instance that is equivalent to this one
* @note added in 2.1 */
* @note added in 2.4 */
virtual QgsDiagramRendererV2* clone() const = 0;

/**Returns size of the diagram for a feature in map units. Returns an invalid QSizeF in case of error*/
Expand Down
2 changes: 1 addition & 1 deletion python/core/qgsfeaturerequest.sip
View file
Expand Up @@ -83,7 +83,7 @@ class QgsFeatureRequest


/** base class that can be used for any class that is capable of returning features
* @note added in 2.1
* @note added in 2.4
*/
class QgsAbstractFeatureSource
{
Expand Down
4 changes: 2 additions & 2 deletions python/core/qgsfield.sip
View file
Expand Up @@ -160,11 +160,11 @@ class QgsFields
//! Get field at particular index (must be in range 0..N-1)
//! Look up field's index from name - case insensitive
//! TODO: sort out case sensitive (indexFromName()) vs insensitive (fieldNameIndex()) calls
//! @note added in 2.1
//! @note added in 2.4
int fieldNameIndex( const QString& fieldName ) const;

//! Utility function to get list of attribute indexes
//! @note added in 2.1
//! @note added in 2.4
QgsAttributeList allAttributesList() const;

QgsField& operator[](int i) /Factory/;
Expand Down
18 changes: 9 additions & 9 deletions python/core/qgsmaplayer.sip
View file
Expand Up @@ -117,7 +117,7 @@ class QgsMapLayer : QObject
virtual void reload();

/** Return new instance of QgsMapLayerRenderer that will be used for rendering of given context
* @note added in 2.1
* @note added in 2.4
*/
virtual QgsMapLayerRenderer* createMapRenderer( QgsRenderContext& rendererContext ) /Factory/;

Expand Down Expand Up @@ -215,10 +215,10 @@ class QgsMapLayer : QObject
void removeCustomProperty( const QString& key );


//! @deprecated since 2.1 - returns empty string
//! @deprecated since 2.4 - returns empty string
virtual QString lastErrorTitle() /Deprecated/;

//! @deprecated since 2.1 - returns empty string
//! @deprecated since 2.4 - returns empty string
virtual QString lastError() /Deprecated/;

/** Get current status error. This error describes some principal problem
Expand Down Expand Up @@ -341,11 +341,11 @@ class QgsMapLayer : QObject
/** Return pointer to layer's undo stack */
QUndoStack *undoStack();

/** @deprecated since 2.1 - returns NULL */
/** @deprecated since 2.4 - returns NULL */
QImage *cacheImage() /Deprecated/;
/** @deprecated since 2.1 - does nothing */
/** @deprecated since 2.4 - does nothing */
void setCacheImage( QImage * thepImage /Transfer/ ) /Deprecated/;
/** @deprecated since 2.1 - does nothing */
/** @deprecated since 2.4 - does nothing */
virtual void onCacheImageDelete() /Deprecated/;

public slots:
Expand All @@ -365,7 +365,7 @@ class QgsMapLayer : QObject
void toggleScaleBasedVisibility( bool theVisibilityFlag );
bool hasScaleBasedVisibility() const;

/** @deprecated since 2.1 - does nothing */
/** @deprecated since 2.4 - does nothing */
void clearCacheImage() /Deprecated/;

/** \brief Obtain Metadata for this layer */
Expand All @@ -376,7 +376,7 @@ class QgsMapLayer : QObject

signals:

//! @deprecated in 2.1 - not emitted anymore
//! @deprecated in 2.4 - not emitted anymore
void drawingProgress( int theProgress, int theTotalSteps );

/** Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar) */
Expand All @@ -395,7 +395,7 @@ class QgsMapLayer : QObject
*/
void repaintRequested();

//! \note Deprecated in 2.1 and not emitted anymore
//! \note Deprecated in 2.4 and not emitted anymore
void screenUpdateRequested();

/** This is used to send a request that any mapcanvas using this layer update its extents */
Expand Down
2 changes: 1 addition & 1 deletion python/core/qgsmaplayerregistry.sip
View file
Expand Up @@ -127,7 +127,7 @@ class QgsMapLayerRegistry : QObject
*
* @note Added in QGIS 1.4
*/
//! @deprecated since 2.1 - does nothing
//! @deprecated since 2.4 - does nothing
void clearAllLayerCaches() /Deprecated/;

/**
Expand Down
12 changes: 6 additions & 6 deletions python/core/qgsmaprenderer.sip
View file
Expand Up @@ -36,7 +36,7 @@ class QgsLabelingEngineInterface
virtual ~QgsLabelingEngineInterface();

//! called when we're going to start with rendering
//! @deprecated since 2.1 - use override with QgsMapSettings
//! @deprecated since 2.4 - use override with QgsMapSettings
virtual void init( QgsMapRenderer* mp ) = 0 /Deprecated/;
//! called when we're going to start with rendering
virtual void init( const QgsMapSettings& mapSettings ) = 0;
Expand Down Expand Up @@ -66,11 +66,11 @@ class QgsLabelingEngineInterface
virtual void exit() = 0;
//! return infos about labels at a given (map) position
//! @note: this method was added in version 1.7
//! @deprecated since 2.1 - use takeResults() and methods of QgsLabelingResults
//! @deprecated since 2.4 - use takeResults() and methods of QgsLabelingResults
virtual QList<QgsLabelPosition> labelsAtPosition( const QgsPoint& p ) = 0 /Deprecated/;
//! return infos about labels within a given (map) rectangle
//! @note: this method was added in version 1.9
//! @deprecated since 2.1 - use takeResults() and methods of QgsLabelingResults
//! @deprecated since 2.4 - use takeResults() and methods of QgsLabelingResults
virtual QList<QgsLabelPosition> labelsWithinRect( const QgsRectangle& r ) = 0 /Deprecated/;

//! called when passing engine among map renderers
Expand Down Expand Up @@ -265,7 +265,7 @@ class QgsMapRenderer : QObject
static QgsMapRenderer::BlendMode getBlendModeEnum( const QPainter::CompositionMode blendMode );

//! bridge to QgsMapSettings
//! @note added in 2.1
//! @note added in 2.4
const QgsMapSettings& mapSettings();

void addLayerCoordinateTransform( const QString& layerId, const QString& srcAuthId, const QString& destAuthId, int srcDatumTransform = -1, int destDatumTransform = -1 );
Expand Down Expand Up @@ -293,12 +293,12 @@ class QgsMapRenderer : QObject
void datumTransformInfoRequested( const QgsMapLayer* ml, const QString& srcAuthId, const QString& destAuthId ) const;

//! emitted when the current extent gets changed
//! @note added in 2.1
//! @note added in 2.4
void extentsChanged();

public slots:

//! @deprecated in 2.1 - does nothing
//! @deprecated in 2.4 - does nothing
void onDrawingProgress( int current, int total ) /Deprecated/;

protected:
Expand Down
12 changes: 6 additions & 6 deletions python/core/qgspallabeling.sip
View file
Expand Up @@ -89,7 +89,7 @@ class QgsPalLayerSettings
QgsPalLayerSettings( const QgsPalLayerSettings& s );
~QgsPalLayerSettings();

//! @note added in 2.1
//! @note added in 2.4
static QgsPalLayerSettings fromLayer( QgsVectorLayer* layer );

enum Placement
Expand Down Expand Up @@ -582,7 +582,7 @@ class QgsLabelComponent

/**
* Class that stores computed placement from labeling engine.
* @note added in 2.1
* @note added in 2.4
*/
class QgsLabelingResults
{
Expand Down Expand Up @@ -645,7 +645,7 @@ class QgsPalLabeling : QgsLabelingEngineInterface
// implemented methods from labeling engine interface

//! called when we're going to start with rendering
//! @deprecated since 2.1 - use override with QgsMapSettings
//! @deprecated since 2.4 - use override with QgsMapSettings
virtual void init( QgsMapRenderer* mr ) /Deprecated/;
//! called when we're going to start with rendering
virtual void init( const QgsMapSettings& mapSettings );
Expand Down Expand Up @@ -674,7 +674,7 @@ class QgsPalLabeling : QgsLabelingEngineInterface
virtual QList<QgsLabelPosition> labelsWithinRect( const QgsRectangle& r ) /Deprecated/;

//! Return pointer to recently computed results (in drawLabeling()) and pass the ownership of results to the caller
//! @note added in 2.1
//! @note added in 2.4
QgsLabelingResults* takeResults() /TransferBack/;

//! called when passing engine among map renderers
Expand Down Expand Up @@ -703,8 +703,8 @@ class QgsPalLabeling : QgsLabelingEngineInterface
void loadEngineSettings();
void saveEngineSettings();
void clearEngineSettings();
//! @deprecated since 2.1 - settings are always stored in project
//! @deprecated since 2.4 - settings are always stored in project
bool isStoredWithProject() const /Deprecated/;
//! @deprecated since 2.1 - settings are always stored in project
//! @deprecated since 2.4 - settings are always stored in project
void setStoredWithProject( bool store ) /Deprecated/;
};
2 changes: 1 addition & 1 deletion python/core/qgspluginlayer.sip
View file
Expand Up @@ -25,7 +25,7 @@ class QgsPluginLayer : QgsMapLayer
* conditions that may happen (e.g. something is changed in the layer while it is
* being rendered).
*
* @note added in 2.1
* @note added in 2.4
*/
virtual QgsMapLayerRenderer* createMapRenderer( QgsRenderContext& rendererContext ) /Factory/;
};
2 changes: 1 addition & 1 deletion python/core/qgsrendercontext.sip
View file
Expand Up @@ -11,7 +11,7 @@ class QgsRenderContext
~QgsRenderContext();

//! create initialized QgsRenderContext instance from given QgsMapSettings
//! @note added in 2.1
//! @note added in 2.4
static QgsRenderContext fromMapSettings( const QgsMapSettings& mapSettings );

//getters
Expand Down
2 changes: 1 addition & 1 deletion python/core/qgssnapper.sip
View file
Expand Up @@ -69,7 +69,7 @@ class QgsSnapper
QgsTolerance::UnitType mUnitType;
};

//!@ deprecated since 2.1 - use constructor with QgsMapSettings
//!@ deprecated since 2.4 - use constructor with QgsMapSettings
QgsSnapper( QgsMapRenderer* mapRender ) /Deprecated/;

explicit QgsSnapper( const QgsMapSettings& mapSettings );
Expand Down
6 changes: 3 additions & 3 deletions python/core/qgstolerance.sip
View file
Expand Up @@ -27,7 +27,7 @@ class QgsTolerance
* The value is read from settings and transformed if necessary.
* @return value of vertex tolerance in map units
*/
//! @deprecated since 2.1 - use override with QgsMapSettings
//! @deprecated since 2.4 - use override with QgsMapSettings
static double vertexSearchRadius( QgsMapLayer* layer, QgsMapRenderer* renderer ) /Deprecated/;

/**
Expand All @@ -42,7 +42,7 @@ class QgsTolerance
* The value is read from settings and transformed if necessary.
* @return value of default tolerance in map units
*/
//! @deprecated since 2.1 - use override with QgsMapSettings
//! @deprecated since 2.4 - use override with QgsMapSettings
static double defaultTolerance( QgsMapLayer* layer, QgsMapRenderer* renderer ) /Deprecated/;

/**
Expand All @@ -63,6 +63,6 @@ class QgsTolerance
* @param units type of units to be translated
* @return value of tolerance in map units
*/
//! @deprecated since 2.1 - use the override with QgsMapSettings
//! @deprecated since 2.4 - use the override with QgsMapSettings
static double toleranceInMapUnits( double tolerance, QgsMapLayer* layer, QgsMapRenderer* renderer, UnitType units = MapUnits ) /Deprecated/;
};
2 changes: 1 addition & 1 deletion python/core/qgsvectordataprovider.sip
View file
Expand Up @@ -75,7 +75,7 @@ class QgsVectorDataProvider : QgsDataProvider
* if it is possible that both feature source and provider may need reading/writing to some shared data at the
* same time, some synchronization mechanisms must be used (e.g. mutexes) to prevent data corruption.
*
* @note added in 2.1
* @note added in 2.4
* @return new instance of QgsAbstractFeatureSource (caller is responsible for deleting it)
*/
virtual QgsAbstractFeatureSource* featureSource() const /Factory/;
Expand Down
2 changes: 1 addition & 1 deletion python/core/qgsvectorlayer.sip
View file
Expand Up @@ -672,7 +672,7 @@ class QgsVectorLayer : QgsMapLayer
virtual void reload();

/** Return new instance of QgsMapLayerRenderer that will be used for rendering of given context
* @note added in 2.1
* @note added in 2.4
*/
virtual QgsMapLayerRenderer* createMapRenderer( QgsRenderContext& rendererContext ) /Factory/;

Expand Down
8 changes: 4 additions & 4 deletions python/core/raster/qgsrasterlayer.sip
View file
Expand Up @@ -125,7 +125,7 @@ class QgsRasterLayer : QgsMapLayer
virtual void reload();

/** Return new instance of QgsMapLayerRenderer that will be used for rendering of given context
* @note added in 2.1
* @note added in 2.4
*/
virtual QgsMapLayerRenderer* createMapRenderer( QgsRenderContext& rendererContext ) /Factory/;

Expand All @@ -137,10 +137,10 @@ class QgsRasterLayer : QgsMapLayer
QgsRasterViewPort * myRasterViewPort,
const QgsMapToPixel* theQgsMapToPixel = 0 );

//! @deprecated since 2.1 - returns empty string
//! @deprecated since 2.4 - returns empty string
QString lastError() /Deprecated/;

//! @deprecated since 2.1 - returns empty string
//! @deprecated since 2.4 - returns empty string
QString lastErrorTitle() /Deprecated/;

/**Returns a list with classification items (Text and color)
Expand Down Expand Up @@ -213,7 +213,7 @@ class QgsRasterLayer : QgsMapLayer
public slots:
void showStatusMessage( const QString & theMessage );

//! @deprecated since 2.1 - does nothing
//! @deprecated since 2.4 - does nothing
void updateProgress( int, int ) /Deprecated/;

/** \brief receive progress signal from provider */
Expand Down
2 changes: 1 addition & 1 deletion python/core/symbology-ng/qgsrendererv2.sip
View file
Expand Up @@ -62,7 +62,7 @@ class QgsFeatureRendererV2

virtual void startRender( QgsRenderContext& context, const QgsFields& fields ) = 0;

//! @deprecated since 2.1 - not using QgsVectorLayer directly anymore
//! @deprecated since 2.4 - not using QgsVectorLayer directly anymore
virtual void startRender( QgsRenderContext& context, const QgsVectorLayer *vlayer ) /Deprecated/;

virtual void stopRender( QgsRenderContext& context ) = 0;
Expand Down
2 changes: 1 addition & 1 deletion python/core/symbology-ng/qgssymbolv2.sip
View file
Expand Up @@ -157,7 +157,7 @@ class QgsSymbolV2RenderContext
//! Fields of the layer. Currently only available in startRender() calls
//! to allow symbols with data-defined properties prepare the expressions
//! (other times fields() returns null)
//! @note added in 2.1
//! @note added in 2.4
const QgsFields* fields() const;

double outputLineWidth( double width ) const;
Expand Down

0 comments on commit 5a4f8d0

Please sign in to comment.