QGIS/python/core/auto_generated/layout/qgslayoutaligner.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

90 lines
2.6 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutaligner.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py 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.
%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.py again *
************************************************************************/