class CCL::ToolTouchHandler

Overview

#include <toolaction.h>

class ToolTouchHandler: public CCL::UserControl::TouchMouseHandler
{
public:
    // methods

    DECLARE_CLASS_ABSTRACT (ToolTouchHandler, TouchMouseHandler);
    ToolActionList& getActions ();
    void prepareGestures ();
    PROPERTY_BOOL (translateHoverEvents, TranslateHoverEvents) const;
    virtual bool onHover (const TouchEvent& event);
    virtual void onBegin (const TouchEvent& event);
    virtual bool onMove (const TouchEvent& event);
    virtual tbool CCL_API addTouch (const TouchEvent& event);
    virtual tbool CCL_API allowsCompetingGesture (int gestureType);
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // structs

    struct GestureItem;

    // fields

     ITouchHandler;

    // 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 void CCL_API begin (const TouchEvent& event) = 0;
    virtual tbool CCL_API addTouch (const TouchEvent& event) = 0;
    virtual tbool CCL_API trigger (const TouchEvent& event) = 0;
    virtual void CCL_API finish (const TouchEvent& event, tbool canceled = false) = 0;

    virtual tbool CCL_API getRequiredGesture (
        int& gestureType,
        int& priority,
        int index
    ) = 0;

    virtual tbool CCL_API onGesture (const GestureEvent& event) = 0;
    virtual tbool CCL_API allowsCompetingGesture (int gestureType) = 0;
    IView* getView () const;

    void addRequiredGesture (
        int gestureType,
        int priority = GestureEvent::kPriorityNormal
    );

    virtual void CCL_API begin (const TouchEvent& event);
    virtual tbool CCL_API addTouch (const TouchEvent& event);
    virtual tbool CCL_API trigger (const TouchEvent& event);
    virtual void CCL_API finish (const TouchEvent& event, tbool canceled = false);

    virtual tbool CCL_API getRequiredGesture (
        int& gestureType,
        int& priority,
        int index
    );

    virtual tbool CCL_API onGesture (const GestureEvent& event);
    virtual tbool CCL_API allowsCompetingGesture (int gestureType);
    virtual bool onHover (const TouchEvent& event);
    virtual void onBegin (const TouchEvent& event);
    virtual bool onMove (const TouchEvent& event);
    virtual void onRelease (const TouchEvent& event, bool canceled);

    static MouseEvent makeMouseEvent (
        int eventType,
        const TouchEvent& event,
        IView& view
    );

    static MouseEvent makeMouseEvent (
        int eventType,
        const GestureEvent& event,
        IView& view
    );

    static MouseEvent makeMouseEvent (int eventType, const GestureEvent& event);

    static void triggerSingleClick (
        IMouseHandler& handler,
        const GestureEvent& event,
        IView& view
    );

    virtual void onBegin (const TouchEvent& event);
    virtual bool onMove (const TouchEvent& event);
    virtual void onRelease (const TouchEvent& event, bool canceled);
    UserControl& getControl () const;

Detailed Documentation

Methods

virtual tbool CCL_API addTouch (const TouchEvent& event)

Accept an additional touch or return false.

virtual tbool CCL_API allowsCompetingGesture (int gestureType)

Query if handler wants to pass handling of the given gesture to another handler (e.g.

when touches are added / removed).