Frame item for a composer multiframe item. More...

#include <qgscomposerframe.h>

Inheritance diagram for QgsComposerFrame:

Public Member Functions
	QgsComposerFrame (QgsComposition c, QgsComposerMultiFrame mf, qreal x, qreal y, qreal width, qreal height)

	~QgsComposerFrame ()

void	beginItemCommand (const QString &text) override

virtual QgsExpressionContext *	createExpressionContext () const override
	Creates an expression context relating to the item's current state. More...

virtual QString	displayName () const override
	Get item display name. More...

void	endItemCommand () override

QRectF	extent () const
	Returns the visible portion of the multi frame's content which is shown in this frame. More...

bool	hideBackgroundIfEmpty () const
	Returns whether the background and frame border should be hidden if this frame is empty. More...

bool	hidePageIfEmpty () const
	Returns whether the page should be hidden (ie, not included in composer exports) if this frame is empty. More...

bool	isEmpty () const
	Returns whether the frame is empty. More...

QgsComposerMultiFrame *	multiFrame () const
	Returns the parent multiframe for the frame. More...

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

bool	readXML (const QDomElement &itemElem, const QDomDocument &doc) override
	Sets item state from DOM element. More...

void	setContentSection (const QRectF &section)
	Sets the visible part of the multiframe's content which is visible within this frame (relative to the total multiframe extent in mm). More...

void	setHideBackgroundIfEmpty (const bool hideBackgroundIfEmpty)
	Sets whether the background and frame border should be hidden if this frame is empty. More...

void	setHidePageIfEmpty (const bool hidePageIfEmpty)
	Sets whether the page should be hidden (ie, not included in composer exports) if this frame is empty. More...

void	setSceneRect (const QRectF &rectangle) override
	Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit. More...

int	type () const override
	Return correct graphics item type. More...

bool	writeXML (QDomElement &elem, QDomDocument &doc) const override
	Stores item state in DOM element. More...

Public Member Functions inherited from QgsComposerItem
	QgsComposerItem (QgsComposition *composition, bool manageZValue=true)
	Constructor. More...

	QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true)
	Constructor with box position and composer object. More...

virtual	~QgsComposerItem ()

bool	_readXML (const QDomElement &itemElem, const QDomDocument &doc)
	Reads parameter that are not subclass specific in document. More...

bool	_writeXML (QDomElement &itemElem, QDomDocument &doc) const
	Writes parameter that are not subclass specific in document. More...

virtual void	addItem (QgsComposerItem *item)
	Composite operations for item groups do nothing per default. More...

QColor	backgroundColor () const
	Gets the background color for this item. More...

void	beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
	Starts new composer undo command. More...

QPainter::CompositionMode	blendMode () const
	Returns the item's composition blending mode. More...

void	cancelCommand ()

Q_DECL_DEPRECATED void	drawText (QPainter *p, double x, double y, const QString &text, const QFont &font, const QColor &c=QColor()) const
	Draws Text. More...

Q_DECL_DEPRECATED void	drawText (QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignment=Qt::AlignLeft, Qt::AlignmentFlag valignment=Qt::AlignTop, int flags=Qt::TextWordWrap) const
	Like the above, but with a rectangle for multiline text. More...

bool	effectsEnabled () const
	Returns whether effects (eg blend modes) are enabled for the item. More...

void	endCommand ()
	Finish current command and push it onto the undo stack. More...

virtual double	estimatedFrameBleed () const
	Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...

bool	excludeFromExports (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue)
	Returns whether the item should be excluded from composer exports and prints. More...

Q_DECL_DEPRECATED double	fontAscentMillimeters (const QFont &font) const
	Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...

Q_DECL_DEPRECATED double	fontDescentMillimeters (const QFont &font) const
	Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...

Q_DECL_DEPRECATED double	fontHeightCharacterMM (const QFont &font, QChar c) const
	Returns the font height of a character in millimeters. More...

Q_DECL_DEPRECATED double	fontHeightMillimeters (const QFont &font) const
	Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...

Qt::PenJoinStyle	frameJoinStyle () const
	Returns the join style used for drawing the item's frame. More...

QColor	frameOutlineColor () const
	Returns the frame's outline color. More...

double	frameOutlineWidth () const
	Returns the frame's outline width. More...

bool	hasBackground () const
	Whether this item has a Background or not. More...

bool	hasFrame () const
	Whether this item has a frame or not. More...

QString	id () const
	Get item's id (which is not necessarly unique) More...

bool	isGroupMember () const
	Returns whether this item is part of a group. More...

virtual bool	isRemoved () const
	Returns whether this item has been removed from the composition. More...

double	itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
	Returns the current rotation for the composer item. More...

ItemPositionMode	lastUsedPositionMode ()
	Returns item's last used position mode. More...

void	move (double dx, double dy)
	Moves item in canvas coordinates. More...

virtual void	moveContent (double dx, double dy)
	Move Content of item. More...

virtual int	numberExportLayers () const
	Get the number of layers that this item requires for exporting as layers. More...

int	page () const
	Gets the page the item is currently on. More...

QPointF	pagePos () const
	Returns the item's position relative to its current page. More...

Q_DECL_DEPRECATED double	pixelFontSize (double pointSize) const
	Calculates font size in mm from a font point size. More...

bool	positionLock () const
	Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing. More...

virtual QRectF	rectWithFrame () const
	Returns the item's rectangular bounds, including any bleed caused by the item's frame. More...

virtual void	removeItems ()

Q_DECL_DEPRECATED double	rotation () const
	Returns the rotation for the composer item. More...

Q_DECL_DEPRECATED QFont	scaledFontPixelSize (const QFont &font) const
	Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE. More...

virtual bool	selected () const
	Is selected. More...

void	setBackgroundColor (const QColor &backgroundColor)
	Sets the background color for this item. More...

void	setBackgroundEnabled (const bool drawBackground)
	Set whether this item has a Background drawn around it or not. More...

void	setBlendMode (const QPainter::CompositionMode blendMode)
	Sets the item's composition blending mode. More...

virtual void	setCurrentExportLayer (const int layerIdx=-1)
	Sets the current layer to draw for exporting. More...

void	setEffectsEnabled (const bool effectsEnabled)
	Sets whether effects (eg blend modes) are enabled for the item. More...

virtual void	setExcludeFromExports (const bool exclude)
	Sets whether the item should be excluded from composer exports and prints. More...

virtual void	setFrameEnabled (const bool drawFrame)
	Set whether this item has a frame drawn around it or not. More...

void	setFrameJoinStyle (const Qt::PenJoinStyle style)
	Sets join style used when drawing the item's frame. More...

virtual void	setFrameOutlineColor (const QColor &color)
	Sets frame outline color. More...

virtual void	setFrameOutlineWidth (const double outlineWidth)
	Sets frame outline width. More...

virtual void	setId (const QString &id)
	Set item's id (which is not necessarly unique) More...

void	setIsGroupMember (const bool isGroupMember)
	Sets whether this item is part of a group. More...

void	setIsRemoved (const bool removed)
	Sets whether this item has been removed from the composition. More...

void	setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft, int page=-1)
	Moves the item to a new position (in canvas coordinates) More...

void	setItemPosition (double x, double y, double width, double height, ItemPositionMode itemPoint=UpperLeft, bool posIncludesFrame=false, int page=-1)
	Sets item position and width / height in one go. More...

void	setPositionLock (const bool lock)
	Locks / unlocks the item position for mouse drags. More...

virtual void	setSelected (bool s)
	Set selected, selected item should be highlighted. More...

void	setTransparency (const int transparency)
	Sets the item's transparency. More...

virtual void	setVisibility (const bool visible)
	Sets visibility for item. More...

Q_DECL_DEPRECATED double	textWidthMillimeters (const QFont &font, const QString &text) const
	Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...

int	transparency () const
	Returns the item's transparency. More...

virtual void	updateItem ()
	Updates item, with the possibility to do custom update for subclasses. More...

void	updatePagePos (double newPageWidth, double newPageHeight)
	Moves the item so that it retains its relative position on the page when the paper size changes. More...

QString	uuid () const
	Get item identification name. More...

virtual Q_DECL_DEPRECATED void	zoomContent (int delta, double x, double y)
	Zoom content of item. More...

virtual void	zoomContent (const double factor, const QPointF point, const ZoomMode mode=QgsComposerItem::Zoom)
	Zoom content of item. More...

Public Member Functions inherited from QgsComposerObject
	QgsComposerObject (QgsComposition *composition)
	Constructor. More...

virtual	~QgsComposerObject ()

const QgsComposition *	composition () const
	Returns the composition the item is attached to. More...

QgsComposition *	composition ()

QStringList	customProperties () const
	Return list of keys stored in custom properties for the object. More...

QVariant	customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const
	Read a custom property from the object. More...

QgsDataDefined *	dataDefinedProperty (const DataDefinedProperty property) const
	Returns a reference to the data defined settings for one of the item's data defined properties. More...

void	removeCustomProperty (const QString &key)
	Remove a custom property from the object. More...

void	setCustomProperty (const QString &key, const QVariant &value)
	Set a custom property for the object. More...

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. More...

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QGraphicsRectItem
	QGraphicsRectItem (QGraphicsItem *parent)

	QGraphicsRectItem (const QRectF &rect, QGraphicsItem *parent)

	QGraphicsRectItem (qreal x, qreal y, qreal width, qreal height, QGraphicsItem *parent)

	~QGraphicsRectItem ()

virtual QRectF	boundingRect () const

virtual bool	contains (const QPointF &point) const

virtual bool	isObscuredBy (const QGraphicsItem *item) const

virtual QPainterPath	opaqueArea () const

QRectF	rect () const

void	setRect (const QRectF &rectangle)

void	setRect (qreal x, qreal y, qreal width, qreal height)

virtual QPainterPath	shape () const

Public Member Functions inherited from QAbstractGraphicsShapeItem
	QAbstractGraphicsShapeItem (QGraphicsItem *parent)

	~QAbstractGraphicsShapeItem ()

QBrush	brush () const

QPen	pen () const

void	setBrush (const QBrush &brush)

void	setPen (const QPen &pen)

Public Member Functions inherited from QGraphicsItem
	QGraphicsItem (QGraphicsItem *parent)

virtual	~QGraphicsItem ()

bool	acceptDrops () const

Qt::MouseButtons	acceptedMouseButtons () const

bool	acceptHoverEvents () const

bool	acceptsHoverEvents () const

bool	acceptTouchEvents () const

virtual void	advance (int phase)

virtual QRectF	boundingRect () const=0

QRegion	boundingRegion (const QTransform &itemToDeviceTransform) const

qreal	boundingRegionGranularity () const

CacheMode	cacheMode () const

QList< QGraphicsItem * >	childItems () const

QList< QGraphicsItem * >	children () const

QRectF	childrenBoundingRect () const

void	clearFocus ()

QPainterPath	clipPath () const

virtual bool	collidesWithItem (const QGraphicsItem *other, Qt::ItemSelectionMode mode) const

virtual bool	collidesWithPath (const QPainterPath &path, Qt::ItemSelectionMode mode) const

QList< QGraphicsItem * >	collidingItems (Qt::ItemSelectionMode mode) const

QGraphicsItem *	commonAncestorItem (const QGraphicsItem *other) const

QCursor	cursor () const

QVariant	data (int key) const

QTransform	deviceTransform (const QTransform &viewportTransform) const

qreal	effectiveOpacity () const

void	ensureVisible (const QRectF &rect, int xmargin, int ymargin)

void	ensureVisible (qreal x, qreal y, qreal w, qreal h, int xmargin, int ymargin)

bool	filtersChildEvents () const

GraphicsItemFlags	flags () const

QGraphicsItem *	focusItem () const

QGraphicsItem *	focusProxy () const

void	grabKeyboard ()

void	grabMouse ()

QGraphicsEffect *	graphicsEffect () const

QGraphicsItemGroup *	group () const

bool	handlesChildEvents () const

bool	hasCursor () const

bool	hasFocus () const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const

void	installSceneEventFilter (QGraphicsItem *filterItem)

bool	isActive () const

bool	isAncestorOf (const QGraphicsItem *child) const

bool	isBlockedByModalPanel (QGraphicsItem **blockingPanel) const

bool	isClipped () const

bool	isEnabled () const

bool	isObscured () const

bool	isObscured (const QRectF &rect) const

bool	isObscured (qreal x, qreal y, qreal w, qreal h) const

bool	isPanel () const

bool	isSelected () const

bool	isUnderMouse () const

bool	isVisible () const

bool	isVisibleTo (const QGraphicsItem *parent) const

bool	isWidget () const

bool	isWindow () const

QTransform	itemTransform (const QGraphicsItem other, bool ok) const

QPointF	mapFromItem (const QGraphicsItem *item, const QPointF &point) const

QPolygonF	mapFromItem (const QGraphicsItem *item, const QRectF &rect) const

QPolygonF	mapFromItem (const QGraphicsItem *item, const QPolygonF &polygon) const

QPainterPath	mapFromItem (const QGraphicsItem *item, const QPainterPath &path) const

QPointF	mapFromItem (const QGraphicsItem *item, qreal x, qreal y) const

QPolygonF	mapFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QPointF	mapFromParent (const QPointF &point) const

QPolygonF	mapFromParent (const QRectF &rect) const

QPolygonF	mapFromParent (const QPolygonF &polygon) const

QPainterPath	mapFromParent (const QPainterPath &path) const

QPointF	mapFromParent (qreal x, qreal y) const

QPolygonF	mapFromParent (qreal x, qreal y, qreal w, qreal h) const

QPolygonF	mapFromScene (const QPolygonF &polygon) const

QPointF	mapFromScene (const QPointF &point) const

QPolygonF	mapFromScene (const QRectF &rect) const

QPainterPath	mapFromScene (const QPainterPath &path) const

QPointF	mapFromScene (qreal x, qreal y) const

QPolygonF	mapFromScene (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromItem (const QGraphicsItem *item, const QRectF &rect) const

QRectF	mapRectFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromParent (const QRectF &rect) const

QRectF	mapRectFromParent (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromScene (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromScene (const QRectF &rect) const

QRectF	mapRectToItem (const QGraphicsItem *item, const QRectF &rect) const

QRectF	mapRectToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectToParent (const QRectF &rect) const

QRectF	mapRectToParent (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectToScene (const QRectF &rect) const

QRectF	mapRectToScene (qreal x, qreal y, qreal w, qreal h) const

QPointF	mapToItem (const QGraphicsItem *item, const QPointF &point) const

QPolygonF	mapToItem (const QGraphicsItem *item, const QRectF &rect) const

QPolygonF	mapToItem (const QGraphicsItem *item, const QPolygonF &polygon) const

QPainterPath	mapToItem (const QGraphicsItem *item, const QPainterPath &path) const

QPointF	mapToItem (const QGraphicsItem *item, qreal x, qreal y) const

QPolygonF	mapToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QPointF	mapToParent (const QPointF &point) const

QPolygonF	mapToParent (const QRectF &rect) const

QPainterPath	mapToParent (const QPainterPath &path) const

QPointF	mapToParent (qreal x, qreal y) const

QPolygonF	mapToParent (qreal x, qreal y, qreal w, qreal h) const

QPolygonF	mapToParent (const QPolygonF &polygon) const

QPolygonF	mapToScene (const QRectF &rect) const

QPainterPath	mapToScene (const QPainterPath &path) const

QPointF	mapToScene (qreal x, qreal y) const

QPolygonF	mapToScene (qreal x, qreal y, qreal w, qreal h) const

QPolygonF	mapToScene (const QPolygonF &polygon) const

QPointF	mapToScene (const QPointF &point) const

QMatrix	matrix () const

void	moveBy (qreal dx, qreal dy)

qreal	opacity () const

virtual void	paint (QPainter painter, const QStyleOptionGraphicsItem option, QWidget *widget)=0

QGraphicsItem *	panel () const

PanelModality	panelModality () const

QGraphicsItem *	parentItem () const

QGraphicsObject *	parentObject () const

QGraphicsWidget *	parentWidget () const

QPointF	pos () const

void	removeSceneEventFilter (QGraphicsItem *filterItem)

void	resetMatrix ()

void	resetTransform ()

void	rotate (qreal angle)

qreal	rotation () const

void	scale (qreal sx, qreal sy)

qreal	scale () const

QGraphicsScene *	scene () const

QRectF	sceneBoundingRect () const

QMatrix	sceneMatrix () const

QPointF	scenePos () const

QTransform	sceneTransform () const

void	scroll (qreal dx, qreal dy, const QRectF &rect)

void	setAcceptDrops (bool on)

void	setAcceptedMouseButtons (QFlags< Qt::MouseButton > buttons)

void	setAcceptHoverEvents (bool enabled)

void	setAcceptsHoverEvents (bool enabled)

void	setAcceptTouchEvents (bool enabled)

void	setActive (bool active)

void	setBoundingRegionGranularity (qreal granularity)

void	setCacheMode (CacheMode mode, const QSize &logicalCacheSize)

void	setCursor (const QCursor &cursor)

void	setData (int key, const QVariant &value)

void	setEnabled (bool enabled)

void	setFiltersChildEvents (bool enabled)

void	setFlag (GraphicsItemFlag flag, bool enabled)

void	setFlags (QFlags< QGraphicsItem::GraphicsItemFlag > flags)

void	setFocus (Qt::FocusReason focusReason)

void	setFocusProxy (QGraphicsItem *item)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setGroup (QGraphicsItemGroup *group)

void	setHandlesChildEvents (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setMatrix (const QMatrix &matrix, bool combine)

void	setOpacity (qreal opacity)

void	setPanelModality (PanelModality panelModality)

void	setParentItem (QGraphicsItem *newParent)

void	setPos (const QPointF &pos)

void	setPos (qreal x, qreal y)

void	setRotation (qreal angle)

void	setScale (qreal factor)

void	setSelected (bool selected)

void	setToolTip (const QString &toolTip)

void	setTransform (const QTransform &matrix, bool combine)

void	setTransformations (const QList< QGraphicsTransform * > &transformations)

void	setTransformOriginPoint (qreal x, qreal y)

void	setTransformOriginPoint (const QPointF &origin)

void	setVisible (bool visible)

void	setX (qreal x)

void	setY (qreal y)

void	setZValue (qreal z)

void	shear (qreal sh, qreal sv)

void	show ()

void	stackBefore (const QGraphicsItem *sibling)

QGraphicsObject *	toGraphicsObject ()

const QGraphicsObject *	toGraphicsObject () const

QString	toolTip () const

QGraphicsItem *	topLevelItem () const

QGraphicsWidget *	topLevelWidget () const

QTransform	transform () const

QList< QGraphicsTransform * >	transformations () const

QPointF	transformOriginPoint () const

void	translate (qreal dx, qreal dy)

void	ungrabKeyboard ()

void	ungrabMouse ()

void	unsetCursor ()

void	update (qreal x, qreal y, qreal width, qreal height)

void	update (const QRectF &rect)

QGraphicsWidget *	window () const

qreal	x () const

qreal	y () const

qreal	zValue () const

Additional Inherited Members
Public Types inherited from QgsComposerItem
enum	ItemPositionMode { UpperLeft, UpperMiddle, UpperRight, MiddleLeft, Middle, MiddleRight, LowerLeft, LowerMiddle, LowerRight }

enum	ItemType { ComposerItem = UserType + 100, ComposerArrow, ComposerItemGroup, ComposerLabel, ComposerLegend, ComposerMap, ComposerPaper, ComposerPicture, ComposerScaleBar, ComposerShape, ComposerPolygon, ComposerPolyline, ComposerTable, ComposerAttributeTable, ComposerTextTable, ComposerFrame }

enum	MouseMoveAction { MoveItem, ResizeUp, ResizeDown, ResizeLeft, ResizeRight, ResizeLeftUp, ResizeRightUp, ResizeLeftDown, ResizeRightDown, NoAction }
	Describes the action (move or resize in different directon) to be done during mouse move. More...

enum	ZoomMode { Zoom = 0, ZoomRecenter, ZoomToPoint, NoZoom }
	Modes for zooming item content. More...

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, MapLayers, MapStylePreset, 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 inherited from QgsComposerItem
virtual void	refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties, const QgsExpressionContext *context=nullptr) override
	Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More...

void	repaint () override

virtual void	setItemRotation (const double r, const bool adjustPosition=false)
	Sets the item rotation. More...

virtual void	setRotation (double r)
	Sets the item rotation. More...

Public Slots inherited from QgsComposerObject
virtual void	refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties, const QgsExpressionContext *context=nullptr)
	Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More...

virtual void	repaint ()
	Triggers a redraw for the item. More...

Signals inherited from QgsComposerItem
void	frameChanged ()
	Emitted if the item's frame style changes. More...

void	itemRotationChanged (double newRotation)
	Is emitted on item rotation change. More...

void	lockChanged ()
	Emitted if the item's lock status changes. More...

void	sizeChanged ()
	Emitted if the rectangle changes. More...

Signals inherited from QgsComposerObject
void	itemChanged ()
	Emitted when the item changes. More...

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QGraphicsItem
typedef	GraphicsItemFlags

Protected Member Functions inherited from QgsComposerItem
Q_DECL_DEPRECATED double	angle (QPointF p1, QPointF p2) const
	Returns angle of the line from p1 to p2 (clockwise, starting at N) More...

Q_DECL_DEPRECATED bool	cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const
	Calculates corner point after rotation and scaling. More...

Q_DECL_DEPRECATED bool	cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
	Calculates corner point after rotation and scaling. More...

void	deleteAlignItems ()

void	deleteHAlignSnapItem ()

void	deleteVAlignSnapItem ()

Q_DECL_DEPRECATED void	drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
	Draws arrowhead. More...

virtual void	drawBackground (QPainter *p)
	Draw background. More...

virtual void	drawFrame (QPainter *p)
	Draw black frame around item. More...

virtual void	drawSelectionBoxes (QPainter *p)
	Draws additional graphics on selected items. More...

QRectF	evalItemRect (const QRectF &newRect, const bool resizeOnly=false, const QgsExpressionContext *context=nullptr)
	Evaluates an item's bounding rect to consider data defined position and size of item and reference point. More...

QGraphicsLineItem *	hAlignSnapItem ()
	Return horizontal align snap item. More...

double	horizontalViewScaleFactor () const
	Returns the zoom factor of the graphics view. More...

Q_DECL_DEPRECATED bool	imageSizeConsideringRotation (double &width, double &height, double rotation) const
	Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation. More...

Q_DECL_DEPRECATED bool	imageSizeConsideringRotation (double &width, double &height) const
	Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation. More...

Q_DECL_DEPRECATED QRectF	largestRotatedRectWithinBounds (const QRectF &originalRect, const QRectF &boundsRect, double rotation) const
	Calculates the largest scaled version of originalRect which fits within boundsRect, when it is rotated by a specified amount. More...

Q_DECL_DEPRECATED double	lockSymbolSize () const
	Returns the size of the lock symbol depending on the composer zoom level and the item size. More...

double	rectHandlerBorderTolerance () const
	Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing. More...

Q_DECL_DEPRECATED void	rotate (double angle, double &x, double &y) const
	Rotates a point / vector. More...

bool	shouldDrawItem () const
	Returns whether the item should be drawn in the current context. More...

Q_DECL_DEPRECATED void	sizeChangedByRotation (double &width, double &height, double rotation)
	Calculates width / height of the bounding box of a rotated rectangle. More...

Q_DECL_DEPRECATED void	sizeChangedByRotation (double &width, double &height)
	Calculates width / height of the bounding box of a rotated rectangle. More...

QGraphicsLineItem *	vAlignSnapItem ()
	Return vertical align snap item. More...

Protected Member Functions inherited from QgsComposerObject
bool	dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue, const QgsExpressionContext &context=QgsExpressionContext()) const
	Evaluate a data defined property and return the calculated value. More...

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QGraphicsItem
virtual void	contextMenuEvent (QGraphicsSceneContextMenuEvent *event)

virtual void	dragEnterEvent (QGraphicsSceneDragDropEvent *event)

virtual void	dragLeaveEvent (QGraphicsSceneDragDropEvent *event)

virtual void	dragMoveEvent (QGraphicsSceneDragDropEvent *event)

virtual void	dropEvent (QGraphicsSceneDragDropEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

virtual void	focusOutEvent (QFocusEvent *event)

virtual void	hoverEnterEvent (QGraphicsSceneHoverEvent *event)

virtual void	hoverLeaveEvent (QGraphicsSceneHoverEvent *event)

virtual void	hoverMoveEvent (QGraphicsSceneHoverEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

virtual QVariant	itemChange (GraphicsItemChange change, const QVariant &value)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	mouseDoubleClickEvent (QGraphicsSceneMouseEvent *event)

virtual void	mouseMoveEvent (QGraphicsSceneMouseEvent *event)

virtual void	mousePressEvent (QGraphicsSceneMouseEvent *event)

virtual void	mouseReleaseEvent (QGraphicsSceneMouseEvent *event)

void	prepareGeometryChange ()

virtual bool	sceneEvent (QEvent *event)

virtual bool	sceneEventFilter (QGraphicsItem watched, QEvent event)

void	updateMicroFocus ()

virtual void	wheelEvent (QGraphicsSceneWheelEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Protected Attributes inherited from QgsComposerItem
bool	mBackground
	True if item background needs to be painted. More...

QColor	mBackgroundColor
	Background color. More...

QPainter::CompositionMode	mBlendMode
	Composition blend mode for item. More...

QGraphicsRectItem *	mBoundingResizeRectangle
	Rectangle used during move and resize actions. More...

int	mCurrentExportLayer
	The layer that needs to be exported. More...

QgsComposerItem::MouseMoveAction	mCurrentMouseMoveAction

QgsComposerEffect *	mEffect

bool	mEffectsEnabled

bool	mEvaluatedExcludeFromExports
	Temporary evaluated item exclusion. More...

double	mEvaluatedItemRotation
	Temporary evaluated item rotation in degrees, clockwise. More...

bool	mExcludeFromExports
	Whether item should be excluded in exports. More...

bool	mFrame
	True if item fram needs to be painted. More...

Qt::PenJoinStyle	mFrameJoinStyle
	Frame join style. More...

QGraphicsLineItem *	mHAlignSnapItem

bool	mIsGroupMember
	Whether or not this item is part of a group. More...

bool	mItemPositionLocked
	True if item position and size cannot be changed with mouse move. More...

double	mItemRotation
	Item rotation in degrees, clockwise. More...

QPointF	mLastMouseEventPos
	Position of the last mouse move event (in scene coordinates) More...

ItemPositionMode	mLastUsedPositionMode
	The item's position mode. More...

double	mLastValidViewScaleFactor
	Backup to restore item appearance if no view scale factor is available. More...

QPointF	mMouseMoveStartPos
	Start point of the last mouse move action (in scene coordinates) More...

bool	mRemovedFromComposition
	True if item has been removed from the composition. More...

int	mTransparency
	Item transparency. More...

QGraphicsLineItem *	mVAlignSnapItem

Protected Attributes inherited from QgsComposerObject
QgsComposition *	mComposition

QgsObjectCustomProperties	mCustomProperties
	Custom properties for object. More...

QMap< QgsComposerObject::DataDefinedProperty, QString >	mDataDefinedNames
	Map of data defined properties for the item to string name to use when exporting item to xml. More...

Properties inherited from QObject
	objectName

Detailed Description

Frame item for a composer multiframe item.

Definition at line 27 of file qgscomposerframe.h.

Constructor & Destructor Documentation

◆ QgsComposerFrame()

QgsComposerFrame::QgsComposerFrame	(	QgsComposition *	c,
		QgsComposerMultiFrame *	mf,
		qreal	x,
		qreal	y,
		qreal	width,
		qreal	height
	)

Definition at line 20 of file qgscomposerframe.cpp.

◆ ~QgsComposerFrame()

QgsComposerFrame::~QgsComposerFrame ( )

Definition at line 49 of file qgscomposerframe.cpp.

Member Function Documentation

◆ beginItemCommand()

void QgsComposerFrame::beginItemCommand ( const QString & text )

overridevirtual

Reimplemented from QgsComposerItem.

Definition at line 211 of file qgscomposerframe.cpp.

◆ createExpressionContext()

QgsExpressionContext * QgsComposerFrame::createExpressionContext ( ) const

overridevirtual

Creates an expression context relating to the item's current state.

The context includes scopes for global, project, composition, atlas and item properties.

Note: added in QGIS 2.12

Reimplemented from QgsComposerItem.

Definition at line 118 of file qgscomposerframe.cpp.

◆ displayName()

QString QgsComposerFrame::displayName ( ) const

overridevirtual

Get item display name.

This is the item's id if set, and if not, a user-friendly string identifying item type.

Returns: display name for item

See also: id; setId

Note: added in version 2.5

Reimplemented from QgsComposerItem.

Definition at line 131 of file qgscomposerframe.cpp.

◆ endItemCommand()

void QgsComposerFrame::endItemCommand ( )

overridevirtual

Reimplemented from QgsComposerItem.

Definition at line 219 of file qgscomposerframe.cpp.

◆ extent()

QRectF QgsComposerFrame::extent ( ) const

inline

Returns the visible portion of the multi frame's content which is shown in this frame.

Returns: extent of visible portion

Note: added in QGIS 2.5

See also: setContentSection

Definition at line 67 of file qgscomposerframe.h.

◆ hideBackgroundIfEmpty()

bool QgsComposerFrame::hideBackgroundIfEmpty ( ) const

inline

Returns whether the background and frame border should be hidden if this frame is empty.

Returns: true if background and border should be hidden if frame is empty

Note: added in QGIS 2.5

See also: setHideBackgroundIfEmpty

Definition at line 88 of file qgscomposerframe.h.

◆ hidePageIfEmpty()

bool QgsComposerFrame::hidePageIfEmpty ( ) const

inline

Returns whether the page should be hidden (ie, not included in composer exports) if this frame is empty.

Returns: true if page should be hidden if frame is empty

Note: added in QGIS 2.5

See also: setHidePageIfEmpty

Definition at line 74 of file qgscomposerframe.h.

◆ isEmpty()

bool QgsComposerFrame::isEmpty ( ) const

Returns whether the frame is empty.

Returns: true if frame is empty

Note: added in QGIS 2.5

See also: hidePageIfEmpty

Definition at line 100 of file qgscomposerframe.cpp.

◆ multiFrame()

QgsComposerMultiFrame* QgsComposerFrame::multiFrame ( ) const

inline

Returns the parent multiframe for the frame.

Returns: parent multiframe

Definition at line 46 of file qgscomposerframe.h.

◆ paint()

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

overridevirtual

Reimplemented from QGraphicsRectItem.

Definition at line 174 of file qgscomposerframe.cpp.

◆ readXML()

bool QgsComposerFrame::readXML	(	const QDomElement &	itemElem,
		const QDomDocument &	doc
	)

overridevirtual

Sets item state from DOM element.

Parameters

itemElem	is DOM node corresponding to item tag
doc	is DOM document

Reimplemented from QgsComposerObject.

Definition at line 67 of file qgscomposerframe.cpp.

◆ setContentSection()

void QgsComposerFrame::setContentSection ( const QRectF & section )

inline

Sets the visible part of the multiframe's content which is visible within this frame (relative to the total multiframe extent in mm).

Parameters

section visible portion of content

See also: extent

Definition at line 41 of file qgscomposerframe.h.

◆ setHideBackgroundIfEmpty()

void QgsComposerFrame::setHideBackgroundIfEmpty ( const bool hideBackgroundIfEmpty )

Sets whether the background and frame border should be hidden if this frame is empty.

Parameters

hideBackgroundIfEmpty set to true if background and border should be hidden if frame is empty

Note: added in QGIS 2.5

See also: hideBackgroundIfEmpty

Definition at line 89 of file qgscomposerframe.cpp.

◆ setHidePageIfEmpty()

void QgsComposerFrame::setHidePageIfEmpty ( const bool hidePageIfEmpty )

Sets whether the page should be hidden (ie, not included in composer exports) if this frame is empty.

Parameters

hidePageIfEmpty set to true if page should be hidden if frame is empty

Note: added in QGIS 2.5

See also: hidePageIfEmpty

Definition at line 84 of file qgscomposerframe.cpp.

◆ setSceneRect()

void QgsComposerFrame::setSceneRect ( const QRectF & rectangle )

overridevirtual

Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit.

Reimplemented from QgsComposerItem.

Definition at line 146 of file qgscomposerframe.cpp.

◆ type()

int QgsComposerFrame::type ( ) const

inlineoverridevirtual

Return correct graphics item type.

Reimplemented from QgsComposerItem.

Definition at line 59 of file qgscomposerframe.h.

◆ writeXML()

bool QgsComposerFrame::writeXML	(	QDomElement &	elem,
		QDomDocument &	doc
	)		const

overridevirtual

Stores item state in DOM element.

Parameters

elem	is DOM element corresponding to item tag
doc	is the DOM document

Reimplemented from QgsComposerObject.

Definition at line 53 of file qgscomposerframe.cpp.

The documentation for this class was generated from the following files:

/tmp/buildd/qgis-2.18.21+99unstable/src/core/composer/qgscomposerframe.h
/tmp/buildd/qgis-2.18.21+99unstable/src/core/composer/qgscomposerframe.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsComposerFrame()

◆ ~QgsComposerFrame()

Member Function Documentation

◆ beginItemCommand()

◆ createExpressionContext()

◆ displayName()

◆ endItemCommand()

◆ extent()

◆ hideBackgroundIfEmpty()

◆ hidePageIfEmpty()

◆ isEmpty()

◆ multiFrame()

◆ paint()

◆ readXML()

◆ setContentSection()

◆ setHideBackgroundIfEmpty()

◆ setHidePageIfEmpty()

◆ setSceneRect()

◆ type()

◆ writeXML()