ipersistent.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// Project     : SDK Core
//
// Category    : SDK Core Interfaces
// Filename    : pluginterfaces/base/ipersistent.h
// Created by  : Steinberg, 09/2004
// Description : Plug-In Storage Interfaces
//
//-----------------------------------------------------------------------------
// This file is part of a Steinberg SDK. It is subject to the license terms
// in the LICENSE file found in the top-level directory of this distribution
// and at www.steinberg.net/sdklicenses. 
// No part of the SDK, including this file, may be copied, modified, propagated,
// or distributed except according to the terms contained in the LICENSE file.
//-----------------------------------------------------------------------------
 
#pragma once
 
#include "pluginterfaces/base/funknown.h"
 
namespace Steinberg {
 
class FVariant;
class IAttributes;
//------------------------------------------------------------------------
class IPersistent: public FUnknown
{
public:
//------------------------------------------------------------------------
        virtual tresult PLUGIN_API getClassID (char8* uid) = 0;
        virtual tresult PLUGIN_API saveAttributes (IAttributes* ) = 0;
        virtual tresult PLUGIN_API loadAttributes (IAttributes* ) = 0;
//------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (IPersistent, 0xBA1A4637, 0x3C9F46D0, 0xA65DBA0E, 0xB85DA829)
 
 
typedef FIDString IAttrID;
//------------------------------------------------------------------------
class IAttributes: public FUnknown
{
public:
//------------------------------------------------------------------------

        virtual tresult PLUGIN_API set (IAttrID attrID, const FVariant& data) = 0;
   
        virtual tresult PLUGIN_API queue (IAttrID listID, const FVariant& data) = 0;  
   
        virtual tresult PLUGIN_API setBinaryData (IAttrID attrID, void* data, uint32 bytes, bool copyBytes) = 0;


        virtual tresult PLUGIN_API get (IAttrID attrID, FVariant& data) = 0;
    
        virtual tresult PLUGIN_API unqueue (IAttrID listID, FVariant& data) = 0; 

        virtual int32 PLUGIN_API getQueueItemCount (IAttrID) = 0;
        
        virtual tresult PLUGIN_API resetQueue (IAttrID attrID) = 0;
        
        virtual tresult PLUGIN_API resetAllQueues () = 0;
 
        virtual tresult PLUGIN_API getBinaryData (IAttrID attrID, void* data, uint32 bytes) = 0;     
        virtual uint32 PLUGIN_API getBinaryDataSize (IAttrID attrID) = 0;
 
//------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (IAttributes, 0xFA1E32F9, 0xCA6D46F5, 0xA982F956, 0xB1191B58)
 
//------------------------------------------------------------------------
class IAttributes2 : public IAttributes
{
public:
        virtual int32 PLUGIN_API countAttributes () const = 0;
        virtual IAttrID PLUGIN_API getAttributeID (int32 index) const = 0;
//------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (IAttributes2, 0x1382126A, 0xFECA4871, 0x97D52A45, 0xB042AE99)
 
//------------------------------------------------------------------------
} // namespace Steinberg