qgstablecell.h

Go to the documentation of this file.

/***************************************************************************
    qgstablecell.h
    --------------
    begin                : January 2020
    copyright            : (C) 2020 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 QGSTABLECELL_H
#define QGSTABLECELL_H
 
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgstextformat.h"
 
#include <QColor>
#include <QString>
#include <QVariant>
 
using namespace Qt::StringLiterals;
 
class QgsNumericFormat;
class QgsReadWriteContext;

class CORE_EXPORT QgsTableCell
{
  public:
    QgsTableCell( const QVariant &content = QVariant() );
 
    QgsTableCell( const QgsTableCell &other );
 
    ~QgsTableCell();
 
    QgsTableCell &operator=( const QgsTableCell &other );

    QVariant content() const { return mContent; }

    void setContent( const QVariant &content ) { mContent = content; }

    QColor backgroundColor() const { return mBackgroundColor; }

    void setBackgroundColor( const QColor &color ) { mBackgroundColor = color; }

    QColor foregroundColor() const { return mForegroundColor; }

    void setForegroundColor( const QColor &color ) { mForegroundColor = color; }

    QgsTextFormat textFormat() const { return mTextFormat; }

    void setTextFormat( const QgsTextFormat &format ) { mTextFormat = format; }

    const QgsNumericFormat *numericFormat() const;

    void setNumericFormat( QgsNumericFormat *format SIP_TRANSFER );

    Qt::Alignment horizontalAlignment() const;

    void setHorizontalAlignment( Qt::Alignment alignment );

    Qt::Alignment verticalAlignment() const;

    void setVerticalAlignment( Qt::Alignment alignment );

    void setSpan( int rowSpan, int columnSpan );

    int rowSpan() const { return mRowSpan; }

    int columnSpan() const { return mColumnSpan; }

    QVariantMap properties( const QgsReadWriteContext &context ) const;

    void setProperties( const QVariantMap &properties, const QgsReadWriteContext &context );
 
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsTableCell: %1>"_s.arg( sipCpp->content().toString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
 
    QVariant mContent;
    QColor mBackgroundColor;
    QColor mForegroundColor;
    QgsTextFormat mTextFormat;
    std::unique_ptr< QgsNumericFormat > mFormat;
 
    Qt::Alignment mHAlign = Qt::AlignLeft;
    Qt::Alignment mVAlign = Qt::AlignVCenter;
 
    int mRowSpan = 1;
    int mColumnSpan = 1;
};

typedef QVector<QgsTableCell> QgsTableRow;
 
#ifndef SIP_RUN

typedef QVector<QgsTableRow> QgsTableContents;
#else

typedef QVector<QVector<QgsTableCell>> QgsTableContents;
#endif
 
 
#endif // QGSTABLECELL_H