qgslayouttablecolumn.h

Go to the documentation of this file.

/***************************************************************************
                        QgsLayoutTableColumn.h
                         ------------------
    begin                : November 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 QGSLAYOUTTABLECOLUMN_H
#define QGSLAYOUTTABLECOLUMN_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QColor>
#include <QDomDocument>
#include <QDomElement>
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsLayoutTableColumn
{
  public:
    QgsLayoutTableColumn( const QString &heading = QString() );

    bool writeXml( QDomElement &columnElem, QDomDocument &doc ) const;

    bool readXml( const QDomElement &columnElem );

    double width() const { return mWidth; }

    void setWidth( const double width ) { mWidth = width; }

    QString heading() const { return mHeading; }

    void setHeading( const QString &heading ) { mHeading = heading; }

    Qt::AlignmentFlag hAlignment() const { return mHAlignment; }

    void setHAlignment( Qt::AlignmentFlag alignment ) { mHAlignment = alignment; }

    Qt::AlignmentFlag vAlignment() const { return mVAlignment; }

    void setVAlignment( Qt::AlignmentFlag alignment ) { mVAlignment = alignment; }

    QString attribute() const { return mAttribute; }

    void setAttribute( const QString &attribute ) { mAttribute = attribute; }

    Qt::SortOrder sortOrder() const { return mSortOrder; }

    void setSortOrder( Qt::SortOrder order ) { mSortOrder = order; }

    Q_DECL_DEPRECATED int sortByRank() const SIP_DEPRECATED { return mSortByRank; }

    Q_DECL_DEPRECATED void setSortByRank( int rank ) SIP_DEPRECATED { mSortByRank = rank; }

    Q_DECL_DEPRECATED QgsLayoutTableColumn *clone() SIP_DEPRECATED SIP_FACTORY { return new QgsLayoutTableColumn( *this ); }
 
    bool operator==( const QgsLayoutTableColumn &other ) const
    {
      return mHeading == other.mHeading
             && mAttribute == other.mAttribute
             && mSortByRank == other.mSortByRank
             && mSortOrder == other.mSortOrder
             && mWidth == other.mWidth
             && mHAlignment == other.mHAlignment
             && mVAlignment == other.mVAlignment;
    }
 
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str;
    if ( sipCpp->heading() != sipCpp->attribute() && !sipCpp->heading().isEmpty() )
      str = u"<QgsLayoutTableColumn: %1 (\"%2\")>"_s.arg( sipCpp->attribute(), sipCpp->heading() );
    else
      str = u"<QgsLayoutTableColumn: %1>"_s.arg( sipCpp->attribute() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
 
    QString mHeading;
    QString mAttribute;
    int mSortByRank = 0;
    Qt::SortOrder mSortOrder = Qt::AscendingOrder;
    double mWidth = 0.0;
    QColor mBackgroundColor = Qt::transparent; //currently unused
    Qt::AlignmentFlag mHAlignment = Qt::AlignLeft;
    Qt::AlignmentFlag mVAlignment = Qt::AlignVCenter;
 
    friend class QgsCompositionConverter;
};
#endif //QGSLAYOUTTABLECOLUMN_H