struct CCL::IPreset

Overview

#include <ipreset.h>

struct IPreset: public CCL::IUnknown
{
    // methods

    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;
};

Inherited Members

public:
    // 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;

Detailed Documentation

Methods

virtual tbool CCL_API isReadOnly () const = 0

Check if preset is read-only.

virtual tbool CCL_API isModified () const = 0

Check if preset has been modified.

virtual StringRef CCL_API getPresetName () const = 0

Get preset name.

virtual IAttributeList*CCL_API getMetaInfo () const = 0

Get meta information.

virtual tbool CCL_API getUrl (IUrl& url) const = 0

Get preset location.

virtual IUnknown*CCL_API getUserData () const = 0

Get arbitrary data associated with this preset.

virtual tbool CCL_API store (IUnknown* target) = 0

Transfer data from target to preset.

virtual tbool CCL_API restore (IUnknown* target) const = 0

Transfer data from preset to target.

virtual tbool CCL_API toDescriptor (IPresetDescriptor& descriptor) const = 0

Assign meta info and optional data to preset descriptor.

virtual tbool CCL_API fromDescriptor (IPresetDescriptor& descriptor) = 0

Take meta info and optional data from preset descriptor.

virtual tbool CCL_API setUserData (IUnknown* data) = 0

Assign arbitrary data associated with this preset.

(shared)