File: qgslayoutaligner.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 (87 lines) | stat: -rw-r--r-- 2,720 bytes parent folder | download | duplicates (5)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/layout/qgslayoutaligner.h                                   *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/



class QgsLayoutAligner
{
%Docstring(signature="appended")
Handles aligning and distributing sets of layout items.

:py:class:`QgsLayoutAligner` contains methods for automatically aligning and distributing
sets of layout items, e.g. aligning a group of items to top or left sides.

.. versionadded:: 3.0
%End

%TypeHeaderCode
#include "qgslayoutaligner.h"
%End
  public:

    enum Alignment
    {
      AlignLeft,
      AlignHCenter,
      AlignRight,
      AlignTop,
      AlignVCenter,
      AlignBottom,
    };

    enum Distribution
    {
      DistributeLeft,
      DistributeHCenter,
      DistributeHSpace,
      DistributeRight,
      DistributeTop,
      DistributeVCenter,
      DistributeVSpace,
      DistributeBottom,
    };

    enum Resize
    {
      ResizeNarrowest,
      ResizeWidest,
      ResizeShortest,
      ResizeTallest,
      ResizeToSquare,
    };

    static void alignItems( QgsLayout *layout, const QList< QgsLayoutItem * > &items, Alignment alignment );
%Docstring
Aligns a set of ``items`` from a ``layout`` in place.

The ``alignment`` argument specifies the method to use when aligning the items.
%End

    static void distributeItems( QgsLayout *layout, const QList< QgsLayoutItem * > &items, Distribution distribution );
%Docstring
Distributes a set of ``items`` from a ``layout`` in place.

The ``distribution`` argument specifies the method to use when distributing the items.
%End

    static void resizeItems( QgsLayout *layout, const QList< QgsLayoutItem * > &items, Resize resize );
%Docstring
Resizes a set of ``items`` from a ``layout`` in place.

The ``resize`` argument specifies the method to use when resizing the items.
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/layout/qgslayoutaligner.h                                   *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/