class CCL::PresetComponent
Overview
Preset component using IPreset, IPresetFileHandler, etc. More…
#include <presetcomponent.h> class PresetComponent: public CCL::PresetManagementComponent, public CCL::IDataTarget { public: // enums enum Options; // classes class PresetDragControl; // fields kMediatorInformsRestore; mediatorInformsRestore kDisableBrowserCommands; mediatorInformsRestore disableBrowserCommands kDisableBrowserContextMenus; mediatorInformsRestore disableBrowserCommands disableBrowserContextMenus kEnableBrowserSearch; mediatorInformsRestore disableBrowserCommands disableBrowserContextMenus enableBrowserSearch kEnableBrowserSourceFilter; IDataTarget; // methods DECLARE_CLASS (PresetComponent, PresetManagementComponent); bool askPresetInfo (PresetMetaAttributes& metaAttributes); DECLARE_STRINGID_MEMBER (kFilePreset); PROPERTY_FLAG (options, kHasPresetInfo, hasPresetInfo); mediatorInformsRestore PROPERTY_FLAG ( options, kBrowserAcceptOnMouseDown, browserAcceptOnMouseDown ); mediatorInformsRestore disableBrowserCommands PROPERTY_FLAG ( options, kEnableDirtyTimeout, enableDirtyTimeout ); mediatorInformsRestore disableBrowserCommands disableBrowserContextMenus PROPERTY_FLAG ( options, kDisableBrowserAutoSelection, disableBrowserAutoSelection ); mediatorInformsRestore disableBrowserCommands disableBrowserContextMenus enableBrowserSearch PROPERTY_FLAG ( options, kAskBeforePresetDeletion, askBeforePresetDeletion ); mediatorInformsRestore disableBrowserCommands disableBrowserContextMenus enableBrowserSearch enableBrowserSourceFilter tbool writePreset ( UrlRef url, IAttributeList& metaInfo, IPresetFileHandler& handler, int notificationHint ); IPreset* openPreset (UrlRef url); IPreset* openDefaultPreset (); tbool restorePreset (UrlRef url); tbool restorePreset (IPreset* preset); Attributes* createMetaInfo (); void getCheckedPresetsFromBrowser (Vector <IPreset*>& checkedPresets) const; void finishObjectPreset (ObjectPreset& preset); String makeUniquePresetName (const FileType* fileType = nullptr); IUnknown* getTarget (); IPresetMediator* getPresetMediator (); void setPresetMediator (IPresetMediator* pm); IPresetFileHandler& getPresetHandler (); PresetBrowser* getPresetBrowser () const; void onPresetRestored (const IPreset& preset); IDragHandler* createDragHandler (const DragEvent& event, IView* view); bool storePreset (IAttributeList& metaAttributes, int mode, StringID format); bool storePreset (IAttributeList& metaAttributes, int mode); void onPresetBrowserOpened (); void onPresetBrowserClosed (bool success); virtual tbool CCL_API canInsertData ( const IUnknownList& data, IDragSession* session = nullptr, IView* targetView = nullptr, int insertIndex = -1 ); virtual tbool CCL_API insertData ( const IUnknownList& data, IDragSession* session = nullptr, int insertIndex = -1 ); virtual tbool storePreset ( int mode = kStoreNewPreset, StringID toFormat = nullptr ); virtual void setCurrentPresetName (StringRef presetName); virtual void resetCurrentPreset (StringRef presetName); virtual void extendPresetMenu (IMenu* menu); virtual bool renamePreset (bool checkOnly); virtual bool deletePreset (bool checkOnly); virtual bool onSetFavorite (CmdArgs args); virtual IUnknown*CCL_API getObject (StringID name, UIDRef classID); virtual IView*CCL_API createView ( StringID name, VariantRef data, const Rect& bounds ); virtual tbool CCL_API paramChanged (IParameter* param); virtual bool isFactoryPreset (UrlRef presetUrl) const; static bool askPresetInfo ( PresetMetaAttributes& metaAttributes, const Attributes* metaInfo ); static IPresetFileHandler& getPresetHandler (StringID presetType); };
Inherited Members
public: // typedefs typedef CStringRef MemberID; // enums enum Flags; enum Options; enum StorePresetMode; // structs struct ObjectEntry; struct GUIActionScope; // fields IObjectNode; StringRef title = nullptr); kMutable; UIDRef classID override; CLASS_INTERFACES (ObjectNode) protected String title; ParamContainer paramList; SignalSlotList signalSlots; LinkedList <ObjectEntry> objects; kCanStoreAsDefault; canStoreAsDefault kCanRenamePreset; canStoreAsDefault canRenamePreset kHasPresetFavorites; // 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); bool dispatchCommand (const CommandMsg& msg); bool dispatchCommand ( const CommandMsg& msg, CommandDispatchEntry <T> dispatchTable [] ); bool dispatchCommandWithAliases (const CommandMsg& msg); DECLARE_CLASS_ABSTRACT (PresetManagementComponent, Component); PROPERTY_VARIABLE (int, options, Options); canStoreAsDefault PROPERTY_FLAG (options, kCanReplacePreset, canReplacePreset); canStoreAsDefault canRenamePreset PROPERTY_FLAG ( options, kCanDeletePreset, canDeletePreset ); virtual void resetCurrentPreset (StringRef presetName); virtual void extendPresetMenu (IMenu* menu); virtual tbool storePreset ( int mode = kStoreNewPreset, StringID toFormat = nullptr ) = 0; virtual bool renamePreset (bool checkOnly) = 0; virtual bool deletePreset (bool checkOnly) = 0; virtual bool isFactoryPreset (UrlRef presetUrl) const; IParameter* getPresetNameParam () const; virtual String getCurrentPresetName () const; virtual void setCurrentPresetName (StringRef presetName); UrlRef getCurrentPresetUrl () const; void takeDataFrom (const PresetManagementComponent& other); void enable (bool state); bool isEnabled () const; bool isDirty () const; void setDirty (bool state); virtual tbool CCL_API paramChanged (IParameter* param); virtual void CCL_API notify (ISubject* subject, MessageRef msg); virtual bool load (const Storage& storage); virtual bool save (const Storage& storage) const; DECLARE_COMMANDS (PresetManagementComponent); Component bool onStorePreset (CmdArgs args); bool onStorePresetAs (CmdArgs args, VariantRef data); bool onStoreAsDefaultPreset (CmdArgs args); bool onRenamePreset (CmdArgs args); bool onDeletePreset (CmdArgs args); virtual bool onSetFavorite (CmdArgs args); static bool askPresetName (String& presetName); static IAsyncOperation* askPresetNameAsync (StringRef initialName); static bool askRemovePreset (bool singular, StringRef description); static String getStorePresetTitle (bool follow = false); static String getLoadPresetTitle (); static String getDeletePresetTitle (); static String getRenamePresetTitle (); static String getPresetExistsMessage (); static String getDefaultPresetName (); static String getUpdatePresetTitle (); static bool isInGUIActionScope (); virtual tbool CCL_API canInsertData ( const IUnknownList& data, IDragSession* session = nullptr, IView* targetView = nullptr, int insertIndex = -1 ) = 0; virtual tbool CCL_API insertData ( const IUnknownList& data, IDragSession* session = nullptr, int insertIndex = -1 ) = 0;
Detailed Documentation
Preset component using IPreset, IPresetFileHandler, etc.
Methods
bool askPresetInfo (PresetMetaAttributes& metaAttributes)
ask for preset name and other info
tbool restorePreset (IPreset* preset)
0: default preset
virtual tbool CCL_API canInsertData ( const IUnknownList& data, IDragSession* session = nullptr, IView* targetView = nullptr, int insertIndex = -1 )
Check if data can be inserted.
virtual tbool CCL_API insertData ( const IUnknownList& data, IDragSession* session = nullptr, int insertIndex = -1 )
Insert data.
virtual IUnknown*CCL_API getObject (StringID name, UIDRef classID)
Get object by name and class id.
virtual tbool CCL_API paramChanged (IParameter* param)
The given parameter changed its value, usually caused by user interaction.