class CCL::EditTool

Overview

Editing Tool base class. More…

#include <edittool.h>

class EditTool: public CCL::Object
{
public:
    // fields

    StringRef title = nullptr);
     kCrossCursor;
    wantsCrossCursor ignoreModifier;

    // methods

    DECLARE_CLASS (EditTool, Object);
    PROPERTY_STRING (title, Title);
    Name PROPERTY_MUTABLE_CSTRING (cursorName, CursorName);
    Name IconName PROPERTY_SHARED_AUTO (IImage, icon, Icon);
    PROPERTY_VARIABLE (int, flags, Flags);
    wantsCrossCursor PROPERTY_FLAG (flags, kIgnoresModeIcons, ignoresModeIcons);
    wantsCrossCursor IgnoreModifier void addMode (EditToolMode* mode);
    const ObjectList& getModes () const;
    bool setActiveMode (StringID name);
    StringID getActiveMode () const;
    EditTool* getActiveModeHandler ();
    IMouseCursor* getMouseCursor () const;
    void setMouseCursor (IMouseCursor* cursor);
    virtual void onAttached (EditView& editView, bool state);
    virtual bool onContextMenu (IContextMenu& contextMenu);
    virtual bool extendModeMenu (IMenu& menu);
    virtual void mouseEnter (EditView& editView, const MouseEvent& mouseEvent);
    virtual void mouseMove (EditView& editView, const MouseEvent& mouseEvent);
    virtual void mouseLeave (EditView& editView, const MouseEvent& mouseEvent);

    virtual EditHandler* mouseDown (
        EditView& editView,
        const MouseEvent& mouseEvent
    );

    virtual ITouchHandler* createTouchHandler (
        EditView& editView,
        const TouchEvent& event
    );

    virtual String getTooltip ();

    virtual IPresentable* createHelpInfo (
        EditView& editView,
        const MouseEvent& mouseEvent
    );
};

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

Editing Tool base class.

Methods

Name PROPERTY_MUTABLE_CSTRING (cursorName, CursorName)

< internal tool name

Name IconName PROPERTY_SHARED_AUTO (IImage, icon, Icon)

< icon name

wantsCrossCursor IgnoreModifier void addMode (EditToolMode* mode)

< modfier keys processed by tool (should be ignored elsewhere)

EditTool* getActiveModeHandler ()

returns a handler of the active mode, or this