/* Copyright (C) 2015
 * swift project Community / Contributors
 *
 * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 */

//! \file

#ifndef BLACKMISC_ORDERABLE_H
#define BLACKMISC_ORDERABLE_H

#include "blackmisc/blackmiscexport.h"
#include "blackmisc/propertyindex.h"
#include "blackmisc/variant.h"

#include <QString>

namespace BlackMisc
{
    //! Entity with order attribute (can be manually ordered in views)
    class BLACKMISC_EXPORT IOrderable
    {
    public:
        //! Properties by index
        enum ColumnIndex
        {
            IndexOrder = CPropertyIndex::GlobalIndexIOrderable,
            IndexOrderString
        };

        //! Order
        int getOrder() const { return m_order; }

        //! Order as string
        QString getOrderAsString() const;

        //! Set order
        void setOrder(int order) { m_order = order; }

        //! Valid order set?
        bool hasValidOrder() const;

        //! Any order index
        static bool isAnyOrderIndex(int index);

    protected:
        //! Can given index be handled
        static bool canHandleIndex(const CPropertyIndex &index);

        //! Constructor
        IOrderable();

        //! Constructor
        IOrderable(int order);

        //! Constructor
        IOrderable(const IOrderable &orderable) : IOrderable(orderable.m_order) {}

        //! \copydoc BlackMisc::Mixin::Index::propertyByIndex
        CVariant propertyByIndex(const CPropertyIndex &index) const;

        //! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
        void setPropertyByIndex(const CPropertyIndex &index, const CVariant &variant);

        //! \copydoc BlackMisc::Mixin::Index::comparePropertyByIndex
        int comparePropertyByIndex(const CPropertyIndex &index, const IOrderable &compareValue) const;

        int m_order = -1; //!< order number
    };
} // namespace

#endif // guard