AIUIDUtilsSuite Struct Reference
[API Suite List]

This suite allows you to query and manage the unique identifiers for art objects. More...

#include <AIUID.h>

Public Attributes
AIAPI AIErr(*	GetArtUID )(AIArtHandle art, AIBoolean create, AIUIDRef *uid)
	Retrieves the unique identifier for an art object.
AIAPI AIErr(*	SetArtUID )(AIArtHandle art, AIUIDRef uid)
	Sets the unique identifier of an art object, replacing its current UID, if any.
AIAPI AIErr(*	TransferArtUID )(AIArtHandle srcart, AIArtHandle dstart)
	Transfers the unique identifier of an art object to another art object, setting the UID of the source art to `NULL`.
AIAPI AIErr(*	NewArtUIDREF )(AIArtHandle art, AIUIDREFRef *uidref)
	Retrieves the UID reference for an art object, or assigns a new UID and creates the reference if needed.
AIAPI AIErr(*	GetReferencedArt )(AIUIDREFRef uidref, AIArtHandle *art)
	Retrieves the art object referenced by a UID reference.
AIAPI AIErr(*	GetArtUIDName )(AIArtHandle art, ai::UnicodeString &name)
	Retrieves the UID name of an art object.
AIAPI AIErr(*	SetArtUIDName )(AIArtHandle art, const ai::UnicodeString &name)
	Sets the UID name of an art object.
AIAPI AIErr(*	GetArtNameOrUID )(AIArtHandle art, ai::UnicodeString &name, ASBoolean *isDefaultName)
	Retrieves the name or XML identifier of an art object, depending on the setting of the user preference "Identify Object by: Object Name/XML ID".
AIAPI AIErr(*	SetArtNameOrUID )(AIArtHandle art, const ai::UnicodeString &name)
	Sets the name or XML identifier of an art object, depending on the setting of the user preference "Identify Object by: Object Name/XML ID".
AIAPI AIErr(*	MakeUIDFromBase )(AIUIDRef base, AIUIDRef *uid)
	Creates a new UID reference based on an existing UID reference, by appending a numeric suffix to make the name unique.
AIAPI AIErr(*	MakeUniqueNameFromBase )(const ai::UnicodeString &base, ai::UnicodeString &name)
	Creates a new name from a base name, by appending a numeric suffix to make the name unique.
AIAPI AIErr(*	GetStoryUID )(AIArtHandle art, AIBoolean create, AIUIDRef *ruid)
	Retrieves the UID reference for the story associated with an art object.
AIAPI AIErr(*	SetStoryUID )(AIArtHandle art, AIUIDRef uid)
	Sets the UID reference for the story associated with an art object.
AIAPI AIErr(*	TransferStoryUID )(AIArtHandle srcart, AIArtHandle dstart)
	Transfers the unique identifier from the story associated with a text art object to the story of another text art object.
AIAPI AIErr(*	NewStoryUIDREF )(AIArtHandle art, AIUIDREFRef *uidref)
	Creates a new UID reference for the story associated with an art object.
AIAPI AIErr(*	TransferStoryUIDToArt )(AIArtHandle frame, AIArtHandle art)
	Transfers the unique identifier from the story associated with a text art object to another art object of any type.
AIAPI AIErr(*	TransferArtUIDToStory )(AIArtHandle art, AIArtHandle frame)
	Transfers the unique identifier from an art object of any type to the story associated with a text art object.
AIAPI AIErr(*	FindEquivUID )(AIUIDRef target, AIUIDRef &equiv)
	Retrieves the source object from which an object being dragged and transformed was derived.

Detailed Description

This suite allows you to query and manage the unique identifiers for art objects.

See also:: AIUIDPoolSuite, AIUIDSuite, AIUIDREFSuite

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIUIDUtilsSuite and kAIUIDUtilsVersion.

Member Data Documentation

AIAPI AIErr(* AIUIDUtilsSuite::FindEquivUID)(AIUIDRef target, AIUIDRef &equiv)

Retrieves the source object from which an object being dragged and transformed was derived.

Parameters:

	target	The unique identifier (UID) for the object being dragged.
	equiv	[out] A buffer in which to return the UID of the source object for the transformation, if found.

Returns:: kUIDNotFound error if the source object UID is not found in the current context.

AIAPI AIErr(* AIUIDUtilsSuite::GetArtNameOrUID)(AIArtHandle art, ai::UnicodeString &name, ASBoolean *isDefaultName)

Retrieves the name or XML identifier of an art object, depending on the setting of the user preference "Identify Object by: Object Name/XML ID".

If the preference allows a user to enter arbitrary names, they are internally translated to valid, unique, XML IDs. This function translates back to the name that was entered.

Parameters:

	art	The art object.
	name	[out] A buffer in which to return the name string.
	isDefaultName	[out] A buffer in which to return the output as true if the art object has no name or UID, and the returned string is the default name.

AIAPI AIErr(* AIUIDUtilsSuite::GetArtUID)(AIArtHandle art, AIBoolean create, AIUIDRef *uid)

Retrieves the unique identifier for an art object.

Parameters:

	art	The art object.
	create	True to assign a generated UID if the object has none.
	uid	[out] A buffer in which to return the found UID object, or a generated UID if none is found and `create` is true.

AIAPI AIErr(* AIUIDUtilsSuite::GetArtUIDName)(AIArtHandle art, ai::UnicodeString &name)

Retrieves the UID name of an art object.

Parameters:

	art	The art object.
	name	[out] A buffer in which to return the name string, or the empty string if no UID is assigned.

AIAPI AIErr(* AIUIDUtilsSuite::GetReferencedArt)(AIUIDREFRef uidref, AIArtHandle *art)

Retrieves the art object referenced by a UID reference.

If the UID reference is associated with a text story (a sequence of linked text frames), retrieves the first frame of the story.

Parameters:

	uidref	The UID reference object,
	art	[out] A buffer in which to return the art object.

AIAPI AIErr(* AIUIDUtilsSuite::GetStoryUID)(AIArtHandle art, AIBoolean create, AIUIDRef *ruid)

Retrieves the UID reference for the story associated with an art object.

Parameters:

	art	The art object, of type `AIArtType::kTextFrameArt`.
	create	True to generate and assign a new UID if the story has none.
	ruid	[out] A buffer in which to return the UID reference object.

AIAPI AIErr(* AIUIDUtilsSuite::MakeUIDFromBase)(AIUIDRef base, AIUIDRef *uid)

Creates a new UID reference based on an existing UID reference, by appending a numeric suffix to make the name unique.

Parameters:

	base	The base UID reference object.
	uid	[out] A buffer in which to return the new UID reference.

AIAPI AIErr(* AIUIDUtilsSuite::MakeUniqueNameFromBase)(const ai::UnicodeString &base, ai::UnicodeString &name)

Creates a new name from a base name, by appending a numeric suffix to make the name unique.

Parameters:

	base	The base name string.
	name	[out] A buffer in which to return the new name string.

AIAPI AIErr(* AIUIDUtilsSuite::NewArtUIDREF)(AIArtHandle art, AIUIDREFRef *uidref)

Retrieves the UID reference for an art object, or assigns a new UID and creates the reference if needed.

Parameters:

	art	The art object.
	uidref	[out] A buffer in which to return the UID reference object.

AIAPI AIErr(* AIUIDUtilsSuite::NewStoryUIDREF)(AIArtHandle art, AIUIDREFRef *uidref)

Creates a new UID reference for the story associated with an art object.

Pass this reference to GetReferencedArt() to retrieve the first frame of the story (regardless of which frame was used to create the reference).

Parameters:

	art	The art object, of type `AIArtType::kTextFrameArt`.
	ruid	The new UID reference object.

AIAPI AIErr(* AIUIDUtilsSuite::SetArtNameOrUID)(AIArtHandle art, const ai::UnicodeString &name)

Sets the name or XML identifier of an art object, depending on the setting of the user preference "Identify Object by: Object Name/XML ID".

Parameters:

	art	The art object.
	name	The newly named string. If the preference allows a user to enter arbitrary names, this can be any string, which is translated internally to a valid, unique, XML ID. Otherwise, it must conform to XML ID syntax.

AIAPI AIErr(* AIUIDUtilsSuite::SetArtUID)(AIArtHandle art, AIUIDRef uid)

Sets the unique identifier of an art object, replacing its current UID, if any.

Parameters:

	art	The art object.
	uid	The new UID object,

AIAPI AIErr(* AIUIDUtilsSuite::SetArtUIDName)(AIArtHandle art, const ai::UnicodeString &name)

Sets the UID name of an art object.

Parameters:

	art	The art object.
	name	The new name string.

Returns:: The kUIDNotUnique error if the named UID is already in use.

AIAPI AIErr(* AIUIDUtilsSuite::SetStoryUID)(AIArtHandle art, AIUIDRef uid)

Sets the UID reference for the story associated with an art object.

Parameters:

	art	The art object, of type `AIArtType::kTextFrameArt`.
	ruid	The new UID reference object.

AIAPI AIErr(* AIUIDUtilsSuite::TransferArtUID)(AIArtHandle srcart, AIArtHandle dstart)

Transfers the unique identifier of an art object to another art object, setting the UID of the source art to NULL.

Parameters:

	srcart	The source art object.
	dstart	The destination art object.

AIAPI AIErr(* AIUIDUtilsSuite::TransferArtUIDToStory)(AIArtHandle art, AIArtHandle frame)

Transfers the unique identifier from an art object of any type to the story associated with a text art object.

The UID of the source art object is set to NULL.

Parameters:

	art	The source art object, of any type.
	frame	The destination art object, of type `AIArtType::kTextFrameArt`.

AIAPI AIErr(* AIUIDUtilsSuite::TransferStoryUID)(AIArtHandle srcart, AIArtHandle dstart)

Transfers the unique identifier from the story associated with a text art object to the story of another text art object.

The UID of the source story is set to NULL.

Parameters:

	srcart	The source art object, of type `AIArtType::kTextFrameArt`.
	dstart	The destination art object, of type `AIArtType::kTextFrameArt`.

AIAPI AIErr(* AIUIDUtilsSuite::TransferStoryUIDToArt)(AIArtHandle frame, AIArtHandle art)

Transfers the unique identifier from the story associated with a text art object to another art object of any type.

The UID of the source story is set to NULL.

Parameters:

	frame	The source art object, of type `AIArtType::kTextFrameArt`.
	art	The destination art object, of any type.

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

AIUID.h

AIUIDUtilsSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIUIDUtilsSuite Struct Reference
[API Suite List]