class CCL::EditItemIndicator

Overview

Displays a sprite over the edit item under the mouse. More…

#include <editdraghandler.h>

class EditItemIndicator: public CCL::EditDragHandler
{
public:
    // classes

    class ItemDrawable;

    // fields

     dragResultVoid;
    dragResultVoid keepSpriteBelowChild;

    // methods

    DECLARE_CLASS_ABSTRACT (EditItemIndicator, EditDragHandler);
    PROPERTY_MUTABLE_CSTRING (styleName, StyleName);
    dragResultVoid PROPERTY_VARIABLE (int, dragResultOnItem, DragResultOnitem);
    dragResultVoid keepSpriteBelowChild Object* findItem (const DragEvent& event) const;
    bool hasMatchingTargetItem (const DragEvent& event) const;
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // fields

     spriteOffset;
     childOffset;
     IDragHandler;

    // 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 dragEnter (const DragEvent& event) = 0;
    virtual tbool CCL_API dragOver (const DragEvent& event) = 0;
    virtual tbool CCL_API dragLeave (const DragEvent& event) = 0;
    virtual tbool CCL_API drop (const DragEvent& event) = 0;
    virtual tbool CCL_API afterDrop (const DragEvent& event) = 0;
    virtual tbool CCL_API hasVisualFeedback () const = 0;
    virtual tbool CCL_API isNullHandler () const = 0;
    virtual tbool CCL_API wantsAutoScroll () const = 0;
    PROPERTY_POINTER (ISprite, sprite, Sprite);
    SpriteOffset void moveSprite (PointRef where);
    void moveSprite (RectRef rect);
    virtual void moveSprite (const DragEvent& event);
    void hideSprite ();
    void deleteSprite ();
    virtual tbool CCL_API dragEnter (const DragEvent& event);
    virtual tbool CCL_API dragOver (const DragEvent& event);
    virtual tbool CCL_API dragLeave (const DragEvent& event);
    virtual tbool CCL_API drop (const DragEvent& event);
    virtual tbool CCL_API afterDrop (const DragEvent& event);
    virtual tbool CCL_API hasVisualFeedback () const;
    virtual tbool CCL_API isNullHandler () const;
    virtual tbool CCL_API wantsAutoScroll () const;
    DECLARE_CLASS (DragHandler, Object);
    IView* getView () const;
    SpriteBuilder& getSpriteBuilder ();
    void buildSprite (int options = 0);
    void replaceSpriteItemText (int index, StringRef text);
    const UnknownList& getData () const;
    virtual void addDataItems (const IUnknownList& items, IUnknown* context);

    virtual bool prepare (
        const IUnknownList& items,
        IDragSession* session = nullptr
    );

    virtual void postProcessData ();
    PROPERTY_AUTO_POINTER (IDragHandler, childDragHandler, ChildDragHandler);
    virtual ChildOffset bool getHelp (IHelpInfoBuilder& helpInfo);
    virtual tbool CCL_API dragEnter (const DragEvent& event);
    virtual tbool CCL_API dragOver (const DragEvent& event);
    virtual tbool CCL_API dragLeave (const DragEvent& event);
    virtual tbool CCL_API drop (const DragEvent& event);
    virtual tbool CCL_API afterDrop (const DragEvent& event);
    DECLARE_CLASS_ABSTRACT (EditDragHandler, DragHandler);
    EditView& getEditView () const;
    EditModel& getModel () const;
    bool isOnSourceView (const DragEvent& event) const;
    void setEditTooltip (StringRef tooltip);
    void hideEditTooltip ();
    virtual tbool CCL_API dragLeave (const DragEvent& event);
    virtual tbool CCL_API drop (const DragEvent& event);

Detailed Documentation

Displays a sprite over the edit item under the mouse.

To be used as child draghandler.

Methods

dragResultVoid keepSpriteBelowChild Object* findItem (const DragEvent& event) const

< try to keep a sprite of a childDraghandler above ours (enabled by default)

caller owns item