qgslayoutaligner.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayoutaligner.h
                             ------------------
    begin                : October 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSLAYOUTALIGNER_H
#define QGSLAYOUTALIGNER_H

#include "qgis_core.h"
#include <QList>
#include <QRectF>

class QgsLayoutItem;
class QgsLayout;

class CORE_EXPORT QgsLayoutAligner
{

  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 );

    static void distributeItems( QgsLayout *layout, const QList< QgsLayoutItem * > &items, Distribution distribution );

    static void resizeItems( QgsLayout *layout, const QList< QgsLayoutItem * > &items, Resize resize );

  private:

    static QRectF boundingRectOfItems( const QList< QgsLayoutItem * > &items );

    static QString undoText( Alignment alignment );
    static QString undoText( Distribution distribution );
    static QString undoText( Resize resize );

    static void distributeEquispacedItems( QgsLayout *layout, const QList<QgsLayoutItem *> &items, QgsLayoutAligner::Distribution distribution );


};

#endif //QGSLAYOUTALIGNER_H