struct CCL::IImagePalette

Overview

#include <ipalette.h>

struct IImagePalette: public CCL::IPalette
{
    // enums

    enum Options;

    // methods

    virtual tbool CCL_API fromStyle (const IVisualStyle& style) = 0;

    virtual tbool CCL_API addImages (
        StringID skinID,
        StringRef folderName,
        int options = kAddRecursive,
        ITranslationTable* stringTable = nullptr,
        StringID scope = nullptr
    ) = 0;

    virtual tbool CCL_API addImages (
        UrlRef path,
        int options = kAddRecursive,
        ITranslationTable* stringTable = nullptr,
        StringID scope = nullptr
    ) = 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;
    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;

Detailed Documentation

Methods

virtual tbool CCL_API fromStyle (const IVisualStyle& style) = 0

Get dimensions and images from visual style.

virtual tbool CCL_API addImages (
    StringID skinID,
    StringRef folderName,
    int options = kAddRecursive,
    ITranslationTable* stringTable = nullptr,
    StringID scope = nullptr
) = 0

Add images from skin folder.

virtual tbool CCL_API addImages (
    UrlRef path,
    int options = kAddRecursive,
    ITranslationTable* stringTable = nullptr,
    StringID scope = nullptr
) = 0

Add images from file system location.