IPalette Class Reference

Provides access to members that manage a palette. More...

#include <sdl_interface.h>

Inherits ISDKComponent.

Public Member Functions
virtual SDKResult SDK_CALLTYPE	EnumColorNames (IEnumSDKStringSP &color_names)=0 throw ()
	Returns the enumerator of the color names included in the palette. More...
virtual SDKResult SDK_CALLTYPE	GetColor (const SDKString &color_name, SDKUInt32 &argb)=0 throw ()
	Returns a color value for the specified color. More...
virtual SDKResult SDK_CALLTYPE	SetColor (const SDKString &color_name, SDKUInt32 argb)=0 throw ()
	Adds or replaces a color value for the specified color. More...

Detailed Description

Provides access to members that manage a palette.

Member Function Documentation

EnumColorNames()

virtual SDKResult SDK_CALLTYPE EnumColorNames ( IEnumSDKStringSP &  color_names ) throw ( )

pure virtual

Returns the enumerator of the color names included in the palette.

Parameters

[in]

color_names

The color names enumerator.

Returns

Ok if succeeded.

GetColor()

virtual SDKResult SDK_CALLTYPE GetColor ( const SDKString &  color_name, SDKUInt32 &  argb  ) throw ( )

pure virtual

Returns a color value for the specified color.

Parameters

[in]	color_name	The color name.
[out]	argb	ARGB color value.

Returns

Ok if succeeded.

Err_InvalidArg

SetColor()

virtual SDKResult SDK_CALLTYPE SetColor ( const SDKString &  color_name, SDKUInt32  argb  ) throw ( )

pure virtual

Adds or replaces a color value for the specified color.

Parameters

[in]	color_name	The color name.
[in]	argb	ARGB color value.

Returns

Ok if succeeded.

---

The documentation for this class was generated from the following file:

• sdl_interface.h