columns.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_GUI_MODELS_COLUMNS_H
#define SWIFT_GUI_MODELS_COLUMNS_H
 
#include <QList>
#include <QObject>
#include <QSharedPointer>
#include <QString>
#include <QtGlobal>
 
#include "gui/models/columnformatters.h"
#include "gui/swiftguiexport.h"
#include "misc/propertyindex.h"
#include "misc/variant.h"
 
class QModelIndex;
 
namespace swift::gui::models
{
    class SWIFT_GUI_EXPORT CColumn
    {
    public:
        CColumn(const QString &headerName, const swift::misc::CPropertyIndex &propertyIndex,
                CDefaultFormatter *formatter, bool editable = false)
            : CColumn(headerName, "", propertyIndex, formatter, editable)
        {}
 
        CColumn(const QString &headerName, const QString &toolTip, const swift::misc::CPropertyIndex &propertyIndex,
                CDefaultFormatter *formatter, bool editable = false);
 
        CColumn(const QString &toolTip, const swift::misc::CPropertyIndex &propertyIndex);
 
        CColumn(const swift::misc::CPropertyIndex &propertyIndex);
 
        bool hasAlignment() const { return (!m_formatter.isNull() && m_formatter->hasAlignment()); }
 
        bool isEditable() const { return m_editable; }
 
        void setEditable(bool editable) { m_editable = editable; }
 
        bool isSortable() const { return m_sortable; }
 
        void setSortable(bool sortable) { m_sortable = sortable; }
 
        swift::misc::CPropertyIndex getSortPropertyIndex() const { return m_sortPropertyIndex; }
 
        bool hasSortPropertyIndex() const;
 
        void setSortPropertyIndex(const swift::misc::CPropertyIndex &propertyIndex);
 
        void setFormatter(CDefaultFormatter *formatter)
        {
            Q_ASSERT(formatter);
            m_formatter.reset(formatter);
        }
 
        const CDefaultFormatter *getFormatter() const;
 
        swift::misc::CVariant getAlignment() const;
 
        const QString &getColumnName() const { return m_columnName; }
 
        const QString &getColumnToolTip() const { return m_columnToolTip; }
 
        const swift::misc::CPropertyIndex &getPropertyIndex() const { return m_propertyIndex; }
 
        void setTranslationContext(const QString &translationContext) { m_translationContext = translationContext; }
 
        int getWidthPercentage() const { return m_widthPercentage; }
 
        bool hasWidthPercentage() const { return m_widthPercentage > 0; }
 
        void setWidthPercentage(int width) { m_widthPercentage = width; }
 
        bool isIncognito() const { return m_incognito; }
 
        void setIncognito(bool incognito) { m_incognito = incognito; }
 
        static CColumn standardValueObject(const QString &headerName, const swift::misc::CPropertyIndex &propertyIndex,
                                           int alignment = CDefaultFormatter::alignDefault());
 
        static CColumn standardValueObject(const QString &headerName, const QString &toolTip,
                                           const swift::misc::CPropertyIndex &propertyIndex,
                                           int alignment = CDefaultFormatter::alignDefault());
 
        static CColumn standardString(const QString &headerName, const swift::misc::CPropertyIndex &propertyIndex,
                                      int alignment = CDefaultFormatter::alignDefault());
 
        static CColumn standardString(const QString &headerName, const QString &toolTip,
                                      const swift::misc::CPropertyIndex &propertyIndex,
                                      int alignment = CDefaultFormatter::alignDefault());
 
        static CColumn orderColumn(
            const swift::misc::CPropertyIndex &propertyIndex = swift::misc::CPropertyIndexRef::GlobalIndexIOrderable,
            int alignment = CDefaultFormatter::alignRightVCenter());
 
        static CColumn standardInteger(const QString &headerName, const QString &toolTip,
                                       const swift::misc::CPropertyIndex &propertyIndex,
                                       int alignment = CDefaultFormatter::alignRightVCenter());
 
        static CColumn emptyColumn();
 
    private:
        QString m_translationContext;
        QString m_columnName;
        QString m_columnToolTip;
        int m_widthPercentage = -1;
        QSharedPointer<CDefaultFormatter> m_formatter; 
        swift::misc::CPropertyIndex m_propertyIndex; 
        swift::misc::CPropertyIndex m_sortPropertyIndex; 
 
        static const CIncognitoFormatter *incongitoFormatter();
 
        bool m_editable = false;
        bool m_sortable = true;
        bool m_incognito = false;
    };
 
    class SWIFT_GUI_EXPORT CColumns : public QObject
    {
        Q_OBJECT
 
    public:
        CColumns(const QString &translationContext, QObject *parent = nullptr);
 
        void addColumn(const CColumn &column);
 
        void addColumnIncognito(const CColumn &column);
 
        QString propertyIndexToColumnName(const swift::misc::CPropertyIndex &propertyIndex, bool i18n = false) const;
 
        QString columnToName(int column, bool i18n = false) const;
 
        swift::misc::CPropertyIndex columnToPropertyIndex(int column) const;
 
        swift::misc::CPropertyIndex columnToSortPropertyIndex(int column) const;
 
        int propertyIndexToColumn(const swift::misc::CPropertyIndex &propertyIndex) const;
 
        int nameToPropertyIndex(const QString &name) const;
 
        int size() const;
 
        bool hasAlignment(const QModelIndex &index) const;
 
        bool isEditable(const QModelIndex &index) const;
 
        bool isEditable(int column) const;
 
        bool isSortable(const QModelIndex &index) const;
 
        bool isSortable(int column) const;
 
        bool isValidColumn(const QModelIndex &index) const;
 
        bool isValidColumn(int column) const;
 
        swift::misc::CVariant getAlignment(const QModelIndex &index) const;
 
        const CDefaultFormatter *getFormatter(const QModelIndex &index) const;
 
        const CColumn &at(int columnNumber) const { return m_columns.at(columnNumber); }
 
        void clear() { m_columns.clear(); }
 
        void setColumns(const QList<CColumn> &columns) { m_columns = columns; }
        void setColumns(const CColumns &columns) { m_columns = columns.m_columns; }
 
        const QList<CColumn> &columns() const { return m_columns; }
 
        bool hasAnyWidthPercentage() const;
 
        void setWidthPercentages(const QList<int> &percentages);
 
        QList<int> calculateWidths(int totalWidth) const;
 
        void insertEmptyColumn();
 
        bool endsWithEmptyColumn() const;
 
    private:
        QList<CColumn> m_columns; 
        QString m_translationContext; 
    };
} // namespace swift::gui::models
 
#endif // SWIFT_GUI_MODELS_COLUMNS_H