ai::CopyScope Class Reference

A wrapper class for the AICopyScopeHandle object. More...

#include <IAICopyScope.h>

List of all members.

Public Member Functions
	CopyScope () AINOTHROW
	Default constructor.
	CopyScope (AICopyScopeKind kind)
	Creates a copy scope object of a given type.
	~CopyScope ()
	Destructor.
bool	IsValid () const AINOTHROW
	Reports whether a copy scope has been initialized.
AIErr	Initialize (AICopyScopeKind kind, const std::nothrow_t &) AINOTHROW
	Initializes the type of an uninitialized copy scope.
void	Initialize (AICopyScopeKind kind)
	Initializes the type of an uninitialized copy scope.
AIErr	Terminate (const std::nothrow_t &) AINOTHROW
	Terminates the copy scope owned by this scope object, regardless of whether it has been initialized.
void	Terminate ()
	Terminates the copy scope owned by this scope object, regardless of whether it has been initialized.

---

Detailed Description

A wrapper class for the AICopyScopeHandle object.

Copy scopes allow you to group a collection of art object duplication operations as parts a single logical copy operation, in order to maintain some cross-object information through the set of individual operations. An example is linked text object information. When you duplicate the individual text frame objects, the need to maintain their linked attributes. You can either copy all of the linked objects in a single call to AIArtSuite::DuplicateArt(), or you can create a wrapping copy scope and making multiple individual calls to AIArtSuite::DuplicateArt().

You cannot assign or copy the CopyScope objects themselves.

---

Constructor & Destructor Documentation

ai::CopyScope::CopyScope

(

)

[inline]

Default constructor.

Creates an empty copy scope object.

Returns:

The new copy-scope object.

ai::CopyScope::CopyScope

(

AICopyScopeKind

kind

)

[inline, explicit]

Creates a copy scope object of a given type.

Parameters:

kind

The type.

Returns:

The new copy-scope object.

References Initialize().

ai::CopyScope::~CopyScope

(

)

[inline]

Destructor.

Destroys the owned scope if it has not already been properly terminated. Does not throw exceptions or return an error code. To determine if there was an error terminating the scope. use Terminate() instead

References IsValid(), and Terminate().

---

Member Function Documentation

void ai::CopyScope::Initialize

(

AICopyScopeKind

kind

)

[inline]

Initializes the type of an uninitialized copy scope.

Throws exceptions.

Parameters:

kind

The scope type.

Returns:

Nothing.

References Initialize().

AIErr ai::CopyScope::Initialize	(	AICopyScopeKind	kind,
		const std::nothrow_t &
	)			[inline]

Initializes the type of an uninitialized copy scope.

Does not throw exceptions.

Parameters:

kind

The scope type.

Returns:

kAICopyScopeAlreadyInitialized error if the scope has already been initialized.

References AIArtSuite::CreateCopyScope, IsValid(), kAICopyScopeAlreadyInitialized, kNoErr, and sAIArt.

Referenced by CopyScope(), and Initialize().

bool ai::CopyScope::IsValid

(

void

)

const [inline]

Reports whether a copy scope has been initialized.

Returns:

True if this scope has been initialized.

Referenced by Initialize(), Terminate(), and ~CopyScope().

void ai::CopyScope::Terminate

(

)

[inline]

Terminates the copy scope owned by this scope object, regardless of whether it has been initialized.

Throws exceptions.

Returns:

Nothing.

Referenced by ~CopyScope().

AIErr ai::CopyScope::Terminate

(

const std::nothrow_t &

)

[inline]

Terminates the copy scope owned by this scope object, regardless of whether it has been initialized.

Does not throw exceptions, but returns an error code.

Returns:

An error code, kNoErr on success.

References AIArtSuite::DestroyCopyScope, IsValid(), kNoErr, and sAIArt.

---

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

• IAICopyScope.h