#include <qgscomposerhtml.h>

Inheritance diagram for QgsComposerHtml:

Public Types
enum	ContentMode { Url, ManualHtml }
	Source modes for the HTML content to render in the item. More...
Public Types inherited from QgsComposerMultiFrame
enum	ResizeMode { UseExistingFrames = 0, ExtendToNextPage, RepeatOnEveryPage, RepeatUntilFinished }
Public Types inherited from QgsComposerObject
enum	DataDefinedProperty { NoProperty = 0, AllProperties, TestProperty, PresetPaperSize, PaperWidth, PaperHeight, NumPages, PaperOrientation, PageNumber, PositionX, PositionY, ItemWidth, ItemHeight, ItemRotation, Transparency, BlendMode, ExcludeFromExports, MapRotation, MapScale, MapXMin, MapYMin, MapXMax, MapYMax, MapAtlasMargin, PictureSource, SourceUrl }
	Data defined properties for different item types. More...
enum	PropertyValueType { EvaluatedValue = 0, OriginalValue }
	Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...

Public Slots
void	loadHtml ()
	Reloads the html source from the url and redraws the item.
void	recalculateFrameSizes ()
	Recalculates the frame sizes for the current viewport dimensions.
void	refreshExpressionContext ()
virtual void	refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties)
Public Slots inherited from QgsComposerMultiFrame
void	update ()
	Forces a redraw of all child frames.
virtual void	recalculateFrameSizes ()
	Recalculates the portion of the multiframe item which is shown in each of it's component frames.
void	recalculateFrameRects ()
	Forces a recalculation of all the associated frame's scene rectangles.
Public Slots inherited from QgsComposerObject
virtual void	repaint ()
	Triggers a redraw for the item.
virtual void	refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties)
	Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value.

Public Member Functions
	QgsComposerHtml (QgsComposition *c, bool createUndoCommands)
	QgsComposerHtml ()
	~QgsComposerHtml ()
void	setContentMode (ContentMode mode)
	Sets the source mode for item's HTML content.
ContentMode	contentMode () const
	Returns the source mode for item's HTML content.
void	setUrl (const QUrl &url)
	Sets the URL for content to display in the item when the item is using the QgsComposerHtml::Url mode.
const QUrl &	url () const
	Returns the URL of the content displayed in the item if the item is using the QgsComposerHtml::Url mode.
void	setHtml (const QString html)
	Sets the HTML to display in the item when the item is using the QgsComposerHtml::ManualHtml mode.
QString	html () const
	Returns the HTML source displayed in the item if the item is using the QgsComposerHtml::ManualHtml mode.
bool	evaluateExpressions () const
	Returns whether html item will evaluate QGIS expressions prior to rendering the HTML content.
void	setEvaluateExpressions (bool evaluateExpressions)
	Sets whether the html item will evaluate QGIS expressions prior to rendering the HTML content.
bool	useSmartBreaks () const
	Returns whether html item is using smart breaks.
void	setUseSmartBreaks (bool useSmartBreaks)
	Sets whether the html item should use smart breaks.
void	setMaxBreakDistance (double maxBreakDistance)
	Sets the maximum distance allowed when calculating where to place page breaks in the html.
double	maxBreakDistance () const
	Returns the maximum distance allowed when calculating where to place page breaks in the html.
void	setUserStylesheet (const QString stylesheet)
	Sets the user stylesheet CSS rules to use while rendering the HTML content.
QString	userStylesheet () const
	Returns the user stylesheet CSS rules used while rendering the HTML content.
void	setUserStylesheetEnabled (const bool stylesheetEnabled)
	Sets whether user stylesheets are enabled for the HTML content.
bool	userStylesheetEnabled () const
	Returns whether user stylesheets are enabled for the HTML content.
virtual QString	displayName () const
	Get multiframe display name.
QSizeF	totalSize () const
	Returns the total size of the multiframe's content.
void	render (QPainter *p, const QRectF &renderExtent, const int frameIndex)
	Renders a portion of the multiframe's content into a painter.
bool	writeXML (QDomElement &elem, QDomDocument &doc, bool ignoreFrames=false) const
	Stores state information about multiframe in DOM element.
bool	readXML (const QDomElement &itemElem, const QDomDocument &doc, bool ignoreFrames=false)
	Reads multiframe state information from a DOM element.
void	addFrame (QgsComposerFrame *frame, bool recalcFrameSizes=true)
	Adds a frame to the multiframe.
double	findNearbyPageBreak (double yPos)
	Finds the optimal position to break a frame at.
Public Member Functions inherited from QgsComposerMultiFrame
	QgsComposerMultiFrame (QgsComposition *c, bool createUndoCommands)
	Construct a new multiframe item.
virtual	~QgsComposerMultiFrame ()
virtual QSizeF	fixedFrameSize (const int frameIndex=-1) const
	Returns the fixed size for a frame, if desired.
virtual QSizeF	minFrameSize (const int frameIndex=-1) const
	Returns the minimum size for a frames, if desired.
virtual Q_DECL_DEPRECATED void	render (QPainter *p, const QRectF &renderExtent)
	Renders a portion of the multiframe's content into a painter.
void	removeFrame (int i, const bool removeEmptyPages=false)
	Removes a frame from the multiframe.
void	deleteFrames ()
	Removes and deletes all child frames.
void	setResizeMode (ResizeMode mode)
	Sets the resize mode for the multiframe, and recalculates frame sizes to match.
ResizeMode	resizeMode () const
	Returns the resize mode for the multiframe.
bool	_writeXML (QDomElement &elem, QDomDocument &doc, bool ignoreFrames=false) const
	Stores state information about base multiframe object in DOM element.
bool	_readXML (const QDomElement &itemElem, const QDomDocument &doc, bool ignoreFrames=false)
	Restores state information about base multiframe object from a DOM element.
QgsComposition *	composition ()
	Returns the parent composition for the multiframe.
bool	createUndoCommands () const
	Returns whether undo commands should be created for interactions with the multiframe.
void	setCreateUndoCommands (bool enabled)
	Sets whether undo commands should be created for interactions with the multiframe.
int	frameCount () const
	Returns the number of frames associated with this multiframe.
QgsComposerFrame *	frame (int i) const
	Returns a child frame from the multiframe.
int	frameIndex (QgsComposerFrame *frame) const
	Returns the index of a frame within the multiframe.
QgsComposerFrame *	createNewFrame (QgsComposerFrame *currentFrame, QPointF pos, QSizeF size)
	Creates a new frame and adds it to the multi frame and composition.
Public Member Functions inherited from QgsComposerObject
	QgsComposerObject (QgsComposition *composition)
	Constructor.
virtual	~QgsComposerObject ()
const QgsComposition *	composition () const
	Returns the composition the item is attached to.
virtual bool	writeXML (QDomElement &elem, QDomDocument &doc) const
	Stores item state in DOM element.
virtual bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)
	Sets item state from DOM element.
QgsDataDefined *	dataDefinedProperty (const DataDefinedProperty property) const
	Returns a reference to the data defined settings for one of the item's data defined properties.
void	setDataDefinedProperty (const DataDefinedProperty property, const bool active, const bool useExpression, const QString &expression, const QString &field)
	Sets parameters for a data defined property for the item.

Additional Inherited Members
Signals inherited from QgsComposerMultiFrame
void	changed ()
	Emitted when the properties of a multi frame have changed, and the GUI item widget must be updated.
void	contentsChanged ()
	Emitted when the contents of the multi frame have changed and the frames must be redrawn.
Protected Slots inherited from QgsComposerMultiFrame
void	handleFrameRemoval (QgsComposerItem *item)
	Called before a frame is going to be removed.
void	handlePageChange ()
	Adapts to changed number of composition pages if resize type is RepeatOnEveryPage.
Protected Member Functions inherited from QgsComposerObject
bool	dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue)
	Evaluate a data defined property and return the calculated value.
Protected Attributes inherited from QgsComposerMultiFrame
QList< QgsComposerFrame * >	mFrameItems
ResizeMode	mResizeMode
bool	mCreateUndoCommands
	True: creates QgsMultiFrameCommands on internal changes (e.g.

Member Enumeration Documentation

enum QgsComposerHtml::ContentMode

Source modes for the HTML content to render in the item.

Enumerator:

Url
ManualHtml

Constructor & Destructor Documentation

QgsComposerHtml::QgsComposerHtml	(	QgsComposition *	c,
		bool	createUndoCommands
	)

QgsComposerHtml::QgsComposerHtml ( )

QgsComposerHtml::~QgsComposerHtml ( )

Member Function Documentation

void QgsComposerHtml::addFrame	(	QgsComposerFrame *	frame,
		bool	recalcFrameSizes = `true`
	)

virtual

Adds a frame to the multiframe.

Parameters

frame	frame to add
recalcFrameSizes	set to true to force recalculation of all existing frame sizes

See Also: removeFrame

Implements QgsComposerMultiFrame.

ContentMode QgsComposerHtml::contentMode ( ) const

inline

Returns the source mode for item's HTML content.

Returns: ContentMode for the item's source

See Also: setContentMode; url; html

Note: added in 2.5

QString QgsComposerHtml::displayName ( ) const

virtual

Get multiframe display name.

Returns: display name for item

Note: added in version 2.5

Reimplemented from QgsComposerMultiFrame.

bool QgsComposerHtml::evaluateExpressions ( ) const

inline

Returns whether html item will evaluate QGIS expressions prior to rendering the HTML content.

If set, any content inside [% %] tags will be treated as a QGIS expression and evaluated against the current atlas feature.

Returns: true if html item will evaluate expressions in the content

See Also: setEvaluateExpressions

Note: added in QGIS 2.5

double QgsComposerHtml::findNearbyPageBreak ( double yPos )

virtual

Finds the optimal position to break a frame at.

Parameters

yPos	maximum vertical position for break

Returns: the optimal breakable position which occurs in the multi frame close to and before the specified yPos

Note: added in version 2.3

Reimplemented from QgsComposerMultiFrame.

QString QgsComposerHtml::html ( ) const

inline

Returns the HTML source displayed in the item if the item is using the QgsComposerHtml::ManualHtml mode.

Returns: HTML displayed in item

See Also: setHtml; contentMode

Note: added in 2.5

void QgsComposerHtml::loadHtml ( )

slot

Reloads the html source from the url and redraws the item.

See Also: setUrl; url

double QgsComposerHtml::maxBreakDistance ( ) const

inline

Returns the maximum distance allowed when calculating where to place page breaks in the html.

This distance is the maximum amount of empty space allowed at the bottom of a frame after calculating the optimum break location. This setting is only effective if useSmartBreaks is true.

Returns: maximum amount of empty space to leave when calculating page break locations

Note: added in 2.3

See Also: setMaxBreakDistance; useSmartBreaks

bool QgsComposerHtml::readXML	(	const QDomElement &	itemElem,
		const QDomDocument &	doc,
		bool	ignoreFrames = `false`
	)

virtual

Reads multiframe state information from a DOM element.

Implementations of readXML should also call the _readXML method to restore general multiframe properties.

Parameters

itemElem	is DOM element
doc	is the DOM document
ignoreFrames	set to false to avoid read state information about child frames from DOM

See Also: _readXML

Implements QgsComposerMultiFrame.

void QgsComposerHtml::recalculateFrameSizes ( )

slot

Recalculates the frame sizes for the current viewport dimensions.

void QgsComposerHtml::refreshDataDefinedProperty ( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties )

virtualslot

void QgsComposerHtml::refreshExpressionContext ( )

slot

void QgsComposerHtml::render	(	QPainter *	painter,
		const QRectF &	renderExtent,
		const int	frameIndex
	)

virtual

Renders a portion of the multiframe's content into a painter.

Parameters

painter	destination painter
renderExtent	visible extent of content to render into the painter.
frameIndex	frame number for content

Note: added in version 2.5

Reimplemented from QgsComposerMultiFrame.

void QgsComposerHtml::setContentMode ( ContentMode mode )

inline

Sets the source mode for item's HTML content.

Parameters

mode	ContentMode for the item's source

See Also: contentMode; setUrl; setHtml

Note: added in 2.5

void QgsComposerHtml::setEvaluateExpressions ( bool evaluateExpressions )

Sets whether the html item will evaluate QGIS expressions prior to rendering the HTML content.

If set, any content inside [% %] tags will be treated as a QGIS expression and evaluated against the current atlas feature.

Parameters

evaluateExpressions set to true to evaluate expressions in the HTML content

See Also: evaluateExpressions

Note: added in QGIS 2.5

void QgsComposerHtml::setHtml ( const QString html )

Sets the HTML to display in the item when the item is using the QgsComposerHtml::ManualHtml mode.

Setting the HTML using this function does not automatically refresh the item's contents. Call loadHtml to trigger a refresh of the item after setting the HTML content.

Parameters

html	HTML to display in item

See Also: html; contentMode; loadHtml

Note: added in 2.5

void QgsComposerHtml::setMaxBreakDistance ( double maxBreakDistance )

Sets the maximum distance allowed when calculating where to place page breaks in the html.

This distance is the maximum amount of empty space allowed at the bottom of a frame after calculating the optimum break location. Setting a larger value will result in better choice of page break location, but more wasted space at the bottom of frames. This setting is only effective if useSmartBreaks is true.

Parameters

maxBreakDistance maximum amount of empty space to leave when calculating page break locations

Note: added in 2.3

See Also: maxBreakDistance; setUseSmartBreaks

void QgsComposerHtml::setUrl ( const QUrl & url )

Sets the URL for content to display in the item when the item is using the QgsComposerHtml::Url mode.

Content is automatically fetched and the HTML item refreshed after calling this function.

Parameters

url	URL of content to display in the item

See Also: url; contentMode

void QgsComposerHtml::setUserStylesheet ( const QString stylesheet )

Sets the user stylesheet CSS rules to use while rendering the HTML content.

These allow for overriding the styles specified within the HTML source. Setting the stylesheet using this function does not automatically refresh the item's contents. Call loadHtml to trigger a refresh of the item after setting the stylesheet rules.

Parameters

stylesheet CSS rules for user stylesheet