File: qgslayoutitemgroup.sip.in

package info (click to toggle)
qgis 3.34.7%2Bdfsg-1~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 1,087,388 kB
  • sloc: cpp: 1,440,033; python: 234,418; xml: 23,096; perl: 3,499; sh: 3,364; ansic: 2,219; sql: 2,130; yacc: 1,063; lex: 577; javascript: 540; lisp: 411; makefile: 155
file content (100 lines) | stat: -rw-r--r-- 3,082 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/************************************************************************
 * 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(signature="appended")
A container for grouping several :py:class:`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
    ~QgsLayoutItemGroup();

    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;


    virtual QRectF rectWithFrame() 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   *
 ************************************************************************/