class CCL::ObjectPresetCollection

Overview

Transfers preset collections between objects that implement IPresetCollector. More…

#include <objectpreset.h>

class ObjectPresetCollection:
    public CCL::Preset,
    public CCL::IPresetCollection
{
public:
    // classes

    class Stream;

    // fields

     IPresetCollection;

    // methods

    DECLARE_CLASS (ObjectPresetCollection, Preset);
    virtual IAttributeList*CCL_API getMetaInfo () const;
    virtual tbool CCL_API restore (IUnknown* target) const;
    virtual int CCL_API countPresets ();
    virtual IPreset*CCL_API openPreset (int index);
    virtual IPreset*CCL_API openPreset (const IStringDictionary& parameters);
    virtual IPreset*CCL_API createPreset (IAttributeList& metaInfo);
    virtual IStream*CCL_API openStream (StringRef path, int mode);
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // enums

    enum Flags;

    // fields

    int flags = 0;
    int IUnknown* data = nullptr);
     kReadOnly;
     IPreset;

    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;
    Unknown& operator = (const Unknown&);
    unsigned int getRetainCount () const;
    virtual Object*CCL_API revealObject (const void* moduleAddress) = 0;
    virtual void CCL_API addObserver (IObserver* observer) = 0;
    virtual void CCL_API removeObserver (IObserver* observer) = 0;
    virtual void CCL_API signal (MessageRef msg) = 0;
    virtual void CCL_API deferSignal (IMessage* msg) = 0;
    static ISubject void addObserver (IUnknown* unknown, IObserver* observer);
    static void removeObserver (IUnknown* unknown, IObserver* observer);
    virtual void CCL_API notify (ISubject* subject, MessageRef msg) = 0;

    static IObserver void notify (
        IUnknown* unknown,
        ISubject* subject,
        MessageRef msg
    );

    virtual const ITypeInfo&CCL_API getTypeInfo () const = 0;
    virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const = 0;
    virtual tbool CCL_API setProperty (MemberID propertyId, const Variant& var) = 0;
    virtual tbool CCL_API getPropertyNames (IPropertyCollector& collector) const = 0;
    virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg) = 0;
    DECLARE_BASE_CLASS (Object);
    virtual void CCL_API removeObserver (IObserver* observer);
    virtual void CCL_API signal (MessageRef msg);
    virtual void CCL_API deferSignal (IMessage* msg);
    virtual void deferChanged ();
    virtual void CCL_API notify (ISubject* subject, MessageRef msg);
    virtual bool equals (const Object& obj) const;
    virtual int compare (const Object& obj) const;
    virtual bool load (const Storage& storage);
    virtual bool save (const Storage& storage) const;
    virtual bool save (const OutputStorage& storage) const;
    virtual bool toString (String& string, int flags = 0) const;
    virtual int getHashCode (int size) const;
    IUnknown* asUnknown ();
    static void addGarbageCollected (Object* obj, bool globalScope = true);
    static void deferDestruction (Object* obj);
    static const void* getModuleAddress ();
    virtual tbool CCL_API isReadOnly () const = 0;
    virtual tbool CCL_API isModified () const = 0;
    virtual StringRef CCL_API getPresetName () const = 0;
    virtual IAttributeList*CCL_API getMetaInfo () const = 0;
    virtual tbool CCL_API getUrl (IUrl& url) const = 0;
    virtual IUnknown*CCL_API getUserData () const = 0;
    virtual tbool CCL_API store (IUnknown* target) = 0;
    virtual tbool CCL_API restore (IUnknown* target) const = 0;
    virtual tbool CCL_API toDescriptor (IPresetDescriptor& descriptor) const = 0;
    virtual tbool CCL_API fromDescriptor (IPresetDescriptor& descriptor) = 0;
    virtual tbool CCL_API setUserData (IUnknown* data) = 0;
    virtual tbool CCL_API isReadOnly () const;
    virtual tbool CCL_API isModified () const;
    virtual StringRef CCL_API getPresetName () const;
    virtual IAttributeList*CCL_API getMetaInfo () const;
    virtual tbool CCL_API getUrl (IUrl& url) const;
    virtual IUnknown*CCL_API getUserData () const;
    virtual tbool CCL_API store (IUnknown* target);
    virtual tbool CCL_API restore (IUnknown* target) const;
    virtual tbool CCL_API toDescriptor (IPresetDescriptor& descriptor) const;
    virtual tbool CCL_API fromDescriptor (IPresetDescriptor& descriptor);
    virtual tbool CCL_API setUserData (IUnknown* data);
    DECLARE_CLASS (Preset, Object);
    PROPERTY_VARIABLE (int, flags, Flags);
    readOnly PROPERTY_FLAG (flags, kModified, modified);
    readOnly Name PROPERTY_SHARED (IUnknown, data, Data) const;
    virtual tbool CCL_API isModified () const;
    virtual StringRef CCL_API getPresetName () const;
    virtual IUnknown*CCL_API getUserData () const;
    virtual tbool CCL_API setUserData (IUnknown* data);
    virtual int CCL_API countPresets () = 0;
    virtual IPreset*CCL_API openPreset (int index) = 0;
    virtual IPreset*CCL_API openPreset (const IStringDictionary& parameters) = 0;
    virtual IPreset*CCL_API createPreset (IAttributeList& metaInfo) = 0;
    virtual IStream*CCL_API openStream (StringRef path, int mode) = 0;

Detailed Documentation

Transfers preset collections between objects that implement IPresetCollector.

Methods

virtual IAttributeList*CCL_API getMetaInfo () const

Get meta information.

virtual tbool CCL_API restore (IUnknown* target) const

Transfer data from preset to target.

virtual int CCL_API countPresets ()

Get number of presets.

virtual IPreset*CCL_API openPreset (int index)

Open preset at given index (must be released by caller).

virtual IPreset*CCL_API openPreset (const IStringDictionary& parameters)

Open preset with parameters (must be released by caller).

virtual IPreset*CCL_API createPreset (IAttributeList& metaInfo)

Create preset (must be released by caller).

virtual IStream*CCL_API openStream (StringRef path, int mode)

Open additional stream (must be released by caller).