IAIArtboards.cpp File Reference

#include "AIArtboard.h"
#include <algorithm>
#include "AIErrorHandler.h"
#include "AIAssert.hpp"
#include "IAIStringUtils.h"

Namespaces
namespace	ai
	Usage:.
namespace	ai::ArtboardUtils
	The ArtboardUtils object is a collection of utility functions for common operations.
Defines
#define	_IAIARTBOARD_SUITE_USE_C_LINKAGE_   1
Functions
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.
Variables
AIArtboardSuite *	sAIArtboard
	The plug-in using the ai::ArtboardProperties class is required to provide these global suite pointers.

---

Define Documentation

#define _IAIARTBOARD_SUITE_USE_C_LINKAGE_   1

---

Variable Documentation

AIArtboardSuite* sAIArtboard

The plug-in using the ai::ArtboardProperties class is required to provide these global suite pointers.

These pointers must be valid prior to any call to ai::ArtboardProperties methods.

Referenced by ai::ArtboardList::AddNew(), ai::ArtboardList::ArtboardList(), ai::ArtboardProperties::ArtboardProperties(), ai::ArtboardList::Delete(), ai::ArtboardList::Deselect(), ai::ArtboardList::DeselectAll(), ai::ArtboardList::GetActive(), ai::ArtboardList::GetArtboardProperties(), ai::ArtboardList::GetCount(), ai::ArtboardProperties::GetName(), ai::ArtboardProperties::GetPAR(), ai::ArtboardProperties::GetPosition(), ai::ArtboardProperties::GetRulerOrigin(), ai::ArtboardProperties::GetShowDisplayMark(), ai::ArtboardList::Insert(), ai::ArtboardProperties::IsDefaultName(), ai::ArtboardProperties::IsSelected(), ai::ArtboardList::Select(), ai::ArtboardList::SelectAll(), ai::ArtboardList::SetActive(), ai::ArtboardProperties::SetIsDefaultName(), ai::ArtboardProperties::SetName(), ai::ArtboardProperties::SetPAR(), ai::ArtboardProperties::SetPosition(), ai::ArtboardProperties::SetRulerOrigin(), ai::ArtboardProperties::SetShowDisplayMark(), ai::ArtboardList::Update(), ai::ArtboardList::~ArtboardList(), and ai::ArtboardProperties::~ArtboardProperties().