AISelectionContextManagerSuite Struct Reference
[API Suite List]

This suite provides functions to access current selection context information. More...

Public Attributes
AIAPI AIBoolean(*	IsSelectionContextFlagPresent )(AISelectionContextFlags inFlag, AISelectionLevelContext queryLevelContext)
	The API below is used to find different context present at different levels.
AIAPI AIErr(*	GetSelectionCountDetails )(AISelectionCountDetailsFlag inFlag, ai::SizeType &outCount)
	The API below is used to find context count at different levels.

Detailed Description

This suite provides functions to access current selection context information.

The API below is used to find context count at different levels.

Parameters:

	inFlag	: indicates context in which user is intertested.
	outCount	[out] : outCount is the total context value, including contexts that represents objects, present in the current selection. return kNoErr in case of No Error. Example-1: To find how many different types of context are present in the current selection.

ai::SizeType outCount = 0 ; GetSelectionCountDetails (AISelectionCountDetailsFlag::kTopLevelObjectTypeCount, outCount )

The API below is used to find different context present at different levels.

Parameters:

	inFlag	: Indicates context in which you are interested.
	queryLevelContext	: You need to specify the level at which the context is expected.

The function below returns true if the context is present, and returs false otherwise.

Example-1 : To find if a text object is present in the current selection and not inside any group.

IsSelectionContextFlagPresent(AISelectionContextFlags::kAISelectionHasTextArt,AISelectionLevelContext::kAISelectionTopLevelContext);

Example-2 : To find if any selected object includes a path.

IsSelectionContextFlagPresent(AISelectionContextFlags:: kAISelectionHasPathArt, AISelectionLevelContext::kAISelectionAnyLevelContext);

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