struct CCL::IColorScheme

Overview

#include <icolorscheme.h>

struct IColorScheme: public CCL::IUnknown
{
    // enums

    enum UpdateMode;

    // methods

    virtual StringID CCL_API getName () const = 0;
    virtual float CCL_API getLevel (StringID id) const = 0;

    virtual void CCL_API setLevel (
        StringID id,
        float value,
        int updateMode = kDetect
    ) = 0;

    virtual Color CCL_API getColor (
        StringID name,
        ColorRef defaultColor = Colors::kBlack
    ) const = 0;

    virtual void CCL_API setDefaultLevel (StringID id, float value) = 0;
    virtual void CCL_API resetToDefaults () = 0;
    DECLARE_STRINGID_MEMBER (kPersistentPrefix);
};

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 StringID CCL_API getName () const = 0

Get color scheme name.

virtual float CCL_API getLevel (StringID id) const = 0

Get level with given identifier (hue, saturation, etc.).

virtual void CCL_API setLevel (
    StringID id,
    float value,
    int updateMode = kDetect
) = 0

Set level with given identifier.

virtual Color CCL_API getColor (
    StringID name,
    ColorRef defaultColor = Colors::kBlack
) const = 0

Get current color by name.

virtual void CCL_API setDefaultLevel (StringID id, float value) = 0

Configure given default level.

virtual void CCL_API resetToDefaults () = 0

Reset all levels to default.

DECLARE_STRINGID_MEMBER (kPersistentPrefix)

< dependency on main scheme (1 or 0)