A convenience class for quickly printing a map. More...

#include <qgsquickprint.h>

Collaboration diagram for QgsQuickPrint:

Public Types
enum	SymbolScalingType { ScaleUp, ScaleDown }
Public Slots
void	printMap ()
void	setTitle (QString theText)
void	setName (QString theText)
void	setCopyright (QString theText)
void	setNorthArrow (QString theFileName)
void	setLogo1 (QString theFileName)
void	setLogo2 (QString theFileName)
void	setOutputPdf (QString theFileName)
void	setPageSize (QPrinter::PageSize theSize)
void	setMapCanvas (QgsMapCanvas *thepMapCanvas)
	This is just a convenience function to get the.
void	setMapRenderer (QgsMapRenderer *thepMapRenderer)
void	setMapBackgroundColor (QColor theColor)
Public Member Functions
	QgsQuickPrint ()
virtual	~QgsQuickPrint ()
	Destructor.
Static Public Member Functions
static QString	pageSizeToString (QPrinter::PageSize theSize)
static QPrinter::PageSize	stringToPageSize (QString theSize)
Private Member Functions
void	renderPrintScaleBar (QPainter thepPainter, QgsMapRenderer thepMapRenderer, int theMaximumWidth)
QStringList	wordWrap (QString theString, QFontMetrics theMetrics, int theWidth)
void	scalePointSymbols (int theScaleFactor, SymbolScalingType theDirection)
	Scale symbols in all layers by the specified amount.
void	scaleTextLabels (int theScaleFactor, SymbolScalingType theDirection)
	Scale text labels in all layers by the specified amount.
Private Attributes
QgsMapRenderer *	mpMapRenderer
QString	mTitleText
QString	mNameText
QString	mCopyrightText
QString	mNorthArrowFile
QString	mLogo1File
QString	mLogo2File
QString	mOutputFileName
QColor	mMapBackgroundColor
QPrinter::PageSize	mPageSize

Detailed Description

A convenience class for quickly printing a map.

Prints a map with a map title, scale bar, north arrow, legend etc.

Definition at line 35 of file qgsquickprint.h.

Member Enumeration Documentation

enum QgsQuickPrint::SymbolScalingType

Enumerator:

ScaleUp
ScaleDown

Definition at line 43 of file qgsquickprint.h.

Constructor & Destructor Documentation

QgsQuickPrint::QgsQuickPrint ( )

Definition at line 57 of file qgsquickprint.cpp.

References mPageSize.

QgsQuickPrint::~QgsQuickPrint ( ) [virtual]

Destructor.

Definition at line 62 of file qgsquickprint.cpp.

Member Function Documentation

QString QgsQuickPrint::pageSizeToString ( QPrinter::PageSize theSize ) [static]

Definition at line 1045 of file qgsquickprint.cpp.

Referenced by printMap().

void QgsQuickPrint::printMap ( ) [slot]

void QgsQuickPrint::renderPrintScaleBar	(	QPainter *	thepPainter,
		QgsMapRenderer *	thepMapRenderer,
		int	theMaximumWidth
	)		`[private]`

Definition at line 772 of file qgsquickprint.cpp.

References QGis::Degrees, QGis::Feet, QgsMapRenderer::layerSet(), QgsMapRenderer::mapUnits(), QgsMapRenderer::mapUnitsPerPixel(), QGis::Meters, QgsDebugMsg, and QGis::UnknownUnit.

Referenced by printMap().

void QgsQuickPrint::scalePointSymbols	(	int	theScaleFactor,
		SymbolScalingType	theDirection
	)		`[private]`

Scale symbols in all layers by the specified amount.

Typically used for printing. Each symbol in each layer of the active mapcanvas will be iterated to. If the symbol is a point symbol its size will be multiplied by the scale factor or divided. In order to choose an appropriate scale factor, typically you should divide the print resolution by the screen resolution (often 72dpi or 96dpi).

Parameters:

theScaleFactor	amount by which symbol sizes will be multiplied.
theDirection	whether the sizes should be scaled up or down.

See also:: scaleTextLabels

Definition at line 705 of file qgsquickprint.cpp.

References QgsMapLayerRegistry::instance(), QgsMapRenderer::layerSet(), QgsMapLayerRegistry::mapLayer(), mpMapRenderer, QGis::Point, QgsSymbol::pointSize(), QgsDebugMsg, QgsVectorLayer::renderer(), ScaleUp, QgsSymbol::setPointSize(), QgsRenderer::symbols(), and QgsSymbol::type().

void QgsQuickPrint::scaleTextLabels	(	int	theScaleFactor,
		SymbolScalingType	theDirection
	)		`[private]`

Scale text labels in all layers by the specified amount.

Typically used for printing. Each label in each layer of the active mapcanvas will be iterated to. The font point size will be multiplied by the scale factor or divided. In order to choose an appropriate scale factor, typically you should divide the print resolution by the screen resolution (often 72dpi or 96dpi).

Parameters: