SnpShowPalette Class Reference

Public Member Functions
	SnpShowPalette ()
virtual	~SnpShowPalette ()
ErrorCode	ShowHide (const PaletteRef &palRef, bool16 isShow)
ErrorCode	ShowHideByAction (const ActionID &actionID, bool16 isShow)
ErrorCode	GetPanelsRegistered (std::map< PMString, PaletteRef > &outNameUIDMap)
bool16	IsShowing (const PaletteRef &palRef)
bool16	IsShowingByAction (const ActionID &actionID)
bool16	IsShowingByWidget (const WidgetID &widgetID)
ErrorCode	ShowHideByWidget (const WidgetID &widgetID, bool16 isShowing)
ErrorCode	RunScenario (IActiveContext *activeContext)

Detailed Description

Shows how to:

• Discover default properties of palette-panel widgets via action component (IActionComponent)
• Show or hide a widget by ActionID, PaletteRef or WidgetID

Constructor & Destructor Documentation

SnpShowPalette::SnpShowPalette ( )

inline

Constructor.

virtual SnpShowPalette::~SnpShowPalette ( )

inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpShowPalette::GetPanelsRegistered

(

std::map< PMString, PaletteRef > &

outNameUIDMap

)

Acquire collection of palette-panel widgets, as mapping from names to UIDs.

Parameters

outNameUIDMap

map that contains name to UID map for known palette-panels

Returns

ErrorCode kSuccess on success, other ErrorCode otherwise

bool16 SnpShowPalette::IsShowing

(

const PaletteRef &

palRef

)

Determine if specified palette is showing

Parameters

palRef

specifies the palette-panel of interest

Returns

kTrue if showing, kFalse if not

bool16 SnpShowPalette::IsShowingByAction

(

const ActionID &

actionID

)

Determine if specified panel is showing

Parameters

actionID

specifies panel of interest

Returns

kTrue if showing, kFalse if not

bool16 SnpShowPalette::IsShowingByWidget

(

const WidgetID &

widgetID

)

Determine if specified panel is showing

Parameters

widgetID

specifies panel of interest

Returns

kTrue if showing, kFalse if not

ErrorCode SnpShowPalette::RunScenario

(

IActiveContext *

activeContext

)

Implements scenario that exercises the code in this snippet.

Parameters

activeContext

Returns

ErrorCode kSuccess on success, other ErrorCode otherwise

ErrorCode SnpShowPalette::ShowHide	(	const PaletteRef &	palRef,
		bool16	isShow
	)

Show or hide panel widget by its UID.

Parameters

palRef	the palette-panel to show or hide
isShow	specifies whether to show (if kTrue) or hide (if kFalse)

Returns

ErrorCode kSuccess on success, other ErrorCode otherwise

ErrorCode SnpShowPalette::ShowHideByAction	(	const ActionID &	actionID,
		bool16	isShow
	)

Show or hide palette-panel widget by associated ActionID.

Parameters

actionID	identifies the action to show the palette
isShow	specifies whether to show (if kTrue) or hide (if kFalse)

Returns

ErrorCode kSuccess on success, other ErrorCode otherwise

ErrorCode SnpShowPalette::ShowHideByWidget	(	const WidgetID &	widgetID,
		bool16	isShowing
	)

Show or hide by WidgetID

Parameters

widgetID	specifies which widget
isShowing	kTrue to show the panel, kFalse to hide it

Returns

ErrorCode kSuccess on success, other ErrorCode otherwise