class CCL::EditTaskHandler

Overview

Helper class to run edit tasks. More…

#include <edittaskhandler.h>

class EditTaskHandler: public CCL::Object
{
public:
    // structs

    struct DragInfo;

    // fields

    const EditTaskDescription& description;

    // methods

    DECLARE_CLASS_ABSTRACT (EditTaskHandler, Object);
    PROPERTY_BOOL (silentMode, SilentMode);
    Persistent PROPERTY_SHARED_AUTO (Attributes, savedValues, SavedValues) const;
    tresult prepareTask (IObject* editor);
    IView* createTaskView ();
    tresult performTask (const Container& candidates, IObject* editor);
    tresult runTask (const Container& candidates, IObject* editor);
    tresult runArgumentDialog ();
    static bool canCreateTask (EditTaskDescription& description, IUnknown* object);
    static EditTaskHandler* createTask (IUnknown* object);
    static EditTaskHandler* createTask (const EditTaskDescription& description);
    static bool isRunningTask ();
};

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 ();

Detailed Documentation

Helper class to run edit tasks.

Methods

DECLARE_CLASS_ABSTRACT (EditTaskHandler, Object)

Handler takes ownership of task.

Persistent PROPERTY_SHARED_AUTO (Attributes, savedValues, SavedValues) const

Get task description.

tresult prepareTask (IObject* editor)

Prepare task (but not perform).

IView* createTaskView ()

Create view for task (must be prepared first).

tresult performTask (const Container& candidates, IObject* editor)

Perform task (must be prepared first).

tresult runTask (const Container& candidates, IObject* editor)

Run task (prepare + perform).

tresult runArgumentDialog ()

Run dialog only (used by EditTaskArgumentUI).

static bool canCreateTask (EditTaskDescription& description, IUnknown* object)

Check if task can be created from IUnknown.

static EditTaskHandler* createTask (IUnknown* object)

Create task from IUnknown.

static EditTaskHandler* createTask (const EditTaskDescription& description)

Create task from description.

static bool isRunningTask ()

True inside runTask.