struct CCL::IPluginPresentation

Overview

#include <ipluginpresentation.h>

struct IPluginPresentation: public CCL::IUnknown
{
    // typedefs

    typedef StringRef CategoryRef;

    // methods

    virtual tbool CCL_API isHidden (UIDRef cid) const = 0;
    virtual void CCL_API setHidden (UIDRef cid, tbool state) = 0;
    virtual tbool CCL_API isFavorite (UIDRef cid) const = 0;
    virtual String CCL_API getFavoriteFolder (UIDRef cid) const = 0;

    virtual void CCL_API setFavorite (
        UIDRef cid,
        tbool state,
        StringRef folder = nullptr
    ) = 0;

    virtual void CCL_API addFavoriteFolder (CategoryRef category, StringRef path) = 0;
    virtual void CCL_API removeFavoriteFolder (CategoryRef category, StringRef path) = 0;

    virtual void CCL_API moveFavoriteFolder (
        CategoryRef category,
        StringRef oldPath,
        StringRef newPath
    ) = 0;

    virtual void CCL_API renameFavoriteFolder (
        CategoryRef category,
        StringRef path,
        StringRef newName
    ) = 0;

    virtual IUnknownIterator*CCL_API getFavoriteFolders (CategoryRef category) const = 0;
    virtual tbool CCL_API hasFavoriteFolder (CategoryRef category, StringRef path) const = 0;
    virtual int64 CCL_API getLastUsage (UIDRef cid) const = 0;
    virtual void CCL_API logUsage (UIDRef cid) = 0;
    virtual tbool CCL_API isSystemScalingEnabled (UIDRef cid) const = 0;
    virtual void CCL_API setSystemScalingEnabled (UIDRef cid, tbool state) = 0;
    virtual tbool CCL_API getAttribute (Variant& value, UIDRef cid, StringID attrId) const = 0;

    virtual void CCL_API setAttribute (
        UIDRef cid,
        StringID attrId,
        VariantRef value
    ) = 0;

    virtual void CCL_API removeAttribute (UIDRef cid, StringID attrId) = 0;
    virtual String CCL_API getSortPath (UIDRef cid) const = 0;
    virtual void CCL_API setSortPath (UIDRef cid, StringRef path) = 0;
    virtual void CCL_API addSortFolder (CategoryRef category, StringRef path) = 0;
    virtual void CCL_API removeSortFolder (CategoryRef category, StringRef path) = 0;

    virtual void CCL_API moveSortFolder (
        CategoryRef category,
        StringRef oldPath,
        StringRef newPath
    ) = 0;

    virtual void CCL_API renameSortFolder (
        CategoryRef category,
        StringRef path,
        StringRef newName
    ) = 0;

    virtual IUnknownIterator*CCL_API getSortFolders (CategoryRef category) const = 0;
    virtual tbool CCL_API hasSortFolder (CategoryRef category, StringRef path) const = 0;
    virtual void CCL_API reset () = 0;
    virtual void CCL_API revert () = 0;
    virtual void CCL_API saveSettings () = 0;
    DECLARE_STRINGID_MEMBER (kAttributeChanged);
};

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 isHidden (UIDRef cid) const = 0

Hidden state.

virtual tbool CCL_API isFavorite (UIDRef cid) const = 0

Favorite state and optional sort folder.

virtual int64 CCL_API getLastUsage (UIDRef cid) const = 0

Usage tracking.

seconds since 1970, or 0 if not used

virtual tbool CCL_API isSystemScalingEnabled (UIDRef cid) const = 0

System DPI scaling (Windows only).

virtual tbool CCL_API getAttribute (Variant& value, UIDRef cid, StringID attrId) const = 0

Additonal attributes.

virtual String CCL_API getSortPath (UIDRef cid) const = 0

Sort paths.

virtual void CCL_API reset () = 0

Reset to default state.

virtual void CCL_API revert () = 0

Revert to last saved state.

virtual void CCL_API saveSettings () = 0

Save state in settings.

DECLARE_STRINGID_MEMBER (kAttributeChanged)

< plug-in snapshot image changed; arg[1]: category

< plug-in was used (see getLastUsage); arg[1]: category