struct CCL::IScrollParameter

Overview

#include <iparameter.h>

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

    virtual float CCL_API getPageSize () const = 0;
    virtual void CCL_API setPageSize (float pageSize) = 0;
    virtual void CCL_API setRange (int range, float pageSize = 0.f) = 0;
    virtual tbool CCL_API canScroll () const = 0;
    DECLARE_STRINGID_MEMBER (kStopAnimations);
};

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

Methods

virtual float CCL_API getPageSize () const = 0

Get page size (normalized 0..1).

virtual void CCL_API setPageSize (float pageSize) = 0

Set page size (normalized 0..1).

virtual void CCL_API setRange (int range, float pageSize = 0.f) = 0

Set scroll range and page size.

virtual tbool CCL_API canScroll () const = 0

Check if scrolling possible.

DECLARE_STRINGID_MEMBER (kStopAnimations)

< signal animation towards the parameter value started

< signal animation towards the parameter value ended