mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-28 00:17:30 -05:00
9cc9d424ce
This check tests that if a function has been declared deprecated with either Q_DECL_DEPRECATED or has a @deprecated Doxygen note then it MUST have both the Q_DECL_DEPRECATD and @deprecated note. It's important that both are used, as Q_DECL_DEPRECATED allows throwing a warning if that method is used in code, while the @deprecated doxygen note gives an indication to devs/PyQGIS users of why it's deprecated and what should be used instead. Ideally we'd also test for SIP /Deprecated/ tags, but I can't find any reliable way to do this.
73 lines
3.7 KiB
Plaintext
73 lines
3.7 KiB
Plaintext
class QgsDiagram
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgsdiagram.h>
|
|
%End
|
|
public:
|
|
virtual ~QgsDiagram();
|
|
/** Returns an instance that is equivalent to this one
|
|
* @note added in 2.4 */
|
|
virtual QgsDiagram* clone() const = 0 /Factory/;
|
|
|
|
void clearCache();
|
|
|
|
//! @deprecated use QgsExpressionContext variant instead
|
|
QgsExpression* getExpression( const QString& expression, const QgsFields* fields ) /Deprecated/;
|
|
|
|
/** Returns a prepared expression for the specified context.
|
|
* @param expression expression string
|
|
* @param context expression context
|
|
* @note added in QGIS 2.12
|
|
*/
|
|
QgsExpression* getExpression( const QString& expression, const QgsExpressionContext& context );
|
|
|
|
/** @deprecated `void renderDiagram( const QgsFeature& feature, QgsRenderContext& c, const QgsDiagramSettings& s, const QPointF& position )` should be used instead */
|
|
virtual void renderDiagram( const QgsAttributes& att, QgsRenderContext& c, const QgsDiagramSettings& s, const QPointF& position ) /Deprecated/;
|
|
/** Draws the diagram at the given position (in pixel coordinates)*/
|
|
virtual void renderDiagram( const QgsFeature& feature, QgsRenderContext& c, const QgsDiagramSettings& s, const QPointF& position ) = 0;
|
|
virtual QString diagramName() const = 0;
|
|
/** Returns the size in map units the diagram will use to render.*/
|
|
virtual QSizeF diagramSize( const QgsAttributes& attributes, const QgsRenderContext& c, const QgsDiagramSettings& s ) = 0;
|
|
/** @deprecated `QSizeF diagramSize( const QgsFeature& feature, const QgsRenderContext& c, const QgsDiagramSettings& s, const QgsDiagramInterpolationSettings& is )` should be used instead */
|
|
virtual QSizeF diagramSize( const QgsAttributes& attributes, const QgsRenderContext& c, const QgsDiagramSettings& s, const QgsDiagramInterpolationSettings& is ) /Deprecated/;
|
|
/** Returns the size in map units the diagram will use to render. Interpolate size*/
|
|
virtual QSizeF diagramSize( const QgsFeature& feature, const QgsRenderContext& c, const QgsDiagramSettings& s, const QgsDiagramInterpolationSettings& is ) = 0;
|
|
|
|
protected:
|
|
QgsDiagram();
|
|
QgsDiagram( const QgsDiagram& other );
|
|
|
|
/** Changes the pen width to match the current settings and rendering context
|
|
* @param pen The pen to modify
|
|
* @param s The settings that specify the pen width
|
|
* @param c The rendering specifying the proper scale units for pixel conversion
|
|
*/
|
|
void setPenWidth( QPen& pen, const QgsDiagramSettings& s, const QgsRenderContext& c );
|
|
|
|
/** Calculates a size to match the current settings and rendering context
|
|
* @param size The size to convert
|
|
* @param s The settings that specify the size type
|
|
* @param c The rendering specifying the proper scale units for pixel conversion
|
|
*
|
|
* @return The converted size for rendering
|
|
*/
|
|
QSizeF sizePainterUnits( const QSizeF& size, const QgsDiagramSettings& s, const QgsRenderContext& c );
|
|
|
|
/** Calculates a length to match the current settings and rendering context
|
|
* @param l The length to convert
|
|
* @param s Unused
|
|
* @param c The rendering specifying the proper scale units for pixel conversion
|
|
*
|
|
* @return The converted length for rendering
|
|
*/
|
|
float sizePainterUnits( float l, const QgsDiagramSettings& s, const QgsRenderContext& c );
|
|
|
|
/** Calculates a size to match the current settings and rendering context
|
|
* @param s The settings that contain the font size and size type
|
|
* @param c The rendering specifying the proper scale units for pixel conversion
|
|
*
|
|
* @return The properly scaled font for rendering
|
|
*/
|
|
QFont scaledFont( const QgsDiagramSettings& s, const QgsRenderContext& c );
|
|
};
|