QGIS/python/core/layout/qgslayoutaligner.sip

/************************************************************************
 * 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
 Handles aligning and distributing sets of layout items.

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,
      DistributeRight,
      DistributeTop,
      DistributeVCenter,
      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   *
 ************************************************************************/