class CCL::ActionExecuter

Overview

#include <actionexecuter.h>

class ActionExecuter:
    public CCL::Object,
    public CCL::IActionExecuter
{
public:
    // structs

    struct JournalDisabler;

    // classes

    class MergeBlocker;

    // fields

     IActionExecuter;

    // methods

    DECLARE_CLASS (ActionExecuter, Object);
    IActionContext* getActionContext () const;
    virtual void setActionContext (IActionContext* context);
    operator IActionContext * () const;
    virtual bool execute (Action* action);

    template  <typename Lambda>
    bool executeAdHoc (const Lambda& perform);

    bool isMultiplePending () const;
    bool isPerformingAction () const;
    bool isInAction () const;

    virtual Action* beginMultiple (
        StringRef description,
        StringRef details = nullptr
    );

    virtual bool endMultiple (bool cancel = false);
    Action* beginMultiAction (Action* multiAction);
    void setMultipleDescription (StringRef description, StringRef details = nullptr);
    void preventMerge ();
    void takeFlags (const ActionExecuter& from);
    PROPERTY_BOOL (executeImmediately, ExecuteImmediately);
    SuppressSideEffects PROPERTY_BOOL (directEditMode, DirectEditMode);

    virtual tbool CCL_API beginMultiAction (
        StringRef description,
        StringRef details = nullptr
    );

    virtual tbool CCL_API endMultiAction (tbool cancel = false);
    virtual void CCL_API setExecuteActionImmediately (tbool state);
    virtual tbool CCL_API isExecuteActionImmediately () const;
    virtual void CCL_API setJournalEnabled (tbool enabled);
    virtual tbool CCL_API isJournalEnabled () const;
    static ActionExecuter* createInstance (IActionContext* context, UIDRef cid);
};

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 tbool CCL_API beginMultiAction (
        StringRef description,
        StringRef details = nullptr
    ) = 0;

    virtual tbool CCL_API endMultiAction (tbool cancel = false) = 0;
    virtual void CCL_API setExecuteActionImmediately (tbool state) = 0;
    virtual tbool CCL_API isExecuteActionImmediately () const = 0;
    virtual void CCL_API setJournalEnabled (tbool enabled) = 0;
    virtual tbool CCL_API isJournalEnabled () const = 0;

Detailed Documentation

Methods

template  <typename Lambda>
bool executeAdHoc (const Lambda& perform)

execute the given lambda as part of an action sequence (only once, no undo)

bool isInAction () const

isPerformingAction or isMultiplePending

void setMultipleDescription (StringRef description, StringRef details = nullptr)

for a pending multi action

void preventMerge ()

prevent merge in current multi action

PROPERTY_BOOL (executeImmediately, ExecuteImmediately)