COptionsManager.h

Go to the documentation of this file.

/********************************************************************************
**  This file is part of the ICF Framework. Copyright (C) Witold Gantzke & Kirill Lepskiy
**  ICF Framework may be used under the terms of the LGPL License v. 2.1 by the Free Software Foundation.
********************************************************************************/
 
#ifndef iprm_COptionsManager_included
#define iprm_COptionsManager_included
 
 
// Qt includes
#include <QtCore/QVector>
 
// ICF includes
#include <iprm/IOptionsManager.h>
#include <iprm/CSelectionParam.h>
 
 
namespace iprm
{
 
 
class IOptionsList;
 
 
class COptionsManager:
        public CSelectionParam,
        virtual public IOptionsManager
{
public:
    typedef CSelectionParam BaseClass;
 
    COptionsManager();
 
    void SetFixedOptionsList(const iprm::IOptionsList* slaveSelectionConstraintsPtr);
 
    virtual void ResetOptions();
 
    int GetOptionIndexById(const QByteArray& optionId) const;
 
    int GetOptionIndexByName(const QString& optionName) const;
 
    bool IsSelectionSerialized() const;
 
    void SetSelectionSerialized(bool  state);
 
    // reimplemented (iprm::IOptionsList)
    int GetOptionsFlags() const override;
    int GetOptionsCount() const override;
    QString GetOptionName(int index) const override;
    QString GetOptionDescription(int index) const override;
    QByteArray GetOptionId(int index) const override;
    bool IsOptionEnabled(int index) const override;
 
    // reimplemented (iprm::IOptionsManager)
    int GetOptionOperationFlags(int index = -1) const override;
    bool SetOptionEnabled(int index, bool isEnabled = true) override;
    bool RemoveOption(int index) override;
    bool InsertOption(
            const QString& optionName,
            const QByteArray& optionId,
            const QString& optionDescription = QString(),
            int index = -1) override;
    bool SwapOptions(int index1, int index2) override;
    bool SetOptionName(int index, const QString& optionName) override;
    bool SetOptionDescription(int index, const QString& optionDescription) override;
 
    // reimplemented (iser::ISerializable)
    bool Serialize(iser::IArchive& archive) override;
 
    // reimplemented (iser::IChangeable)
    int GetSupportedOperations() const override;
    bool CopyFrom(const IChangeable& object, CompatibilityMode mode = CM_WITHOUT_REFS) override;
 
private:
    struct OptionInfo
    {
        OptionInfo()
        :   isEnabled(true)
        {
        }
 
        OptionInfo(const QString& optionName, QByteArray optionId, const QString& optionDescription)
        :   optionName(optionName),
            optionId(optionId),
            optionDescription(optionDescription),
            isEnabled(true)
        {
        }
 
        QString optionName;
        QByteArray optionId;
        QString optionDescription;
        bool isEnabled;
    };
 
    typedef QVector<OptionInfo> Options;
 
    Options m_options;
 
    const iprm::IOptionsList* m_slaveSelectionConstraintsPtr;
 
    bool m_isSelectionSerialized;
};
 
 
} // namespace iprm
 
 
#endif // !iprm_COptionsManager_included