MTemplateItem.h

/*****************************************************************************
**
**  Header file for Virtual Vertex Template item base class
**
**  Name    : MTemplateItem.h
**  Author  : Leonardo Bernardini
**  Version : Alpha 9.0 Wed May 17th 2017
**
**  Copyright 2000-2017, Virtual Vertex
**  All Rights Reserved.
**
**  This file contains UNPUBLISHED PROPRIETARY SOURCE CODE.
**  The contents of this file may not be disclosed to third parties, copied
**  or duplicated in any form, in whole or in part, without the prior written
**  permission of the author.
**
*****************************************************************************/
#ifndef MTEMPLATE_ITEM_H
#define MTEMPLATE_ITEM_H

#ifdef WIN32
// Windows definitions
#ifdef MTEMPLATE_EXPORTS
#define MTEMPLATE_API __declspec(dllexport)
#else
#define MTEMPLATE_API __declspec(dllimport)
#endif
#else

#ifndef MTEMPLATE_EXPORTS
#ifdef LINUX
#define MTEMPLATE_API
#else
#define MTEMPLATE_API
#endif
#else
#define MTEMPLATE_API
#endif
#endif

// Disable STL Export warning
#if defined(_WIN32)
#pragma warning(disable: 4251)
#endif // _WIN32

#include <string>
#include <vector>

namespace MTemplateEngine {
    class MTEMPLATE_API MTemplateItem {

    public:

        friend class MTemplate;
        friend class MTemplateItemHolder;
        friend class MTemplatePlatform;

        enum kTemplatesItemTypes {
            kTemplateItemInvalid, 
            kTemplateItemFile, 
            kTemplateItemDouble, 
            kTemplateItemString, 
            kTemplateItemInt, 
            kTemplateItemCombo, 
            kTemplateItemFolder, 
            kTemplateItemMultiChoice, 
            kTemplateItemCheck, 
            kTemplateItemYesNo, 
            kTemplateItemFramesRange 
        };

        MTemplateItem();
        MTemplateItem(const std::string& _name, const std::string& _description, const std::string& _extendedDescription,
            const std::string& defaultValue, bool _isActivable, bool _applySubstitution, bool _isMandatory);
        virtual ~MTemplateItem();

        std::string getName();
        std::string getDescription();
        std::string getExtendedDescription();
        std::string getDefaultValue();
        bool getDefaultActivatorValue();
        bool getIsActivable();
        bool getApplySubstitution();
        bool getIsMandatory();
        int getType();

        void setName(const std::string& _name);
        void setDescription(const std::string& _description);
        void setExtendedDescription(const std::string& _extendedDescription);
        void setIsActivable(bool _isActivable);
        void setApplySubstitution(bool _applySubstitution);
        void setIsMandatory(bool _isMandatory);
        void setType(int _type);
        void setDefaultValue(const std::string& _defaultValue);
        void setDefaultActivatorValue(bool _defaultValue);

        MTemplateItem* duplicateItem();
        static void deallocateItemList(std::vector<MTemplateItem*>* list);
    protected:
        int type;
    private:
        std::string defaultValue;
        std::string name;
        std::string description;
        std::string extendedDescription;
        bool isActivable;
        bool applySubstitution;
        bool isMandatory;
        bool defaultActivatorValue;
    protected:
        virtual void encodeTree(void* pt, std::string(*encodeFunc)(const std::string &), int encoding, void* fields, std::vector<std::string>* filters);

    };

};

#endif