class CCL::PluginPresentation

Overview

#include <pluginclass.h>

class PluginPresentation:
    public CCL::Object,
    private CCL::Singleton,
    public CCL::IPluginPresentation
{
public:
    // classes

    class FavoriteFolderTraits;
    class PlugInfo;
    class SortFolderTraits;

    // fields

     IPluginPresentation;

    // methods

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

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

    virtual int64 CCL_API getLastUsage (UIDRef cid) const;
    virtual void CCL_API logUsage (UIDRef cid);
    virtual tbool CCL_API isSystemScalingEnabled (UIDRef cid) const;
    virtual void CCL_API setSystemScalingEnabled (UIDRef cid, tbool state);
    virtual tbool CCL_API getAttribute (Variant& value, UIDRef cid, StringID attrId) const;

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

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

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

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

    virtual IUnknownIterator*CCL_API getSortFolders (CategoryRef category) const;
    virtual tbool CCL_API hasSortFolder (CategoryRef category, StringRef path) const;
    virtual void CCL_API addFavoriteFolder (CategoryRef category, StringRef path);
    virtual void CCL_API removeFavoriteFolder (CategoryRef category, StringRef path);

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

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

    virtual IUnknownIterator*CCL_API getFavoriteFolders (CategoryRef category) const;
    virtual tbool CCL_API hasFavoriteFolder (CategoryRef category, StringRef path) const;
    virtual void CCL_API saveSettings ();
    virtual void CCL_API reset ();
    virtual void CCL_API revert ();
    static String getParentSortFolder (StringRef path);
    static void getSettingsPath (IUrl& path);
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;
    typedef StringRef CategoryRef;

    // 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 ();
    static T& instance ();
    static T* peekInstance ();
    static Object* __createSingleton ();
    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);

Detailed Documentation

Methods

virtual tbool CCL_API isHidden (UIDRef cid) const

Hidden state.

virtual tbool CCL_API isFavorite (UIDRef cid) const

Favorite state and optional sort folder.

virtual int64 CCL_API getLastUsage (UIDRef cid) const

Usage tracking.

seconds since 1970, or 0 if not used

virtual tbool CCL_API isSystemScalingEnabled (UIDRef cid) const

System DPI scaling (Windows only).

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

Additonal attributes.

virtual String CCL_API getSortPath (UIDRef cid) const

Sort paths.

virtual void CCL_API saveSettings ()

Save state in settings.

virtual void CCL_API reset ()

Reset to default state.

virtual void CCL_API revert ()

Revert to last saved state.