CColorContext Class Reference

#include <CColorContext.h>

Public Member Functions
	CColorContext ()
	~CColorContext ()
bool16	GetRGBColor (const IInterfaceColors::InterfaceColor index, RGBColor &rgb) const
bool16	GetRealAGMColor (const IInterfaceColors::InterfaceColor index, RealAGMColor &rgb) const

Protected Attributes
IInterfaceColors *	fIInterfaceColors

Detailed Description

Simple class wrapper around IInterfaceColors. Also the base class for a pair of platform-specific helper classes, MColorContext and WColorContext

See Also

IInterfaceColors

MColorContext

WColorContext

Constructor & Destructor Documentation

CColorContext::CColorContext

(

)

Default constructor. Acquires session's IInterfaceColors interface

CColorContext::~CColorContext

(

)

Destructor. Releases IInterfaceColor acquired in constructor

Member Function Documentation

bool16 CColorContext::GetRealAGMColor	(	const IInterfaceColors::InterfaceColor	index,
		RealAGMColor &	rgb
	)		const

Gets the RGB color specified by the given UI color selector as a RealAGMColor.

Parameters

index	IN The selector for the UI color to return
rgb	OUT The color being requested

Returns

kTrue if method succeeds, else kFalse

See Also

IInterfaceColors::InterfaceColor

IInterfaceColors::GetRealAGMColor

bool16 CColorContext::GetRGBColor	(	const IInterfaceColors::InterfaceColor	index,
		RGBColor &	rgb
	)		const

Gets the RGB color specified by the given UI color selector as an RGBColor.

Parameters

index	IN The selector for the UI color to return
rgb	OUT The color being requested

Returns

kTrue if method succeeds, else kFalse

See Also

IInterfaceColors::InterfaceColor

IInterfaceColors::GetRGBColor