IPaletteManager Class Reference

Provides access to members that manage registered palettes. More...

#include <sdl_interface.h>

Inherits ISDKComponent.

Public Member Functions
virtual SDKResult SDK_CALLTYPE	EnumPaletteNames (IEnumSDKStringSP &palette_names)=0 throw ()
	Returns an enumerator registered palettes. More...
virtual SDKResult SDK_CALLTYPE	GetPalette (const SDKString &palette_name, IPaletteSP &palette)=0 throw ()
	Returns the palette specified by its name. More...
virtual SDKResult SDK_CALLTYPE	GetColor (const SDKString &palette_name, const SDKString &symbol_set_name, const SDKString &color_name, SDKUInt32 &argb)=0 throw ()
	Returns the color value specified by the palette name, symbol set name and the color name. More...
virtual SDKResult SDK_CALLTYPE	SetColor (const SDKString &palette_name, const SDKString &symbol_set_name, const SDKString &color_name, SDKUInt32 argb)=0 throw ()
	Adds or replaces the color value. More...
virtual SDKResult SDK_CALLTYPE	RegisterPalette (const SDKString &palette_name, SDLResourceID &id)=0 throw ()
	Adds the new palette class. More...
virtual SDKResult SDK_CALLTYPE	GetDisplaySettingValue (const SDKString &symbol_set_name, const SDKString &palette_name, DisplaySettingsEnum value_id, SDKAny &value) const =0 throw ()
	Gets the display setting value for the specified id. More...
virtual SDKResult SDK_CALLTYPE	SetDisplaySettingValue (const SDKString &symbol_set_name, const SDKString &palette_name, DisplaySettingsEnum value_id, const SDKAny &value)=0 throw ()
	Set the display setting value for the specified id. More...
virtual SDKResult SDK_CALLTYPE	GetColorProperty (const SDKString &symbol_set_name, const SDKString &color_name, const SDKPropertyID &id, SDKAny &value)=0 throw ()
	Returns the specified property of the color specified by the palette name, symbol set name and the color name. More...

Detailed Description

Provides access to members that manage registered palettes.

Member Function Documentation

EnumPaletteNames()

virtual SDKResult SDK_CALLTYPE EnumPaletteNames ( IEnumSDKStringSP &  palette_names ) throw ( )

pure virtual

Returns an enumerator registered palettes.

Parameters

[out]

palette_names

The palettes enumerator.

Returns

Ok if succeeded.

GetPalette()

virtual SDKResult SDK_CALLTYPE GetPalette ( const SDKString &  palette_name, IPaletteSP &  palette  ) throw ( )

pure virtual

Returns the palette specified by its name.

Parameters

[in]	palette_name	The palette name.
[out]	palette	Address of a variable that receives the pointer to the IPalette interface associated with the palette object.

Returns

Ok if succeeded.

Err_InvalidArg

GetColor()

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

pure virtual

Returns the color value specified by the palette name, symbol set name and the color name.

Parameters

[in]	palette_name	The palette name.
[in]	symbol_set_name	The symbol set name.
[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 &  palette_name, const SDKString &  symbol_set_name, const SDKString &  color_name, SDKUInt32  argb  ) throw ( )

pure virtual

Adds or replaces the color value.

Parameters

[in]	palette_name	The palette name.
[in]	symbol_set_name	The symbol set name.
[in]	color_name	The color name.
[in]	argb	ARGB color value.

Returns

Ok if succeeded.

Err_InvalidArg

RegisterPalette()

virtual SDKResult SDK_CALLTYPE RegisterPalette ( const SDKString &  palette_name, SDLResourceID &  id  ) throw ( )

pure virtual

Adds the new palette class.

Parameters

[in]	symbol_set_name	The symbol set name.
[in]	palette_name	The palette name.
[in]	gamma	Gamma reduction factor relative to the corresponding color in the day palette (0.0,1.0)
[out]	id	The internal identifier of the palette class.

Returns

Ok if succeeded.

GetDisplaySettingValue()

virtual SDKResult SDK_CALLTYPE GetDisplaySettingValue ( const SDKString &  symbol_set_name, const SDKString &  palette_name, DisplaySettingsEnum  value_id, SDKAny &  value  ) const throw ( )

pure virtual

Gets the display setting value for the specified id.

Parameters

[in]	symbol_set_name	Symbols set name.
[in]	palette_name	The palette name.
[in]	value_id	The display setting id.
[out]	value	The address of a variable that receives the display setting value.

Returns

Ok if succeeded.

Err_InvalidArg

SetDisplaySettingValue()

virtual SDKResult SDK_CALLTYPE SetDisplaySettingValue ( const SDKString &  symbol_set_name, const SDKString &  palette_name, DisplaySettingsEnum  value_id, const SDKAny &  value  ) throw ( )

pure virtual

Set the display setting value for the specified id.

Parameters

[in]	symbol_set_name	Symbols set name.
[in]	palette_name	The palette name.
[in]	value_id	The display setting id.
[in]	value	Value to set.

Returns

Ok if succeeded.

Err_InvalidArg

GetColorProperty()

virtual SDKResult SDK_CALLTYPE GetColorProperty ( const SDKString &  symbol_set_name, const SDKString &  color_name, const SDKPropertyID &  id, SDKAny &  value  ) throw ( )

pure virtual

Returns the specified property of the color specified by the palette name, symbol set name and the color name.

Parameters

[in]	palette_name	The palette name.
[in]	symbol_set_name	The symbol set name.
[in]	color_name	The color name.
[in]	id	The property ID.
[out]	value	The property value.

Returns

Ok if succeeded.

Err_InvalidArg

---

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

• sdl_interface.h