QGIS/python/core/auto_generated/layout/qgslayoutitemgroup.sip.in
Nyall Dawson 208beb7f8c [layouts] Improve logic of splitting layouts into separate layers when
exporting to a multi-layer format

Now, items are either
- placed onto the same layer as other items (simple items like labels, lines, pictures)
- placed onto the same layer as only other items of equal types (semi-complex items like scalebars or pages)
- placed onto their own unique layers (complex items like legends, maps)

Plus lots of tests covering this, where previously there was few
2019-08-12 16:12:03 +10:00

96 lines
2.9 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutitemgroup.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLayoutItemGroup: QgsLayoutItem
{
%Docstring
A container for grouping several QgsLayoutItems.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgslayoutitemgroup.h"
%End
public:
explicit QgsLayoutItemGroup( QgsLayout *layout );
%Docstring
Constructor for QgsLayoutItemGroup, belonging to the specified ``layout``.
%End
virtual void cleanup();
virtual int type() const;
virtual QString displayName() const;
static QgsLayoutItemGroup *create( QgsLayout *layout ) /Factory/;
%Docstring
Returns a new group item for the specified ``layout``.
The caller takes responsibility for deleting the returned object.
%End
void addItem( QgsLayoutItem *item /Transfer/ );
%Docstring
Adds an ``item`` to the group. Ownership of the item
is transferred to the group.
%End
void removeItems();
%Docstring
Removes all items from the group (but does not delete them).
Items remain in the scene but are no longer grouped together
%End
QList<QgsLayoutItem *> items() const;
%Docstring
Returns a list of items contained by the group.
%End
virtual void setVisibility( bool visible );
virtual void attemptMove( const QgsLayoutPoint &point, bool useReferencePoint = true, bool includesFrame = false, int page = -1 );
virtual void attemptResize( const QgsLayoutSize &size, bool includesFrame = false );
virtual void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget );
virtual void finalizeRestoreFromXml();
virtual ExportLayerBehavior exportLayerBehavior() const;
protected:
virtual void draw( QgsLayoutItemRenderContext &context );
virtual bool writePropertiesToElement( QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context ) const;
virtual bool readPropertiesFromElement( const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutitemgroup.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/