apps/opencs/model/world/collectionbase.hpp

Go to the documentation of this file.

#ifndef CSM_WOLRD_COLLECTIONBASE_H
#define CSM_WOLRD_COLLECTIONBASE_H

#include <string>
#include <vector>

#include "universalid.hpp"
#include "columns.hpp"

class QVariant;

namespace CSMWorld
{
    struct ColumnBase;
    struct RecordBase;

    class CollectionBase
    {
            // not implemented
            CollectionBase (const CollectionBase&);
            CollectionBase& operator= (const CollectionBase&);

        public:

            CollectionBase();

            virtual ~CollectionBase();

            virtual int getSize() const = 0;

            virtual std::string getId (int index) const = 0;

            virtual int getIndex (const std::string& id) const = 0;

            virtual int getColumns() const = 0;

            virtual const ColumnBase& getColumn (int column) const = 0;

            virtual QVariant getData (int index, int column) const = 0;

            virtual void setData (int index, int column, const QVariant& data) = 0;

// Not in use. Temporarily removed so that the implementation of RefIdCollection can continue without
// these functions for now.
//            virtual void merge() = 0;

//            virtual void purge() = 0;

            virtual void removeRows (int index, int count) = 0;

            virtual void appendBlankRecord (const std::string& id,
                UniversalId::Type type = UniversalId::Type_None) = 0;

            virtual int searchId (const std::string& id) const = 0;

            virtual void replace (int index, const RecordBase& record) = 0;

            virtual void appendRecord (const RecordBase& record,
                UniversalId::Type type = UniversalId::Type_None) = 0;

            virtual const RecordBase& getRecord (const std::string& id) const = 0;

            virtual const RecordBase& getRecord (int index) const = 0;

            virtual int getAppendIndex (const std::string& id,
                UniversalId::Type type = UniversalId::Type_None) const = 0;

            virtual std::vector<std::string> getIds (bool listDeleted = true) const = 0;

            virtual bool reorderRows (int baseIndex, const std::vector<int>& newOrder) = 0;

            int searchColumnIndex (Columns::ColumnId id) const;

            int findColumnIndex (Columns::ColumnId id) const;
    };
}

#endif