AIArtboardRangeSuite Struct Reference
[API Suite List]

This suite allows you to validate a string containing a range of artboard indices and sequentially iterate over the range. More...

#include <AIArtboardRange.h>

List of all members.

Public Attributes
AIAPI AIErr(*	Create )(ASBoolean allArtboards, const ai::UnicodeString *rangeStr, AIArtboardRangeHandle *range)
	Creates an artboard range reference.
AIAPI AIErr(*	GetCount )(AIArtboardRangeHandle range, ASInt32 *count)
	Retrieves the number of artboards in an artboard range.
AIAPI AIErr(*	Begin )(AIArtboardRangeHandle range, AIArtboardRangeIterator *rangeItr)
	Creates a bi-directional iterator for an artboard range.
AIAPI AIErr(*	Next )(AIArtboardRangeIterator rangeItr, ASInt32 *artboardNumber)
	Retrieves the next element in an artboard range and increments the iterator.
AIAPI AIErr(*	Previous )(AIArtboardRangeIterator rangeItr, ASInt32 *artboardNumber)
	Retrieves the previous element in an artboard range and decrements the iterator.
AIAPI AIErr(*	Back )(AIArtboardRangeIterator rangeItr)
	Sets the iterator to the last element in an artboard range.
AIAPI AIErr(*	DisposeIterator )(AIArtboardRangeIterator rangeItr)
	Disposes of an artboard range iterator created by Begin().
AIAPI AIErr(*	Dispose )(AIArtboardRangeHandle)
	Disposes of an artboard range handle created by Create().
AIAPI AIErr(*	ValidateString )(const ai::UnicodeString *rangeStr)
	Validates an artboard range string.
AIAPI AIErr(*	IsAllSelected )(AIArtboardRangeHandle range, ASBoolean *result)
	Reports whether an artboard range includes all defined artboards.
AIAPI AIErr(*	RemoveDuplicate )(AIArtboardRangeHandle range)
	Removes duplicate crop areas from an artboard range.

---

Detailed Description

This suite allows you to validate a string containing a range of artboard indices and sequentially iterate over the range.

A range of artboards is typically provided by the user in the Print, Save and Export dialogs.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIArtboardRangeSuite and kAIArtboardRangeSuiteVersion.

---

Member Data Documentation

AIAPI AIErr(* AIArtboardRangeSuite::Back)(AIArtboardRangeIterator rangeItr)

Sets the iterator to the last element in an artboard range.

Parameters:

rangeItr

The artboard range iterator.

AIAPI AIErr(* AIArtboardRangeSuite::Begin)(AIArtboardRangeHandle range, AIArtboardRangeIterator *rangeItr)

Creates a bi-directional iterator for an artboard range.

Parameters:

	range	An artboard range reference.
	rangeItr	[out] A buffer in which to return the iterator, which initially points to the first element of the artboard range.

See also:

DisposeIterator()

AIAPI AIErr(* AIArtboardRangeSuite::Create)(ASBoolean allArtboards, const ai::UnicodeString *rangeStr, AIArtboardRangeHandle *range)

Creates an artboard range reference.

Parameters:

	allArtboards	True to include all defined artboards in the range. False to use a range string.
	rangeStr	A valid artboard range string. Ignored if allArtboards is true.
	range	[out] A buffer in which to return the new artboard range reference.

See also:

ValidateString()

AIAPI AIErr(* AIArtboardRangeSuite::Dispose)(AIArtboardRangeHandle)

Disposes of an artboard range handle created by Create().

Parameters:

range

An artboard range reference.

AIAPI AIErr(* AIArtboardRangeSuite::DisposeIterator)(AIArtboardRangeIterator rangeItr)

Disposes of an artboard range iterator created by Begin().

Parameters:

rangeItr

An artboard range iterator.

AIAPI AIErr(* AIArtboardRangeSuite::GetCount)(AIArtboardRangeHandle range, ASInt32 *count)

Retrieves the number of artboards in an artboard range.

Parameters:

	range	An artboard range reference.
	count	[out] A buffer in which to return the number of artboards.

AIAPI AIErr(* AIArtboardRangeSuite::IsAllSelected)(AIArtboardRangeHandle range, ASBoolean *result)

Reports whether an artboard range includes all defined artboards.

Parameters:

	range	An artboard range reference.
	result	[out] A buffer in which to return the output as true if the range includes all artboards, false otherwise.

Returns:

The error kBadParameterErr if any parameter is NULL.

AIAPI AIErr(* AIArtboardRangeSuite::Next)(AIArtboardRangeIterator rangeItr, ASInt32 *artboardNumber)

Retrieves the next element in an artboard range and increments the iterator.

Parameters:

	rangeItr	The artboard range iterator.
	artboardNumber	[out] A buffer in which to return the 0-based index of the next artboard.

Returns:

The error kEndOfRangeErr if the iterator has reached the end of the range.

AIAPI AIErr(* AIArtboardRangeSuite::Previous)(AIArtboardRangeIterator rangeItr, ASInt32 *artboardNumber)

Retrieves the previous element in an artboard range and decrements the iterator.

Parameters:

	rangeItr	The artboard range iterator.
	artboardNumber	[out] A buffer in which to return the 0-based index of the previous artboard.

Returns:

The error kEndOfRangeErr if the iterator has reached the beginning of the range.

AIAPI AIErr(* AIArtboardRangeSuite::RemoveDuplicate)(AIArtboardRangeHandle range)

Removes duplicate crop areas from an artboard range.

This call re-sorts the range and invalidates all iterators for this range.

Parameters:

range

An artboard range reference.

Returns:

The error kBadParameterErr if any parameter is NULL.

AIAPI AIErr(* AIArtboardRangeSuite::ValidateString)(const ai::UnicodeString *rangeStr)

Validates an artboard range string.

A valid range string contains a comma-separated list of artboard index numbers and index ranges (n-m). The index is 0-based. A valid string could be, for example, "1,2,3-5,8".

Parameters:

rangeStr

The string containing the artboard range.

Returns:

The error kBadParameterErr if the range string is invalid.

---

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

• AIArtboardRange.h