struct CCL::IPalette

Overview

#include <ipalette.h>

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

    virtual int CCL_API getCount () const = 0;
    virtual Variant CCL_API getAt (int index) const = 0;
    virtual int CCL_API getIndex (VariantRef element) const = 0;

    virtual tbool CCL_API getDimensions (
        int& columns,
        int& cellWidth,
        int& cellHeight
    ) const = 0;

    virtual IImage*CCL_API createIcon (
        int index,
        int width,
        int height,
        const IVisualStyle& style
    ) const = 0;

    virtual tbool CCL_API getTitle (String& title, int index) const = 0;
    virtual tbool CCL_API getID (MutableCString& id, int index) const = 0;
    virtual tbool CCL_API getCategory (String& category, int index) const = 0;
    virtual tbool CCL_API isEnabled (int index) const = 0;
};

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 int CCL_API getCount () const = 0

Get number of elements.

virtual Variant CCL_API getAt (int index) const = 0

Get element at index.

virtual int CCL_API getIndex (VariantRef element) const = 0

Get index of element.

virtual tbool CCL_API getDimensions (
    int& columns,
    int& cellWidth,
    int& cellHeight
) const = 0

Get display dimensions.

virtual IImage*CCL_API createIcon (
    int index,
    int width,
    int height,
    const IVisualStyle& style
) const = 0

Create icon for element.

virtual tbool CCL_API getTitle (String& title, int index) const = 0

Get title of element (optional).

virtual tbool CCL_API getID (MutableCString& id, int index) const = 0

Get identifier of element (optional).

virtual tbool CCL_API getCategory (String& category, int index) const = 0

Get category of element (optional).

virtual tbool CCL_API isEnabled (int index) const = 0

Check if element is enabled.