class CCL::EditHandler

Overview

Mouse handler base class for graphical editing operations. More…

#include <edithandler.h>

class EditHandler: public CCL::UserControl::MouseHandler
{
public:
    // fields

     ignoreModifier;

    // methods

    DECLARE_CLASS (EditHandler, MouseHandler);
    PROPERTY_SHARED_AUTO (IEditHandlerHook, hook, Hook);
    IgnoreModifier PROPERTY_BOOL (wantsCrossCursor, WantsCrossCursor);
    void setEditTooltip (StringRef tooltip);
    void hideEditTooltip ();
    EditView* getEditView () const;
    void setHookFromArgument (MessageRef msg, int argumentIndex);
    virtual void onRelease (bool canceled);
    virtual bool getHelp (IHelpInfoBuilder& helpInfo);
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // enums

    enum CheckFlags;
    enum MoveFlags;

    // fields

     kPeriodic;
    periodic kNullHandler;
    periodic isNullHandler kAutoScrollH;
    periodic isNullHandler autoScrollH kBeginAtCurrentPos;
    int flags = 0);
     IMouseHandler;

    // 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 int CCL_API getFlags () const = 0;
    virtual void CCL_API begin (const MouseEvent& event) = 0;
    virtual tbool CCL_API trigger (const MouseEvent& event, int moveFlags) = 0;
    virtual tbool CCL_API triggerKey (const KeyEvent& event) = 0;
    virtual void CCL_API finish (const MouseEvent& event, tbool canceled = false) = 0;
    PROPERTY_FLAG (flags, kCheckKeys, checkKeys);
    periodic PROPERTY_FLAG (flags, kCanEscape, canEscape);
    periodic isNullHandler PROPERTY_FLAG (flags, kAutoScrollV, autoScrollV);

    periodic isNullHandler autoScrollH PROPERTY_FLAG (
        flags,
        kAutoScroll,
        autoScroll
    );

    virtual periodic isNullHandler autoScrollH beginAtCurrentPos int CCL_API getFlags () const;
    virtual void CCL_API begin (const MouseEvent& event);
    virtual tbool CCL_API trigger (const MouseEvent& event, int moveFlags);
    virtual tbool CCL_API triggerKey (const KeyEvent& event);
    virtual void CCL_API finish (const MouseEvent& event, tbool canceled = false);
    virtual void onBegin ();
    virtual bool onMove (int moveFlags);
    virtual void onRelease (bool canceled);
    virtual bool onKeyEvent (const KeyEvent& event);
    DECLARE_CLASS (MouseHandler, Object);
    UserControl* getControl () const;
    virtual void CCL_API begin (const MouseEvent& event);

Detailed Documentation

Mouse handler base class for graphical editing operations.

Methods

virtual void onRelease (bool canceled)

needs to be called from derived classes