SettingsInterface.h

Go to the documentation of this file.

/*
 *
 *                             C@@o         ____  _____   __ _
 *                        oC8@@@@@@@o      |___ \|  __ \ / _| |
 *                    o@@@@@@@@@@@@O         __) | |  | | |_| | _____      __
 *         O@O        8@@@@@@@@@O           |__ <| |  | |  _| |/ _ \ \ /\ / /
 *       o@@@@@@@O    OOOOOCo               ___) | |__| | | | | (_) \ V  V /
 *       C@@@@@@@@@@@@Oo                   |____/|_____/|_| |_|\___/ \_/\_/
 *          o8@@@@@@@@@@@@@@@@8OOCCCC
 *              oO@@@@@@@@@@@@@@@@@@@o          3Dflow s.r.l. - www.3dflow.net
 *                   oO8@@@@@@@@@@@@o           Copyright 2022
 *       oO88@@@@@@@@8OCo                       All Rights Reserved
 *  O@@@@@@@@@@@@@@@@@@@@@@@@@8OCCoooooooCCo
 *   @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@O
 *    @@@Oo            oO8@@@@@@@@@@@@@@@@8
 *
 */
 
#ifndef FLOWENGINESETTINGSINTERFACE_H
#define FLOWENGINESETTINGSINTERFACE_H
 
#pragma once
 
#include "CommonDef.h"
 
namespace FlowEngine
{
    class SettingsInterface
    {
        public:
 
            FLE_DLL virtual ~SettingsInterface() = default;
 
        public:
 
            FLE_DLL virtual Result setValue( ConstStringBuffer category,
                                             ConstStringBuffer name,
                                             ConstStringBuffer value ) = 0;
 
        public:
 
            FLE_DLL virtual Result getValue( ConstStringBuffer category,
                                             ConstStringBuffer name,
                                             StringBuffer outValue ) const = 0;
 
            FLE_DLL virtual Size getValueLength( ConstStringBuffer category,
                                                 ConstStringBuffer name ) const = 0;
 
        public:
 
            FLE_DLL virtual Index getKeyCount( ConstStringBuffer category ) const = 0;
 
            FLE_DLL virtual Size getKeyLength( ConstStringBuffer category, Index key ) const = 0;
 
            FLE_DLL virtual Result getKey( ConstStringBuffer category, Index key, StringBuffer outKey ) const = 0;
 
        public:
 
            FLE_DLL virtual Result save( ConstStringBuffer filePath ) const = 0;
 
            FLE_DLL virtual Result load( ConstStringBuffer filePath ) = 0;
    };
 
    FLOWENGINE_FACTORY SettingsInterface *CreateSettings();
 
    FLOWENGINE_FACTORY void DestroySettings( SettingsInterface *settings );
}
 
#endif