QGIS API Documentation
3.0.2-Girona (307d082)
|
Item representing the paper in a layout. More...
#include <qgslayoutitempage.h>
Public Slots | |
void | redraw () override |
Public Slots inherited from QgsLayoutItem | |
virtual void | invalidateCache () |
Forces a deferred update of any cached image the item uses. More... | |
virtual void | redraw () |
Triggers a redraw (update) of the item. More... | |
void | refresh () override |
Refreshes the item, causing a recalculation of any property overrides and recalculation of its position and size. More... | |
virtual void | refreshDataDefinedProperty (const QgsLayoutObject::DataDefinedProperty property=QgsLayoutObject::AllProperties) |
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 | rotateItem (const double angle, const QPointF &transformOrigin) |
Rotates the item by a specified angle in degrees clockwise around a specified reference point. More... | |
virtual void | setItemRotation (double rotation, bool adjustPosition=true) |
Sets the layout item's rotation, in degrees clockwise. More... | |
Public Slots inherited from QgsLayoutObject | |
virtual void | refresh () |
Refreshes the object, causing a recalculation of any property overrides. More... | |
Public Member Functions | |
QgsLayoutItemPage (QgsLayout *layout) | |
Constructor for QgsLayoutItemPage, with the specified parent layout. More... | |
void | attemptResize (const QgsLayoutSize &size, bool includesFrame=false) override |
Attempts to resize the item to a specified target size. More... | |
QRectF | boundingRect () const override |
QgsAbstractLayoutUndoCommand * | createCommand (const QString &text, int id, QUndoCommand *parent=nullptr) override |
Creates a new layout undo command with the specified text and parent. More... | |
Orientation | orientation () const |
Returns the page orientiation. More... | |
QgsLayoutSize | pageSize () const |
Returns the size of the page. More... | |
void | setPageSize (const QgsLayoutSize &size) |
Sets the size of the page. More... | |
bool | setPageSize (const QString &size, Orientation orientation=Portrait) |
Sets the page size to a known page size, e.g. More... | |
int | type () const override |
Public Member Functions inherited from QgsLayoutItem | |
QgsLayoutItem (QgsLayout *layout, bool manageZValue=true) | |
Constructor for QgsLayoutItem, with the specified parent layout. More... | |
~QgsLayoutItem () override | |
virtual void | attemptMove (const QgsLayoutPoint &point, bool useReferencePoint=true, bool includesFrame=false, int page=-1) |
Attempts to move the item to a specified point. More... | |
void | attemptMoveBy (double deltaX, double deltaY) |
Attempts to shift the item's position by a specified deltaX and deltaY, in layout units. More... | |
void | attemptSetSceneRect (const QRectF &rect, bool includesFrame=false) |
Attempts to update the item's position and size to match the passed rect in layout coordinates. More... | |
QColor | backgroundColor () const |
Returns the background color for this item. More... | |
void | beginCommand (const QString &commandText, UndoCommand command=UndoNone) |
Starts new undo command for this item. More... | |
QPainter::CompositionMode | blendMode () const |
Returns the item's composition blending mode. More... | |
void | cancelCommand () |
Cancels the current item command and discards it. More... | |
virtual void | cleanup () |
Called just before a batch of items are deleted, allowing them to run cleanup tasks. More... | |
virtual bool | containsAdvancedEffects () const |
Returns true if the item contains contents with blend modes or transparency effects which can only be reproduced by rastering the item. More... | |
QgsExpressionContext | createExpressionContext () const override |
This method needs to be reimplemented in all classes which implement this interface and return an expression context. More... | |
virtual QString | displayName () const |
Get item display name. More... | |
void | endCommand () |
Completes the current item command and push it onto the layout's 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 |
Returns whether the item should be excluded from layout exports and prints. More... | |
virtual void | finalizeRestoreFromXml () |
Called after all pending items have been restored from XML. More... | |
virtual QgsLayoutSize | fixedSize () const |
Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized. More... | |
bool | frameEnabled () const |
Returns true if the item includes a frame. More... | |
Qt::PenJoinStyle | frameJoinStyle () const |
Returns the join style used for drawing the item's frame. More... | |
QColor | frameStrokeColor () const |
Returns the frame's stroke color. More... | |
QgsLayoutMeasurement | frameStrokeWidth () const |
Returns the frame's stroke width. More... | |
bool | hasBackground () const |
Returns true if the item has a background. More... | |
virtual QIcon | icon () const |
Returns the item's icon. More... | |
QString | id () const |
Returns the item's ID name. More... | |
bool | isGroupMember () const |
Returns true if the item is part of a QgsLayoutItemGroup group. More... | |
bool | isLocked () const |
Returns true if the item is locked, and cannot be interacted with using the mouse. More... | |
double | itemOpacity () const |
Returns the item's opacity. More... | |
double | itemRotation () const |
Returns the current rotation for the item, in degrees clockwise. More... | |
virtual QgsLayoutSize | minimumSize () const |
Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely resized. More... | |
virtual void | moveContent (double dx, double dy) |
Moves the content of the item, by a specified dx and dy in layout units. More... | |
virtual int | numberExportLayers () const |
Returns the number of layers that this item requires for exporting during layered exports (e.g. More... | |
int | page () const |
Returns the page the item is currently on, with the first page returning 0. More... | |
QPointF | pagePos () const |
Returns the item's position (in layout units) relative to the top left corner of its current page. More... | |
QgsLayoutPoint | pagePositionWithUnits () const |
Returns the item's position (in item units) relative to the top left corner of its current page. More... | |
void | paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) override |
Handles preparing a paint surface for the layout item and painting the item's content. More... | |
QgsLayoutItemGroup * | parentGroup () const |
Returns the item's parent group, if the item is part of a QgsLayoutItemGroup group. More... | |
QgsLayoutPoint | positionWithUnits () const |
Returns the item's current position, including units. More... | |
bool | readXml (const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context) |
Sets the item state from a DOM element. More... | |
virtual QRectF | rectWithFrame () const |
Returns the item's rectangular bounds, including any bleed caused by the item's frame. More... | |
ReferencePoint | referencePoint () const |
Returns the reference point for positioning of the layout item. More... | |
virtual bool | requiresRasterization () const |
Returns true if the item is drawn in such a way that forces the whole layout to be rasterized when exporting to vector formats. More... | |
void | setBackgroundColor (const QColor &color) |
Sets the background color for this item. More... | |
void | setBackgroundEnabled (bool drawBackground) |
Sets whether this item has a background drawn under it or not. More... | |
void | setBlendMode (const QPainter::CompositionMode mode) |
Sets the item's composition blending mode. More... | |
void | setExcludeFromExports (bool exclude) |
Sets whether the item should be excluded from layout exports and prints. More... | |
virtual void | setFrameEnabled (bool drawFrame) |
Sets whether this item has a frame drawn around it or not. More... | |
void | setFrameJoinStyle (const Qt::PenJoinStyle style) |
Sets the join style used when drawing the item's frame. More... | |
void | setFrameStrokeColor (const QColor &color) |
Sets the frame stroke color. More... | |
virtual void | setFrameStrokeWidth (const QgsLayoutMeasurement &width) |
Sets the frame stroke width. More... | |
virtual void | setId (const QString &id) |
Set the item's id name. More... | |
void | setItemOpacity (double opacity) |
Sets the item's opacity. More... | |
void | setLocked (const bool locked) |
Sets whether the item is locked, preventing mouse interactions with the item. More... | |
virtual void | setMoveContentPreviewOffset (double dx, double dy) |
Sets temporary offset for the item, by a specified dx and dy in layout units. More... | |
void | setParentGroup (QgsLayoutItemGroup *group) |
Sets the item's parent group. More... | |
void | setReferencePoint (const ReferencePoint &point) |
Sets the reference point for positioning of the layout item. More... | |
virtual void | setSelected (bool selected) |
Sets whether the item should be selected. More... | |
virtual void | setVisibility (const bool visible) |
Sets whether the item is visible. More... | |
bool | shouldDrawItem () const |
Returns whether the item should be drawn in the current context. More... | |
QgsLayoutSize | sizeWithUnits () const |
Returns the item's current size, including units. More... | |
int | type () const override |
Returns a unique graphics item type identifier. More... | |
virtual QString | uuid () const |
Returns the item identification string. More... | |
bool | writeXml (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores the item state in a DOM element. More... | |
virtual void | zoomContent (double factor, QPointF point) |
Zooms content of item. More... | |
Public Member Functions inherited from QgsLayoutObject | |
QgsLayoutObject (QgsLayout *layout) | |
Constructor for QgsLayoutObject, with the specified parent layout. More... | |
QgsExpressionContext | createExpressionContext () const override |
Creates an expression context relating to the objects' current state. More... | |
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... | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the object's property collection, used for data defined overrides. More... | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the object's property collection, used for data defined overrides. More... | |
const QgsLayout * | layout () const |
Returns the layout the object is attached to. More... | |
QgsLayout * | layout () |
Returns the layout the object is attached to. 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 | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the objects's property collection, used for data defined overrides. More... | |
Public Member Functions inherited from QgsExpressionContextGenerator | |
virtual | ~QgsExpressionContextGenerator ()=default |
Public Member Functions inherited from QgsLayoutUndoObjectInterface | |
virtual | ~QgsLayoutUndoObjectInterface ()=default |
Destructor for QgsLayoutUndoObjectInterface. More... | |
Static Public Member Functions | |
static QgsLayoutItemPage * | create (QgsLayout *layout) |
Returns a new page item for the specified layout. More... | |
static QgsLayoutItemPage::Orientation | decodePageOrientation (const QString &string, bool *ok=nullptr) |
Decodes a string representing a page orientation. More... | |
Static Public Member Functions inherited from QgsLayoutObject | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the layout object property definitions. More... | |
Protected Member Functions | |
void | draw (QgsLayoutItemRenderContext &context) override |
Draws the item's contents using the specified item render context. More... | |
void | drawBackground (QgsRenderContext &context) override |
Draws the background for the item. More... | |
void | drawFrame (QgsRenderContext &context) override |
Draws the frame around the item. More... | |
Protected Member Functions inherited from QgsLayoutItem | |
QPointF | adjustPointForReferencePosition (const QPointF &point, const QSizeF &size, const ReferencePoint &reference) const |
Adjusts the specified point at which a reference position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position. More... | |
QgsLayoutSize | applyDataDefinedSize (const QgsLayoutSize &size) |
Applies any present data defined size overrides to the specified layout size. More... | |
virtual QSizeF | applyItemSizeConstraint (const QSizeF &targetSize) |
Applies any item-specific size constraint handling to a given targetSize in layout units. More... | |
virtual void | drawDebugRect (QPainter *painter) |
Draws a debugging rectangle of the item's current bounds within the specified painter. More... | |
QPointF | positionAtReferencePoint (const ReferencePoint &reference) const |
Returns the current position (in layout units) of a reference point for the item. More... | |
virtual bool | readPropertiesFromElement (const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) |
Sets item state from a DOM element. More... | |
void | refreshBackgroundColor (bool updateItem=true) |
Refresh item's background color, considering data defined colors. More... | |
void | refreshBlendMode () |
Refresh item's blend mode, considering data defined blend mode. More... | |
void | refreshFrame (bool updateItem=true) |
Refresh item's frame, considering data defined colors and frame size. More... | |
void | refreshItemPosition () |
Refreshes an item's position by rechecking it against any possible overrides such as data defined positioning. More... | |
void | refreshItemRotation (QPointF *origin=nullptr) |
Refreshes an item's rotation by rechecking it against any possible overrides such as data defined rotation. More... | |
void | refreshItemSize () |
Refreshes an item's size by rechecking it against any possible item fixed or minimum sizes. More... | |
void | refreshOpacity (bool updateItem=true) |
Refresh item's opacity, considering data defined opacity. More... | |
virtual void | setFixedSize (const QgsLayoutSize &size) |
Sets a fixed size for the layout item, which prevents it from being freely resized. More... | |
virtual void | setMinimumSize (const QgsLayoutSize &size) |
Sets the minimum allowed size for the layout item. More... | |
QgsLayoutPoint | topLeftToReferencePoint (const QgsLayoutPoint &point) const |
Returns the position for the reference point of the item, if the top-left of the item was placed at the specified point. More... | |
virtual bool | writePropertiesToElement (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores item state within an XML DOM element. More... | |
Protected Member Functions inherited from QgsLayoutObject | |
bool | readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context) |
Sets object properties from a DOM element. More... | |
bool | writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores object properties within an XML DOM element. More... | |
Friends | |
class | TestQgsLayoutPage |
Additional Inherited Members | |
Signals inherited from QgsLayoutItem | |
void | frameChanged () |
Emitted if the item's frame style changes. More... | |
void | lockChanged () |
Emitted if the item's lock status changes. More... | |
void | rotationChanged (double newRotation) |
Emitted on item rotation change. More... | |
void | sizePositionChanged () |
Emitted when the item's size or position changes. More... | |
Signals inherited from QgsLayoutObject | |
void | changed () |
Emitted when the object's properties change. More... | |
Protected Attributes inherited from QgsLayoutObject | |
QgsObjectCustomProperties | mCustomProperties |
Custom properties for object. More... | |
QgsPropertyCollection | mDataDefinedProperties |
QPointer< QgsLayout > | mLayout |
Properties inherited from QgsLayoutItem | |
bool | locked |
Item representing the paper in a layout.
Definition at line 54 of file qgslayoutitempage.h.
Page orientiation.
Enumerator | |
---|---|
Portrait | Portrait orientation. |
Landscape | Landscape orientation. |
Definition at line 62 of file qgslayoutitempage.h.
Page item undo commands, used for collapsing undo commands.
Enumerator | |
---|---|
UndoPageSymbol | Layout page symbol change. |
Definition at line 69 of file qgslayoutitempage.h.
|
explicit |
Constructor for QgsLayoutItemPage, with the specified parent layout.
Definition at line 28 of file qgslayoutitempage.cpp.
|
overridevirtual |
Attempts to resize the item to a specified target size.
Note that the final size of the item may not match the specified target size, as items with a fixed or minimum size will place restrictions on the allowed item size. Data defined item size overrides will also override the specified target size.
If includesFrame is true, then the size specified by size includes the item's frame.
Reimplemented from QgsLayoutItem.
Definition at line 138 of file qgslayoutitempage.cpp.
|
override |
Definition at line 127 of file qgslayoutitempage.cpp.
|
static |
Returns a new page item for the specified layout.
The caller takes responsibility for deleting the returned object.
Definition at line 49 of file qgslayoutitempage.cpp.
|
overridevirtual |
Creates a new layout undo command with the specified text and parent.
The id argument can be used to specify an id number for the source event - this is used to determine whether QUndoCommand command compression can apply to the command.
Reimplemented from QgsLayoutItem.
Definition at line 173 of file qgslayoutitempage.cpp.
|
static |
Decodes a string representing a page orientation.
If specified, ok will be set to true if string could be successfully interpreted as a page orientation.
Definition at line 106 of file qgslayoutitempage.cpp.
|
overrideprotectedvirtual |
Draws the item's contents using the specified item render context.
Note that the context's painter has been scaled so that painter units are pixels. Use the QgsRenderContext methods to convert from millimeters or other units to the painter's units.
Implements QgsLayoutItem.
Definition at line 184 of file qgslayoutitempage.cpp.
|
overrideprotectedvirtual |
Draws the background for the item.
Reimplemented from QgsLayoutItem.
Definition at line 250 of file qgslayoutitempage.cpp.
|
overrideprotectedvirtual |
Draws the frame around the item.
Reimplemented from QgsLayoutItem.
Definition at line 247 of file qgslayoutitempage.cpp.
QgsLayoutItemPage::Orientation QgsLayoutItemPage::orientation | ( | ) | const |
Returns the page orientiation.
Definition at line 98 of file qgslayoutitempage.cpp.
QgsLayoutSize QgsLayoutItemPage::pageSize | ( | ) | const |
Returns the size of the page.
Definition at line 93 of file qgslayoutitempage.cpp.
|
overrideslot |
Definition at line 178 of file qgslayoutitempage.cpp.
void QgsLayoutItemPage::setPageSize | ( | const QgsLayoutSize & | size | ) |
bool QgsLayoutItemPage::setPageSize | ( | const QString & | size, |
Orientation | orientation = Portrait |
||
) |
Sets the page size to a known page size, e.g.
"A4" and orientation. The known page sizes are managed by QgsPageSizeRegistry. Valid page sizes can be retrieved via QgsPageSizeRegistry::entries(). The function returns true if size was a valid page size and the page size was changed. If false is returned then size could not be matched to a known page size.
Definition at line 64 of file qgslayoutitempage.cpp.
|
override |
Definition at line 54 of file qgslayoutitempage.cpp.
|
friend |
Definition at line 145 of file qgslayoutitempage.h.