class CCL::SimplePresetHandler

Overview

#include <simplepreset.h>

class SimplePresetHandler: public CCL::PresetHandler
{
public:
    // fields

    int flags = 0);

    // methods

    DECLARE_CLASS_ABSTRACT (SimplePresetHandler, PresetHandler) const;
    void registerSelf ();
    PROPERTY_STRING (presetFolderName, PresetFolderName);
    PresetCategory PROPERTY_STRING (presetClassName, PresetClassName);
    virtual const FileType&CCL_API getFileType ();
    virtual tbool CCL_API canHandle (IUnknown* target);
    virtual tbool CCL_API getWriteLocation (IUrl& url, IAttributeList* metaInfo);

    virtual tbool CCL_API getReadLocation (
        IUrl& url,
        IAttributeList* metaInfo,
        int index
    );

    virtual tbool CCL_API getSubFolder (String& subFolder, IAttributeList& metaInfo);

    virtual IPreset*CCL_API openPreset (
        UrlRef url,
        IPresetDescriptor* descriptor = nullptr
    );

    virtual IPreset*CCL_API createPreset (UrlRef url, IAttributeList& metaInfo);
    static SimplePresetHandler* findHandler (const IAttributeList& metaInfo);
    static void getFactoryFolder (IUrl& path, StringRef subFolder = nullptr);
    static StringRef getUserPresetFolderName ();
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // enums

    enum Flags;

    // fields

     IPresetFileHandler;

    // 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 int CCL_API getFlags () = 0;
    virtual tbool CCL_API canHandle (IUnknown* target) = 0;

    virtual tbool CCL_API getWriteLocation (
        IUrl& url,
        IAttributeList* metaInfo = nullptr
    ) = 0;

    virtual tbool CCL_API getReadLocation (
        IUrl& url,
        IAttributeList* metaInfo,
        int index
    ) = 0;

    virtual tbool CCL_API getSubFolder (String& subFolder, IAttributeList& metaInfo) = 0;
    virtual const FileType&CCL_API getFileType () = 0;

    virtual IPreset*CCL_API openPreset (
        UrlRef url,
        IPresetDescriptor* descriptor = nullptr
    ) = 0;

    virtual IPreset*CCL_API createPreset (UrlRef url, IAttributeList& metaInfo) = 0;
    virtual int CCL_API getTargetFlags (IUnknown* target) = 0;
    virtual const FileType&CCL_API getFileType (int index) = 0;
    DECLARE_STRINGID_MEMBER (kPresetLocationsChanged);
    virtual int CCL_API getFlags ();
    virtual tbool CCL_API canHandle (IUnknown* target);
    virtual tbool CCL_API getWriteLocation (IUrl& url, IAttributeList* metaInfo);

    virtual tbool CCL_API getReadLocation (
        IUrl& url,
        IAttributeList* metaInfo,
        int index
    );

    virtual tbool CCL_API getSubFolder (String& subFolder, IAttributeList& metaInfo);
    virtual const FileType&CCL_API getFileType ();
    virtual const FileType&CCL_API getFileType (int index);
    virtual IPreset*CCL_API openPreset (UrlRef url, IPresetDescriptor* descriptor);
    virtual IPreset*CCL_API createPreset (UrlRef url, IAttributeList& metaInfo);
    virtual int CCL_API getTargetFlags (IUnknown* target);
    DECLARE_CLASS (PresetHandler, Object);

Detailed Documentation

Methods

void registerSelf ()

register with PresetFileRegistry

PresetCategory PROPERTY_STRING (presetClassName, PresetClassName)

< assigned to SimplePreset::category

virtual const FileType&CCL_API getFileType ()

Get preset file type (legacy method, handlers with multiple types should return the most important / default type here).

virtual tbool CCL_API canHandle (IUnknown* target)

Check if target can be handled.

virtual tbool CCL_API getWriteLocation (IUrl& url, IAttributeList* metaInfo)

Get location for writing presets, metaInfo can be null (root location).

virtual tbool CCL_API getReadLocation (
    IUrl& url,
    IAttributeList* metaInfo,
    int index
)

Get location(s) for reading presets, metaInfo can be null (root location).

virtual tbool CCL_API getSubFolder (String& subFolder, IAttributeList& metaInfo)

Get subFolder (relative to a root location) for given metaInfo.

virtual IPreset*CCL_API openPreset (
    UrlRef url,
    IPresetDescriptor* descriptor = nullptr
)

Open preset from given location; use optional descriptor to restore cached meta information.

virtual IPreset*CCL_API createPreset (UrlRef url, IAttributeList& metaInfo)

Create preset at given location.

static SimplePresetHandler* findHandler (const IAttributeList& metaInfo)

find handler based on category

static void getFactoryFolder (IUrl& path, StringRef subFolder = nullptr)

get factory folder for simple presets