struct CCL::IScrollView

Overview

Scroll view interface. More…

#include <iscrollview.h>

struct IScrollView: public CCL::IUnknown
{
    // methods

    virtual tresult CCL_API construct (IView* target) = 0;
    virtual IView*CCL_API getTargetView () const = 0;
    virtual Rect&CCL_API getScrollSize (Rect& r) const = 0;
    virtual void CCL_API setTargetSize (const Rect& r) = 0;
    virtual const Point&CCL_API getSnap () const = 0;
    virtual void CCL_API setSnap (const Point& snap) = 0;
    virtual void CCL_API setVScrollParam (IParameter* param) = 0;
    virtual void CCL_API setHScrollParam (IParameter* param) = 0;
    virtual IParameter*CCL_API getVScrollParam () = 0;
    virtual IParameter*CCL_API getHScrollParam () = 0;

    virtual void CCL_API scrollTo (
        PointRef targetPos,
        double duration = 0.,
        float velocity = 0.
    ) = 0;

    virtual void CCL_API getPosition (Point& targetPos) const = 0;
    virtual void CCL_API stopAnimations () = 0;
    DECLARE_STRINGID_MEMBER (kOnScrollBegin);
};

Inherited Members

public:
    // 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;

Detailed Documentation

Scroll view interface.

Methods

virtual tresult CCL_API construct (IView* target) = 0

Initialize with target view.

virtual IView*CCL_API getTargetView () const = 0

Get target view.

virtual Rect&CCL_API getScrollSize (Rect& r) const = 0

Get size of scroll area.

virtual void CCL_API setTargetSize (const Rect& r) = 0

Resize target.

virtual const Point&CCL_API getSnap () const = 0

Get snap.

virtual void CCL_API setSnap (const Point& snap) = 0

Set snap.

virtual void CCL_API setVScrollParam (IParameter* param) = 0

Set vertical scroll parameter.

virtual void CCL_API setHScrollParam (IParameter* param) = 0

Set horizontal scroll parameter.

virtual IParameter*CCL_API getVScrollParam () = 0

Get vertical scroll parameter.

virtual IParameter*CCL_API getHScrollParam () = 0

Get horizontal scroll parameter.

virtual void CCL_API scrollTo (
    PointRef targetPos,
    double duration = 0.,
    float velocity = 0.
) = 0

Scroll target to position, animated if duration > 0.

virtual void CCL_API getPosition (Point& targetPos) const = 0

Get current target position, could be animated!

virtual void CCL_API stopAnimations () = 0

Stop running animations.

DECLARE_STRINGID_MEMBER (kOnScrollBegin)

< msg[0]: targetPos.x, msg[1]: targetPos.y