class CCL::PresetManager

Overview

#include <presetmanager.h>

class PresetManager:
    public CCL::Component,
    public CCL::IPresetManager,
    public CCL::ComponentSingleton,
    public CCL::CommandDispatcher
{
public:
    // classes

    class FavoriteItem;

    // fields

     IPresetManager;

    // methods

    DECLARE_CLASS (PresetManager, Component);
    void setPresetRevision (int revision);
    void startup ();
    virtual IPreset*CCL_API openPreset (UrlRef url);
    virtual IPreset*CCL_API openPreset (const IFileDescriptor& descriptor);

    virtual IPreset*CCL_API openDefaultPreset (
        IPresetFileHandler& handler,
        IAttributeList* metaInfo
    );

    virtual tbool CCL_API supportsFileType (const FileType& fileType);

    virtual IUnknownList*CCL_API getPresets (
        IAttributeList* metaInfo,
        IProgressNotify* progress
    );

    virtual void CCL_API getPresetsInBackground (
        IObserver* observer,
        IAttributeList* metaInfo
    );

    virtual void CCL_API cancelGetPresets (IObserver* observer);

    virtual void CCL_API collectSubFolders (
        IMutableArray& subFolders,
        const IAttributeList* metaInfo
    );

    virtual ISearcher*CCL_API createSearcher (ISearchDescription& description);

    virtual tbool CCL_API presetExists (
        IAttributeList* metaInfo,
        StringRef name,
        const FileType* fileType = nullptr
    );

    virtual tbool CCL_API hasPresets (IAttributeList* metaInfo);
    virtual tbool CCL_API removePreset (IPreset& preset);

    virtual tbool CCL_API renamePreset (
        IPreset& preset,
        StringRef newName,
        IUrl* newUrl = nullptr
    );

    virtual void CCL_API scanPresets (tbool onlyChangedLocations);
    virtual void CCL_API onPresetCreated (UrlRef url, IPreset& preset);
    virtual void CCL_API onPresetRemoved (UrlRef url, IPreset& preset);
    virtual tbool CCL_API movePreset (IPreset& preset, StringRef newSubfolder);

    virtual void CCL_API addSortFolder (
        const IAttributeList& metaInfo,
        StringRef path
    );

    virtual void CCL_API removeSortFolder (
        const IAttributeList& metaInfo,
        StringRef path
    );

    virtual void CCL_API moveSortFolder (
        const IAttributeList& metaInfo,
        StringRef oldPath,
        StringRef newPath
    );

    virtual void CCL_API renameSortFolder (
        const IAttributeList& metaInfo,
        StringRef path,
        StringRef newName
    );

    virtual tbool CCL_API hasSortFolder (
        const IAttributeList& metaInfo,
        StringRef path
    ) const;

    virtual IUnknownIterator*CCL_API getSortFolders (const IAttributeList& metaInfo) const;
    virtual tbool CCL_API isFavorite (const IPreset& preset) const;
    virtual StringRef CCL_API getFavoriteFolder (const IPreset& preset) const;

    virtual void CCL_API setFavorite (
        const IPreset& preset,
        tbool state,
        StringRef folder = nullptr
    );

    virtual IUnknownIterator*CCL_API getFavoritePresets (const IAttributeList& metaInfo);

    virtual void CCL_API addFavoriteFolder (
        const IAttributeList& metaInfo,
        StringRef path
    );

    virtual void CCL_API removeFavoriteFolder (
        const IAttributeList& metaInfo,
        StringRef path
    );

    virtual void CCL_API moveFavoriteFolder (
        const IAttributeList& metaInfo,
        StringRef oldPath,
        StringRef newPath
    );

    virtual void CCL_API renameFavoriteFolder (
        const IAttributeList& metaInfo,
        StringRef path,
        StringRef newName
    );

    virtual IUnknownIterator*CCL_API getFavoriteFolders (const IAttributeList& metaInfo) const;

    virtual tbool CCL_API hasFavoriteFolder (
        const IAttributeList& metaInfo,
        StringRef path
    ) const;

    DECLARE_COMMANDS (PresetManager);
    Component bool onScanPresets (CmdArgs args);
    bool onScanPlugIns (CmdArgs args);
    bool onResetBlocklist (CmdArgs args);
    bool onRemovePlugInSettings (CmdArgs args);
    virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg);
    static void forceFullScanOnStartup ();
    static void suppressProgressDialog (bool suppress = true);
    static StringRef getScanningPresetsText ();
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // enums

    enum Flags;

    // structs

    struct ObjectEntry;

    // fields

     IObjectNode;
    StringRef title = nullptr);
     kMutable;
    UIDRef classID override;
    CLASS_INTERFACES (ObjectNode) protected String title;
    ParamContainer paramList;
    SignalSlotList signalSlots;
    LinkedList <ObjectEntry> objects;

    // 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 StringRef CCL_API getObjectID () const = 0;
    virtual UIDRef CCL_API getObjectUID () const = 0;
    virtual UIDRef CCL_API getClassUID () const = 0;
    virtual IObjectNode*CCL_API getParent () const = 0;
    virtual IObjectNode*CCL_API getRoot () const = 0;
    virtual int CCL_API countChildren () const = 0;
    virtual IObjectNode*CCL_API getChild (int index) const = 0;
    virtual IObjectNode*CCL_API findChild (StringRef id) const = 0;
    virtual tbool CCL_API getChildDelegates (IMutableArray& delegates) const = 0;
    virtual tbool CCL_API getChildPath (String& path) const = 0;
    virtual IObjectNode*CCL_API lookupChild (StringRef path) const = 0;
    virtual StringRef CCL_API getObjectID () const;
    virtual UIDRef CCL_API getObjectUID () const;
    virtual UIDRef CCL_API getClassUID () const;
    virtual IObjectNode*CCL_API getParent () const;
    virtual IObjectNode*CCL_API getRoot () const;
    virtual int CCL_API countChildren () const;
    virtual IObjectNode*CCL_API getChild (int index) const;
    virtual IObjectNode*CCL_API findChild (StringRef id) const;
    virtual tbool CCL_API getChildDelegates (IMutableArray& delegates) const;
    virtual tbool CCL_API getChildPath (String& path) const;
    virtual IObjectNode*CCL_API lookupChild (StringRef path) const;
    DECLARE_CLASS (ObjectNode, Object);
    void setName (StringRef name);
    bool setUniqueName (StringRef name);
    StringRef getName () const;
    virtual Iterator* newIterator () const;
    virtual bool addChild (ObjectNode* child);
    virtual bool insertChild (int index, ObjectNode* child);
    virtual bool addChildSorted (ObjectNode* child);
    virtual bool removeChild (ObjectNode* child);
    virtual void removeAll ();
    virtual ObjectNode* findChildNode (StringRef id) const;
    virtual ObjectNode* findChildNode (MetaClassRef typeID) const;

    template  <class T>
    T* findChildNode (StringRef id) const;

    template  <class T>
    T* findChildNode () const;

    template  <class T>
    T* getChildNode (int index) const;

    template  <class I>
    I* findChildByInterface (bool deep = false) const;

    ObjectNode* getChildNode (int index) const;
    int getChildIndex (const ObjectNode* child) const;
    virtual StringRef getChildID (const ObjectNode* child) const;
    ObjectNode* getParentNode () const;

    template  <class T>
    T* getParentNode () const;

    bool getRelativePath (String& path, ObjectNode* subNode) const;
    void signalDeep (MessageRef msg, bool recursive = false);

    virtual void notifyChildren (
        ISubject* subject,
        MessageRef msg,
        bool recursive = false
    );

    tresult queryChildInterface (UIDRef iid, void** ptr, bool recursive = false);

    template  <class Lambda>
    bool visitChildren (
        const Lambda& visitLambda,
        bool recursive
    ) const;

    void dump (int level = 0);
    virtual StringRef CCL_API getObjectID () const;
    virtual UIDRef CCL_API getObjectUID () const;
    virtual UIDRef CCL_API getClassUID () const;
    virtual IObjectNode*CCL_API getParent () const;
    virtual IObjectNode*CCL_API getRoot () const;
    virtual int CCL_API countChildren () const;
    virtual IObjectNode*CCL_API getChild (int index) const;
    virtual IObjectNode*CCL_API findChild (StringRef id) const;
    virtual tresult CCL_API initialize (IUnknown* context = nullptr) = 0;
    virtual tresult CCL_API terminate () = 0;
    virtual tbool CCL_API canTerminate () const = 0;
    virtual IUnknown*CCL_API getExtension (StringID id) = 0;

    template  <typename IFace>
    IFace* getExtensionI ();

    template  <typename IFace>
    static IFace* getExtensionI (IUnknown* unk);

    virtual int CCL_API countParameters () const = 0;
    virtual IParameter*CCL_API getParameterAt (int index) const = 0;
    virtual IParameter*CCL_API findParameter (StringID name) const = 0;
    virtual IParameter*CCL_API getParameterByTag (int tag) const = 0;
    virtual IUnknown*CCL_API getObject (StringID name, UIDRef classID) = 0;
    virtual tbool CCL_API paramChanged (IParameter* param) = 0;
    virtual void CCL_API paramEdit (IParameter* param, tbool begin) = 0;

    virtual IView*CCL_API createView (
        StringID name,
        VariantRef data,
        const Rect& bounds
    ) = 0;

    virtual tbool CCL_API checkCommandCategory (CStringRef category) const = 0;
    virtual tbool CCL_API interpretCommand (const CommandMsg& msg) = 0;
    virtual tresult CCL_API appendContextMenu (IContextMenu& contextMenu) = 0;
    DECLARE_CLASS (Component, ObjectNode);
    PROPERTY_FLAG (flags, kStorable, isStorable);
    isMutable StringRef getTitle () const;
    void setTitle (StringRef title);
    bool hasTitle () const;
    IUnknown* getContext () const;
    Component* getComponent (StringRef name) const;

    template  <class C>
    C* getComponent (StringRef name) const;

    bool addComponent (Component* c);
    bool addIComponent (IComponent* c);
    void signalHasChild (Component* c);
    Component* lookupComponent (StringRef path) const;

    template  <class C>
    C* lookupComponent (StringRef path) const;

    virtual tresult CCL_API initialize (IUnknown* context = nullptr);
    virtual tresult CCL_API terminate ();
    virtual tbool CCL_API canTerminate () const;
    virtual IUnknown*CCL_API getExtension (StringID id);
    DECLARE_PARAMETER_LOOKUP (paramList);
    virtual tbool CCL_API paramChanged (IParameter* param);
    virtual void CCL_API paramEdit (IParameter* param, tbool begin);

    virtual IView*CCL_API createView (
        StringID name,
        VariantRef data,
        const Rect& bounds
    );

    virtual tbool CCL_API checkCommandCategory (CStringRef category) const;
    virtual tbool CCL_API interpretCommand (const CommandMsg& msg);
    virtual tresult CCL_API appendContextMenu (IContextMenu& contextMenu);
    virtual ITheme* getTheme () const;
    virtual bool load (const Storage& storage);
    virtual bool save (const Storage& storage) const;
    virtual bool toString (String& string, int flags) const;
    void addObject (StringID name, IUnknown* object);
    void addObject (StringID name, Object* object);
    bool loadIdentity (const Storage& storage);
    bool saveIdentity (const Storage& storage) const;
    bool loadChild (const Storage& storage, Component& child);
    bool saveChild (const Storage& storage, const Component& child) const;

    bool loadChildren (
        const Storage& storage,
        bool loadEmpty = false,
        bool onlyStorable = false
    );

    bool saveChildren (const Storage& storage, bool onlyStorable = false) const;
    void signalHasChild (StringRef name);
    void signalPropertyChanged (StringID propertyID, bool deferred = false);
    void propertyChanged (StringID propertyID);
    IUnknown* resolveToOriginalContext (IUnknown* context);
    virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const;
    virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg);
    virtual IPreset*CCL_API openPreset (UrlRef url) = 0;
    virtual IPreset*CCL_API openPreset (const IFileDescriptor& descriptor) = 0;

    virtual IPreset*CCL_API openDefaultPreset (
        IPresetFileHandler& handler,
        IAttributeList* metaInfo
    ) = 0;

    virtual tbool CCL_API supportsFileType (const FileType& fileType) = 0;

    virtual IUnknownList*CCL_API getPresets (
        IAttributeList* metaInfo,
        IProgressNotify* progress = nullptr
    ) = 0;

    virtual void CCL_API getPresetsInBackground (
        IObserver* observer,
        IAttributeList* metaInfo
    ) = 0;

    virtual void CCL_API cancelGetPresets (IObserver* observer) = 0;
    virtual void CCL_API scanPresets (tbool onlyChangedLocations) = 0;

    virtual tbool CCL_API presetExists (
        IAttributeList* metaInfo,
        StringRef name,
        const FileType* fileType = nullptr
    ) = 0;

    virtual tbool CCL_API hasPresets (IAttributeList* metaInfo) = 0;
    virtual tbool CCL_API removePreset (IPreset& preset) = 0;

    virtual tbool CCL_API renamePreset (
        IPreset& preset,
        StringRef newName,
        IUrl* newUrl = nullptr
    ) = 0;

    virtual tbool CCL_API movePreset (IPreset& preset, StringRef newSubfolder) = 0;

    virtual void CCL_API addSortFolder (
        const IAttributeList& metaInfo,
        StringRef path
    ) = 0;

    virtual void CCL_API removeSortFolder (
        const IAttributeList& metaInfo,
        StringRef path
    ) = 0;

    virtual void CCL_API moveSortFolder (
        const IAttributeList& metaInfo,
        StringRef oldPath,
        StringRef newPath
    ) = 0;

    virtual void CCL_API renameSortFolder (
        const IAttributeList& metaInfo,
        StringRef path,
        StringRef newName
    ) = 0;

    virtual tbool CCL_API hasSortFolder (
        const IAttributeList& metaInfo,
        StringRef path
    ) const = 0;

    virtual IUnknownIterator*CCL_API getSortFolders (const IAttributeList& metaInfo) const = 0;
    virtual tbool CCL_API isFavorite (const IPreset& preset) const = 0;
    virtual StringRef CCL_API getFavoriteFolder (const IPreset& preset) const = 0;

    virtual void CCL_API setFavorite (
        const IPreset& preset,
        tbool state,
        StringRef folder = nullptr
    ) = 0;

    virtual IUnknownIterator*CCL_API getFavoritePresets (const IAttributeList& metaInfo) = 0;

    virtual void CCL_API addFavoriteFolder (
        const IAttributeList& metaInfo,
        StringRef path
    ) = 0;

    virtual void CCL_API removeFavoriteFolder (
        const IAttributeList& metaInfo,
        StringRef path
    ) = 0;

    virtual void CCL_API moveFavoriteFolder (
        const IAttributeList& metaInfo,
        StringRef oldPath,
        StringRef newPath
    ) = 0;

    virtual void CCL_API renameFavoriteFolder (
        const IAttributeList& metaInfo,
        StringRef path,
        StringRef newName
    ) = 0;

    virtual IUnknownIterator*CCL_API getFavoriteFolders (const IAttributeList& metaInfo) const = 0;

    virtual tbool CCL_API hasFavoriteFolder (
        const IAttributeList& metaInfo,
        StringRef path
    ) const = 0;

    virtual ISearcher*CCL_API createSearcher (ISearchDescription& description) = 0;
    virtual void CCL_API onPresetCreated (UrlRef url, IPreset& preset) = 0;
    virtual void CCL_API onPresetRemoved (UrlRef url, IPreset& preset) = 0;

    virtual void CCL_API collectSubFolders (
        IMutableArray& subFolders,
        const IAttributeList* metaInfo
    ) = 0;

    static T& instance ();
    static T* peekInstance ();
    static Object* __createSingleton ();
    bool dispatchCommand (const CommandMsg& msg);

    bool dispatchCommand (
        const CommandMsg& msg,
        CommandDispatchEntry <T> dispatchTable []
    );

    bool dispatchCommandWithAliases (const CommandMsg& msg);

Detailed Documentation

Methods

void startup ()

enables preset store; might do an initial preset scan

virtual IPreset*CCL_API openPreset (UrlRef url)

Open preset from given location.

virtual IPreset*CCL_API openPreset (const IFileDescriptor& descriptor)

Open preset from given descriptor.

virtual IPreset*CCL_API openDefaultPreset (
    IPresetFileHandler& handler,
    IAttributeList* metaInfo
)

Open default preset.

virtual tbool CCL_API supportsFileType (const FileType& fileType)

Check if file type is supported.

virtual IUnknownList*CCL_API getPresets (
    IAttributeList* metaInfo,
    IProgressNotify* progress
)

Get all presets that match the passed meta info.

virtual void CCL_API getPresetsInBackground (
    IObserver* observer,
    IAttributeList* metaInfo
)

Get all presets in background that match the passed meta info.

virtual void CCL_API cancelGetPresets (IObserver* observer)

Stop getting presets in background.

virtual void CCL_API collectSubFolders (
    IMutableArray& subFolders,
    const IAttributeList* metaInfo
)

Collect all distinct ocurring subFolder strings for the given meta info.

virtual ISearcher*CCL_API createSearcher (ISearchDescription& description)

Create preset searcher.

virtual tbool CCL_API presetExists (
    IAttributeList* metaInfo,
    StringRef name,
    const FileType* fileType = nullptr
)

Check if there is a preset with this name and meta info (and optional file type) already exists.

virtual tbool CCL_API hasPresets (IAttributeList* metaInfo)

Check if any preset exists with given meta info.

virtual tbool CCL_API removePreset (IPreset& preset)

Delete preset.

virtual tbool CCL_API renamePreset (
    IPreset& preset,
    StringRef newName,
    IUrl* newUrl = nullptr
)

Rename preset.

virtual void CCL_API scanPresets (tbool onlyChangedLocations)

Perform scan for presets.

virtual void CCL_API onPresetCreated (UrlRef url, IPreset& preset)

Inform preset manager that a new file was created.

virtual void CCL_API onPresetRemoved (UrlRef url, IPreset& preset)

Announce removal of the old preset (can be another file, when a factory preset gets replaced (hidden) by a user preset)

virtual tbool CCL_API movePreset (IPreset& preset, StringRef newSubfolder)

Move preset to another folder.

virtual void CCL_API addSortFolder (
    const IAttributeList& metaInfo,
    StringRef path
)

Manage sort folders per meta info.

virtual tbool CCL_API isFavorite (const IPreset& preset) const

Favorite presets per meta info.

virtual tbool CCL_API hasFavoriteFolder (
    const IAttributeList& metaInfo,
    StringRef path
) const

empty path: has any favorites

virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg)

Call method.