column_data.h

#pragma once
 
// Qt headers
#include <QModelIndex> // TODO This could be forward-declared if another Qt source is included here
class QSize;
#include <vector>
 
namespace ehm_dal::column_data {
 
class Column;
 
// --- Column index data container --- //
class ColumnData
{
public:
    // Settings
    enum COLUMN_DATA_SETTINGS {
        NO_SETTINGS = 1 << 0,
        //CHILD_TABLE = 1 << 1,              // Is a child table
        //FLAGS_TABLE = CHILD_TABLE,         // Both tables are treated the same
        DO_NOT_USE_EXTRA_COLUMNS = 1 << 2, 
        HAS_NO_ID_COLUMN = 1 << 3,         
        HAS_UID_COLUMN = 1 << 4,           
        FORCE_CACHING = 1 << 5,    
        REBUILD_PRIORITY = 1 << 6, 
        SORTABLE_TABLE = 1 << 7,   
        USES_IDENTIFIER_SINGLE_STRING = 1 << 8, 
        USES_IDENTIFIER_STRING_LIST = 1 << 9,   
    };
 
    // Base column indexes
    enum COLUMN_DATA_INDEXES {
        FirstColumn = 0,
        Id = FirstColumn,                       
        Uid,                                    
        DisplayText,                            
        SubHeadingText,                         
        ValidationStatus,                       
        IsModifiedByDbXfer,                     
        DbXferImportId,                         
        FirstStandardDerivedColumnIndex,        
        FirstIdOnlyDerivedColumnIndex = Id + 1, 
        Text = DisplayText                      
    };
 
    // Constructor
    ColumnData(const quint16 settings = NO_SETTINGS);
    ~ColumnData();
 
    // Add column data
    void add(const Column &column);
    void add(const ColumnData &data);
 
    // Cache status
    inline bool isCached() const { return is_cached_; }
    inline void setCacheComplete(const bool is_cached) { is_cached_ = is_cached; }
 
    // Get data
    qint32 columnCount() const;
    const Column *column(const qint32 column_id) const;
    QSize dimensions(const qint32 column_id) const;
    inline qint32 firstDerivedColumnIndex() const { return first_derived_column_index_; }
    Qt::ItemFlags flags(const QModelIndex &index) const;
    inline bool isInitialised() const { return is_initialised_; }
    QString name(const qint32 column_id) const;
 
    // Get data - settings
    inline bool hasExtraColumns() const { return (settings_ & DO_NOT_USE_EXTRA_COLUMNS) == 0; }
    inline bool hasIdColumn() const { return (settings_ & HAS_NO_ID_COLUMN) == 0; }
    inline bool hasRebuildPriority() const { return (settings_ & REBUILD_PRIORITY); }
    inline bool hasUidColumn() const { return (settings_ & HAS_UID_COLUMN); }
    inline bool isSortable() const { return (settings_ & SORTABLE_TABLE); }
    inline bool usesIdentifierSingleString() const
    {
        return settings_ & USES_IDENTIFIER_SINGLE_STRING;
    }
    inline bool usesIdentifierStringList() const { return settings_ & USES_IDENTIFIER_STRING_LIST; }
 
    // Identifier
    void validateIdentifierSetting();
 
    // Operator overloading
    bool operator==(const ColumnData &rhs) const;
    inline bool operator!=(const ColumnData &rhs) const { return !(*this == rhs); }
 
    // Set data
    void clearAll();
 
    // Sanity checking
    bool isValid(const qint32 column_id) const;
 
private:
    std::vector<Column> columns_;
    qint32 first_derived_column_index_{0};
 
    // Cached status
    bool is_cached_{true}; // Indicates whether initial caching is complete
 
    // Initialisation
    bool is_initialised_{false};
    void init();
 
    // Settings
    quint16 settings_{NO_SETTINGS};
};
 
} // namespace ehm_dal::column_data