mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
47683fca4f
This change is being driven by: - need for consistent terminology in the api. Currently there's a confusing mix of border/outline used - need for consistent terminology in the gui - we have a mix of "border"/"outline"/"pen" - bringing QGIS into line with the standard terminology used in other graphic editing programs
267 lines
8.6 KiB
Plaintext
267 lines
8.6 KiB
Plaintext
/** \ingroup core
|
|
* A composer class that displays svg files or raster format (jpg, png, ...)
|
|
* */
|
|
class QgsComposerPicture: QgsComposerItem
|
|
{
|
|
|
|
%TypeHeaderCode
|
|
#include "qgscomposerpicture.h"
|
|
%End
|
|
|
|
public:
|
|
|
|
/** Controls how pictures are scaled within the item's frame
|
|
*/
|
|
enum ResizeMode
|
|
{
|
|
Zoom, /*!< enlarges image to fit frame while maintaining aspect ratio of picture */
|
|
Stretch, /*!< stretches image to fit frame, ignores aspect ratio */
|
|
Clip, /*!< draws image at original size and clips any portion which falls outside frame */
|
|
ZoomResizeFrame, /*!< enlarges image to fit frame, then resizes frame to fit resultant image */
|
|
FrameToImageSize /*!< sets size of frame to match original size of image without scaling */
|
|
};
|
|
|
|
/** Format of source image
|
|
*/
|
|
enum Mode
|
|
{
|
|
SVG,
|
|
RASTER,
|
|
Unknown
|
|
};
|
|
|
|
//! Method for syncing rotation to a map's North direction
|
|
enum NorthMode
|
|
{
|
|
GridNorth, /*!< Align to grid north */
|
|
TrueNorth, /*!< Align to true north */
|
|
};
|
|
|
|
QgsComposerPicture( QgsComposition *composition /TransferThis/);
|
|
~QgsComposerPicture();
|
|
|
|
/** Return correct graphics item type. */
|
|
virtual int type() const;
|
|
|
|
/** Reimplementation of QCanvasItem::paint*/
|
|
void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget );
|
|
|
|
/** Sets the source path of the image (may be svg or a raster format). Data defined
|
|
* picture source may override this value. The path can either be a local path
|
|
* or a remote (http) path.
|
|
* @param path path for the source image
|
|
* @see usePictureExpression
|
|
* @see picturePath
|
|
* @note added in QGIS 2.5
|
|
*/
|
|
void setPicturePath( const QString& path );
|
|
|
|
/** Returns the path of the source image. Data defined picture source may override
|
|
* this value. The path can either be a local path or a remote (http) path.
|
|
* @returns path for the source image
|
|
* @see usePictureExpression
|
|
* @see setPicturePath
|
|
* @note added in QGIS 2.5
|
|
*/
|
|
QString picturePath() const;
|
|
|
|
/** Sets this items bound in scene coordinates such that 1 item size units
|
|
* corresponds to 1 scene size unit and resizes the svg symbol / image
|
|
*/
|
|
void setSceneRect( const QRectF& rectangle );
|
|
|
|
/** Stores state in Dom element
|
|
* @param elem is Dom element corresponding to 'Composer' tag
|
|
* @param doc is Dom document
|
|
*/
|
|
bool writeXml( QDomElement& elem, QDomDocument & doc ) const;
|
|
|
|
/** Sets state from Dom document
|
|
* @param itemElem is Dom node corresponding to item tag
|
|
* @param doc is Dom document
|
|
*/
|
|
bool readXml( const QDomElement& itemElem, const QDomDocument& doc );
|
|
|
|
/** Returns the rotation used for drawing the picture within the item's frame
|
|
* @returns picture rotation in degrees
|
|
* @note added in 2.2
|
|
* @see setPictureRotation
|
|
* @see rotationMap
|
|
*/
|
|
double pictureRotation() const;
|
|
|
|
/** Sets the map object for rotation (by id). A value of -1 disables the map
|
|
* rotation. If this is set then the picture will be rotated by the same
|
|
* amount as the specified map object. This is useful especially for
|
|
* syncing north arrows with a map item.
|
|
* @param composerMapId composer map id to sync rotation with
|
|
* @see setPictureRotation
|
|
* @see rotationMap
|
|
*/
|
|
void setRotationMap( int composerMapId );
|
|
|
|
/** Returns the id of the rotation map. A value of -1 means map rotation is
|
|
* disabled. If this is set then the picture is rotated by the same amount
|
|
* as the specified map object.
|
|
* @returns id of map object
|
|
* @see setRotationMap
|
|
* @see useRotationMap
|
|
*/
|
|
int rotationMap() const;
|
|
|
|
/** True if the picture rotation is matched to a map item.
|
|
* @returns true if rotation map is in use
|
|
* @see rotationMap
|
|
* @see setRotationMap
|
|
*/
|
|
bool useRotationMap() const;
|
|
|
|
/**
|
|
* Returns the mode used to align the picture to a map's North.
|
|
* @see setNorthMode()
|
|
* @see northOffset()
|
|
* @note added in QGIS 2.18
|
|
*/
|
|
NorthMode northMode() const;
|
|
|
|
/**
|
|
* Sets the mode used to align the picture to a map's North.
|
|
* @see northMode()
|
|
* @see setNorthOffset()
|
|
* @note added in QGIS 2.18
|
|
*/
|
|
void setNorthMode( NorthMode mode );
|
|
|
|
/**
|
|
* Returns the offset added to the picture's rotation from a map's North.
|
|
* @see setNorthOffset()
|
|
* @see northMode()
|
|
* @note added in QGIS 2.18
|
|
*/
|
|
double northOffset() const;
|
|
|
|
/**
|
|
* Sets the offset added to the picture's rotation from a map's North.
|
|
* @see northOffset()
|
|
* @see setNorthMode()
|
|
* @note added in QGIS 2.18
|
|
*/
|
|
void setNorthOffset( double offset );
|
|
|
|
/** Returns the resize mode used for drawing the picture within the composer
|
|
* item's frame.
|
|
* @returns resize mode of picture
|
|
* @note added in 2.3
|
|
* @see setResizeMode
|
|
*/
|
|
ResizeMode resizeMode() const;
|
|
|
|
/** Sets the picture's anchor point, which controls how it is placed
|
|
* within the picture item's frame.
|
|
* @param anchor anchor point for picture
|
|
* @note added in 2.3
|
|
* @see pictureAnchor
|
|
*/
|
|
void setPictureAnchor( QgsComposerItem::ItemPositionMode anchor );
|
|
|
|
/** Returns the picture's current anchor, which controls how it is placed
|
|
* within the picture item's frame.
|
|
* @returns anchor point for picture
|
|
* @note added in 2.3
|
|
* @see setPictureAnchor
|
|
*/
|
|
ItemPositionMode pictureAnchor() const;
|
|
|
|
/** Returns the fill color used for parametrized SVG files.
|
|
* @see setSvgFillColor()
|
|
* @see svgStrokeColor()
|
|
* @note added in QGIS 2.14.1
|
|
*/
|
|
QColor svgFillColor() const;
|
|
|
|
/** Sets the fill color used for parametrized SVG files.
|
|
* @param color fill color.
|
|
* @note this setting only has an effect on parametrized SVG files, and is ignored for
|
|
* non-parametrized SVG files.
|
|
* @see svgFillColor()
|
|
* @see setSvgStrokeColor()
|
|
* @note added in QGIS 2.14.1
|
|
*/
|
|
void setSvgFillColor( const QColor& color );
|
|
|
|
/** Returns the stroke color used for parametrized SVG files.
|
|
* @see setSvgStrokeColor()
|
|
* @see svgFillColor()
|
|
* @note added in QGIS 2.14.1
|
|
*/
|
|
QColor svgStrokeColor() const;
|
|
|
|
/** Sets the stroke color used for parametrized SVG files.
|
|
* @param color stroke color.
|
|
* @note this setting only has an effect on parametrized SVG files, and is ignored for
|
|
* non-parametrized SVG files.
|
|
* @see svgStrokelColor()
|
|
* @see setSvgFillColor()
|
|
* @note added in QGIS 2.14.1
|
|
*/
|
|
void setSvgStrokeColor( const QColor& color );
|
|
|
|
/** Returns the stroke width (in mm) used for parametrized SVG files.
|
|
* @see setSvgStrokeWidth()
|
|
* @see svgStrokeColor()
|
|
* @note added in QGIS 2.14.1
|
|
*/
|
|
double svgStrokeWidth() const;
|
|
|
|
/** Sets the stroke width used for parametrized SVG files.
|
|
* @param width stroke width in mm
|
|
* @note this setting only has an effect on parametrized SVG files, and is ignored for
|
|
* non-parametrized SVG files.
|
|
* @see svgStrokeWidth()
|
|
* @see setSvgStrokeColor()
|
|
* @note added in QGIS 2.14.1
|
|
*/
|
|
void setSvgStrokeWidth( double width );
|
|
|
|
/** Returns the current picture mode (image format).
|
|
* @returns picture mode
|
|
* @note added in 2.3
|
|
*/
|
|
Mode mode() const;
|
|
|
|
public slots:
|
|
|
|
/** Sets the picture rotation within the item bounds. This does not affect
|
|
* the item's frame, only the way the picture is drawn within the item.
|
|
* @param r rotation in degrees clockwise
|
|
* @see pictureRotation
|
|
* @note added in 2.2
|
|
*/
|
|
virtual void setPictureRotation( double r );
|
|
|
|
/** Sets the resize mode used for drawing the picture within the item bounds.
|
|
* @param mode ResizeMode to use for image file
|
|
* @note added in 2.3
|
|
* @see resizeMode
|
|
*/
|
|
virtual void setResizeMode( ResizeMode mode );
|
|
|
|
/** Recalculates the source image (if using an expression for picture's source)
|
|
* and reloads and redraws the picture.
|
|
* @param context expression context for evaluating data defined picture sources
|
|
* @note added in 2.3
|
|
*/
|
|
void refreshPicture( const QgsExpressionContext* context = 0 );
|
|
|
|
/** Forces a recalculation of the picture's frame size
|
|
* @note added in 2.3
|
|
*/
|
|
void recalculateSize();
|
|
|
|
virtual void refreshDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties, const QgsExpressionContext *context = 0 );
|
|
|
|
signals:
|
|
/** Is emitted on picture rotation change*/
|
|
void pictureRotationChanged( double newRotation );
|
|
};
|