Classes |
class | ai::ArtboardProperties |
| The ArtboardProperties object encapsulates all the attributes associated with an artboard. More...
|
class | ai::ArtboardList |
| The ArtboardList object is the interface to the set of artboards associated with a document. More...
|
Namespaces |
namespace | ai |
| Usage:.
|
namespace | ai::ArtboardUtils |
| The ArtboardUtils object is a collection of utility functions for common operations.
|
Defines |
#define | kAICantDeleteLastArtboardErr 'CDLC' |
#define | kAIExceededMaxArtboardLimitErr 'EMxL' |
#define | kAIArtboardRulerOriginChangedNotifier "AI Artboard Ruler Origin Changed Notifier" |
| Sent when the document ruler origin has been changed or reset.
|
#define | kNotFoundErr '!FND' |
#define | kAIArtboardOutOfCanvasErr 'AOoC' |
#define | kActiveArtboard -1 |
Typedefs |
typedef ai::int32 | ai::ArtboardID |
| Artboard identifier.
|
typedef CAIArtboardProperties * | ai::ArtboardRef |
| Artboard object.
|
typedef CAIArtboardList * | ai::ArtboardListRef |
| Artboard list object.
|
Functions |
AIErr | ai::ArtboardUtils::GetCount (ArtboardID &count) |
| Retrieves the number of artboards defined in the artboard list of the current document.
|
AIErr | ai::ArtboardUtils::GetPosition (ArtboardID index, AIRealRect &rect) |
| Retrieves the position and bounds of an artboard.
|
AIErr | ai::ArtboardUtils::GetActiveArtboardPosition (AIRealRect &rect) |
| Retrieves the position and bounds of the currently active artboard.
|
AIErr | ai::ArtboardUtils::GetActiveArtboardIndex (ArtboardID &index) |
| Retrieves the index of the currently active artboard.
|
AIErr | ai::ArtboardUtils::SelectAllArtboards () |
AIErr | ai::ArtboardUtils::IsSelected (ai::ArtboardID id, AIBoolean &isSelected) |
AIErr | ai::ArtboardUtils::GetArtboardName (ai::UnicodeString &name, bool &isDefault, ArtboardID index) |
| Retrieves the name of the specified artboard.
|
AIErr | ai::ArtboardUtils::GetArtboardIndexByName (const ai::UnicodeString &name, ai::ArtboardID &index) |
| Retrieves the index of the artboard with specified name.
|
AIErr | ai::ArtboardUtils::AreAnyArtboardsOverlapping (ai::ArtboardList &artboardList, AIBoolean &isOverlapping) |
| Tells if there is any overlap between the artboards in the artboard list.
|