Quantum GIS API Documentation: QgsComposerMap Class Reference

Definition at line 39 of file qgscomposermap.h.


Public Types
enum	PreviewMode { Cache = 0, Render, Rectangle }
	Preview style. More...
Public Slots
void	mapCanvasChanged ()
Signals
void	extentChanged ()
	Is emitted when width/height is changed as a result of user interaction.
Public Member Functions
	QgsComposerMap (QgsComposition *composition, int x, int y, int width, int height)
	Constructor.
	QgsComposerMap (QgsComposition *composition)
	Constructor.
	~QgsComposerMap ()
void	init (void)
	Initialise GUI and other settings, shared by constructors.
void	draw (QPainter *painter, const QgsRectangle &extent, const QSize &size, int dpi)
	Draw to paint device.
void	paint (QPainter painter, const QStyleOptionGraphicsItem itemStyle, QWidget *pWidget)
	Reimplementation of QCanvasItem::paint - draw on canvas.
void	recalculate (void)
	Recalculate rectangle/extent/scale according to current rule.
void	cache (void)
	Create cache image.
int	id () const
	Get identification number.
bool	isDrawing () const
	True if a draw is already in progress.
void	resize (double dx, double dy)
	resizes an item in x- and y direction (canvas coordinates)
void	moveContent (double dx, double dy)
	Move content of map.
void	zoomContent (int delta, double x, double y)
	Zoom content of map.
void	setSceneRect (const QRectF &rectangle)
	Sets new scene rectangle bounds and recalculates hight and extent.
double	scale (void) const
	Scale.
void	setNewScale (double scaleDenominator)
	Sets new scale and changes only mExtent.
void	setNewExtent (const QgsRectangle &extent)
	Sets new Extent and changes width, height (and implicitely also scale).
PreviewMode	previewMode ()
void	setPreviewMode (PreviewMode m)
void	setCacheUpdated (bool u=false)
QgsRectangle	extent () const
const QgsMapRenderer *	mapRenderer () const
void	setOffset (double xOffset, double yOffset)
	Sets offset values to shift image (useful for live updates when moving item content).
bool	containsWMSLayer () const
	True if composer map renders a WMS layer.
bool	writeXML (QDomElement &elem, QDomDocument &doc) const
	stores state in Dom node
bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)
	sets state from Dom document
Private Member Functions
void	connectUpdateSlot ()
	Establishes signal/slot connection for update in case of layer change.
double	horizontalViewScaleFactor () const
	Returns the zoom factor of the graphics view.
Private Attributes
QgsMapRenderer *	mMapRenderer
int	mId
	Unique identifier.
QgsRectangle	mExtent
QPixmap	mCachePixmap
bool	mCacheUpdated
PreviewMode	mPreviewMode
	Preview style.
int	mNumCachedLayers
	Number of layers when cache was created.
bool	mDrawing
	set to true if in state of drawing.
double	mLastScaleFactorX
	Store last scale factor to avoid unnecessary repaints in case preview mode is 'Render'.
QgsRectangle	mCachedMapExtent
	Store the last map extent to decide if cache needs to be updatet.
double	mXOffset
	Offset in x direction for showing map cache image.
double	mYOffset
	Offset in y direction for showing map cache image.
Static Private Attributes
static int	mCurrentComposerId
	For the generation of new unique ids.

Member Enumeration Documentation

enum QgsComposerMap::PreviewMode

Preview style.

Enumerator:

Cache
Render
Rectangle

Definition at line 51 of file qgscomposermap.h.

Constructor & Destructor Documentation

QgsComposerMap::QgsComposerMap	(	QgsComposition *	composition,
		int	x,
		int	y,
		int	width,
		int	height
	)

Constructor.

Definition at line 45 of file qgscomposermap.cpp.

References QgsComposerItem::composition(), connectUpdateSlot(), QgsMapRenderer::extent(), QgsComposition::mapRenderer(), mCacheUpdated, QgsComposerItem::mComposition, mCurrentComposerId, mDrawing, mExtent, mId, mMapRenderer, mXOffset, mYOffset, and setSceneRect().

QgsComposerMap::QgsComposerMap ( QgsComposition * composition )

Constructor.

Settings are read from project.

Definition at line 71 of file qgscomposermap.cpp.

References QgsComposerItem::composition(), connectUpdateSlot(), QgsComposition::mapRenderer(), QgsComposerItem::mComposition, mCurrentComposerId, mId, mMapRenderer, mXOffset, and mYOffset.

QgsComposerMap::~QgsComposerMap ( )

Definition at line 87 of file qgscomposermap.cpp.

Member Function Documentation

void QgsComposerMap::init ( void )

Initialise GUI and other settings, shared by constructors.

void QgsComposerMap::draw	(	QPainter *	painter,
		const QgsRectangle &	extent,
		const QSize &	size,
		int	dpi
	)

Draw to paint device.

Parameters:

	extent	map extent
	size	size in scene coordinates
	dpi	scene dpi

Definition at line 93 of file qgscomposermap.cpp.

Referenced by cache(), and paint().

void QgsComposerMap::paint	(	QPainter *	painter,
		const QStyleOptionGraphicsItem *	itemStyle,
		QWidget *	pWidget
	)

Reimplementation of QCanvasItem::paint - draw on canvas.

Definition at line 170 of file qgscomposermap.cpp.

References draw(), QgsComposerItem::drawBackground(), QgsComposerItem::drawFrame(), QgsComposerItem::drawSelectionBoxes(), horizontalViewScaleFactor(), mCachePixmap, QgsComposerItem::mComposition, mExtent, mLastScaleFactorX, mPreviewMode, mXOffset, mYOffset, QgsComposition::plotStyle(), QgsComposition::Postscript, QgsComposition::Preview, QgsComposition::Print, Rectangle, and scale().

void QgsComposerMap::recalculate ( void )

Recalculate rectangle/extent/scale according to current rule.

void QgsComposerMap::cache ( void )

Create cache image.

Definition at line 135 of file qgscomposermap.cpp.

References draw(), horizontalViewScaleFactor(), mCachePixmap, mCacheUpdated, mExtent, mPreviewMode, Rectangle, QgsRectangle::width(), QgsRectangle::xMinimum(), and QgsRectangle::yMinimum().

Referenced by mapCanvasChanged(), moveContent(), readXML(), setNewScale(), setSceneRect(), and zoomContent().

int QgsComposerMap::id ( ) const [inline]

Get identification number.

Definition at line 77 of file qgscomposermap.h.

Referenced by QgsComposerScaleBar::writeXML().

bool QgsComposerMap::isDrawing ( ) const [inline]

True if a draw is already in progress.

Definition at line 80 of file qgscomposermap.h.

void QgsComposerMap::resize	(	double	dx,
		double	dy
	)

resizes an item in x- and y direction (canvas coordinates)

Definition at line 254 of file qgscomposermap.cpp.

References setSceneRect().

void QgsComposerMap::moveContent	(	double	dx,
		double	dy
	)			`[virtual]`

Move content of map.

Parameters:

	dx	move in x-direction (item and canvas coordinates)
	dy	move in y-direction (item and canvas coordinates)

Reimplemented from QgsComposerItem.

Definition at line 262 of file qgscomposermap.cpp.

References cache(), extentChanged(), QgsRectangle::height(), mDrawing, mExtent, QgsRectangle::setXMaximum(), QgsRectangle::setXMinimum(), QgsRectangle::setYMaximum(), QgsRectangle::setYMinimum(), QgsRectangle::width(), QgsRectangle::xMaximum(), QgsRectangle::xMinimum(), QgsRectangle::yMaximum(), and QgsRectangle::yMinimum().

void QgsComposerMap::zoomContent	(	int	delta,
		double	x,
		double	y
	)			`[virtual]`

Zoom content of map.

Parameters:

	delta	value from wheel event that describes magnitude and direction (positive /negative number)
	x	x-coordinate of mouse position in item coordinates
	y	y-coordinate of mouse position in item coordinates

Reimplemented from QgsComposerItem.

Definition at line 283 of file qgscomposermap.cpp.

References cache(), extentChanged(), mExtent, QgsRectangle::setXMaximum(), QgsRectangle::setXMinimum(), QgsRectangle::setYMaximum(), QgsRectangle::setYMinimum(), QgsRectangle::xMaximum(), QgsRectangle::xMinimum(), QgsRectangle::yMaximum(), and QgsRectangle::yMinimum().