class CCL::EditTask

Overview

Base class for native edit tasks. More…

#include <edittask.h>

class EditTask:
    public CCL::Object,
    public CCL::IEditTask,
    public CCL::IParamObserver
{
public:
    // methods

    DECLARE_CLASS (EditTask, Object) const;
    PROPERTY_VARIABLE (MutableCString, formName, FormName) const;
    virtual tresult CCL_API prepareEdit (IObject& context);
    virtual tresult CCL_API performEdit (IObject& context);
    virtual tbool CCL_API paramChanged (IParameter* param);
    virtual void CCL_API paramEdit (IParameter* param, tbool begin);
    virtual CLASS_INTERFACES (Object) protected void construct (IObject& context);
    virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const;
    bool isSilentMode (IObject& context) const;
    IAttributeList* getArguments (IObject& context) const;
    void restore (IObject& context);

    tresult runDialog (
        IObject& context,
        StringID formName,
        StringID themeID = nullptr
    );

    EditView* getEditView (IObject& context) const;
    EditModel* getEditModel (IObject& context) const;
    EditorComponent* getEditor (IObject& context) const;
    EditEnvironment* getEditEnvironment (IObject& context) const;
    Iterator* getIterator (IObject& context) const;
    ActionExecuter* getFunctions (IObject& context) const;
    IActionContext* getActionContext (IObject& context) const;

    bool collectEditItems (
        Container& items,
        IObject& context,
        MetaClassRef type,
        IObjectFilter* filter = nullptr
    ) const;

    template  <class T>
    T* getEditView (IObject& context) const;

    template  <class T>
    T* getEditModel (IObject& context) const;

    template  <class T>
    T* getEditor (IObject& context) const;

    template  <class T>
    T* getFunctions (IObject& context) const;

    template  <class T>
    bool collectEditItems (
        Container& items,
        IObject& context,
        IObjectFilter* filter = nullptr
    ) const;
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // 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 tresult CCL_API prepareEdit (IObject& context) = 0;
    virtual tresult CCL_API performEdit (IObject& context) = 0;
    DECLARE_STRINGID_MEMBER (kFormName);
    virtual tbool CCL_API paramChanged (IParameter* param) = 0;
    virtual void CCL_API paramEdit (IParameter* param, tbool begin) = 0;

Detailed Documentation

Base class for native edit tasks.

Methods

DECLARE_CLASS (EditTask, Object) const

get title of this task from class description

virtual tresult CCL_API prepareEdit (IObject& context)

Show configuration dialog, etc.

virtual tresult CCL_API performEdit (IObject& context)

Perform actual task, context contains objects relevant for editing.

virtual tbool CCL_API paramChanged (IParameter* param)

The given parameter changed its value, usually caused by user interaction.

virtual void CCL_API paramEdit (IParameter* param, tbool begin)

The user started or ended editing the value.

virtual CLASS_INTERFACES (Object) protected void construct (IObject& context)

overwrite to build parameters, etc.

virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const

Get property value by name.

bool collectEditItems (
    Container& items,
    IObject& context,
    MetaClassRef type,
    IObjectFilter* filter = nullptr
) const

uses iterator to collect items of given class