struct CCL::IPlugInSnapshots

Overview

#include <ipluginpresentation.h>

struct IPlugInSnapshots: public CCL::IUnknown
{
    // fields

    StringID which = kDefault) const = 0;

    // methods

    DECLARE_STRINGID_MEMBER (kDefault);
    virtual tbool CCL_API hasUserSnapshot (UIDRef cid) const = 0;
    virtual tbool CCL_API setUserSnapshot (UIDRef cid, IImage* image) = 0;

    virtual tbool CCL_API setDefaultSnapshot (
        UrlRef snapshotFile,
        UIDRef cid,
        UrlRef imageFile1x,
        UrlRef imageFile2x
    ) = 0;

    virtual tbool CCL_API getSnapshotDescription (
        String& description,
        UIDRef cid,
        StringID which = kDefault
    ) const = 0;

    virtual tbool CCL_API isHighlight (UIDRef cid) const = 0;
    virtual int CCL_API addLocation (UrlRef path, tbool deep = true) = 0;
    virtual tbool CCL_API addSnapshotFile (UrlRef path) = 0;
    virtual void CCL_API removeLocation (UrlRef path) = 0;
    virtual tbool CCL_API hasLocation (UrlRef path) const = 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

DECLARE_STRINGID_MEMBER (kDefault)

Get snapshot image for given plug-in class.

virtual tbool CCL_API hasUserSnapshot (UIDRef cid) const = 0

Check if user has created a snapshot image for the given plug-in class.

virtual tbool CCL_API setUserSnapshot (UIDRef cid, IImage* image) = 0

Set user snapshot image for given plug-in class.

virtual tbool CCL_API setDefaultSnapshot (
    UrlRef snapshotFile,
    UIDRef cid,
    UrlRef imageFile1x,
    UrlRef imageFile2x
) = 0

Set default snapshot image for given plug-in class.

virtual tbool CCL_API getSnapshotDescription (
    String& description,
    UIDRef cid,
    StringID which = kDefault
) const = 0

Get description associated with snapshot.

virtual tbool CCL_API isHighlight (UIDRef cid) const = 0

Check if given plug-in class should be highlighted.

virtual int CCL_API addLocation (UrlRef path, tbool deep = true) = 0

Add snapshot location.

virtual tbool CCL_API addSnapshotFile (UrlRef path) = 0

Add snapshot json file location.

virtual void CCL_API removeLocation (UrlRef path) = 0

Remove snapshot location.

virtual tbool CCL_API hasLocation (UrlRef path) const = 0

Check if given snapshot location has been added.