API: AIArtboard.h Source File

00001 #ifndef __AIArtboards__
00002 #define __AIArtboards__
00003 /*
00004 * Name: AIArtboard.h
00005 * Author: Started by Pushp
00006 * Date: November, 2008
00007 * Purpose: Adobe Illustrator Artboard Suite
00008 *
00009 * ADOBE SYSTEMS INCORPORATED
00010 * Copyright 2008 Adobe Systems Incorporated.
00011 * All rights reserved.
00012 *
00013 * NOTICE:  Adobe permits you to use, modify, and distribute this file
00014 * in accordance with the terms of the Adobe license agreement
00015 * accompanying it. If you have received this file from a source other
00016 * than Adobe, then your use, modification, or distribution of it
00017 * requires the prior written permission of Adobe.
00018 *
00019 */
00020 
00021 /*******************************************************************************
00022 **
00023 **      Imports
00024 **
00025 **/
00026 
00027 #include "IAIArtboards.hpp"
00028 #include "IAIAutoBuffer.h"
00029 
00030 #include "AIHeaderBegin.h"
00031 
00034 /*******************************************************************************
00035 **
00036 ** Constants
00037 **
00038 **/
00039 
00040 #define kAIArtboardSuite                                "AI Artboard Suite"
00041 #define kAIArtboardSuiteVersion                 AIAPI_VERSION(4)
00042 #define kAIArtboardVersion                              kAIArtboardSuiteVersion
00043 
00044 /*******************************************************************************
00045 **
00046 ** Types
00047 **
00048 **/
00049 
00050 /*******************************************************************************
00051 **
00052 **      Suite
00053 **
00054 **/
00055 
00068 struct AIArtboardSuite{
00072         AIAPI AIErr (*Init)(ai::ArtboardProperties& artboard);
00073 
00078         AIAPI AIErr (*CloneArtboard)(ai::ArtboardProperties& artboard,const ai::ArtboardProperties& newArtboard);
00079 
00084         AIAPI AIErr (*Dispose)(ai::ArtboardProperties& properties);
00085 
00090         AIAPI AIErr (*GetPosition)(const ai::ArtboardProperties& properties, AIRealRect& bounds);
00091 
00097         AIAPI AIErr (*SetPosition)(ai::ArtboardProperties& properties,const AIRealRect& bounds);
00098 
00103         AIAPI AIErr (*GetPAR)(const ai::ArtboardProperties& properties, AIReal& par);
00104 
00110         AIAPI AIErr (*SetPAR)(ai::ArtboardProperties& properties,AIReal par);
00111 
00112         /* Retrieves the name associated with an artboard.
00113         @param properties The artboard properties object.
00114         @param name [out] A buffer in which to return the name.
00115         */
00116         AIAPI AIErr (*GetName)(const ai::ArtboardProperties& properties, ai::UnicodeString& name);
00117 
00118         /* Sets the name associated with an artboard.
00119         @param properties The artboard properties object.
00120         @param name The new name.
00121         */
00122         AIAPI AIErr (*SetName)(ai::ArtboardProperties& properties, const ai::UnicodeString& name);
00123 
00129         AIAPI AIErr (*GetShowDisplayMark)(const ai::ArtboardProperties& properties,ai::ArtboardProperties::DisplayMarkType type, AIBoolean& show);
00130 
00131         /* Sets the display state of a particular type of artboard annotation.
00132         @param properties The artboard properties object.
00133         @param  type The annotation type.
00134         @param  show True to show, false to hide the annotation type.
00135         */
00136         AIAPI AIErr (*SetShowDisplayMark)(ai::ArtboardProperties& properties,ai::ArtboardProperties::DisplayMarkType type, AIBoolean show);
00140         AIAPI AIErr (*GetArtboardList)(ai::ArtboardList& artboardList);
00141 
00145         AIAPI AIErr (*ReleaseArtboardList)(ai::ArtboardList& artboardList);
00146 
00153         AIAPI AIErr (*AddNew)(ai::ArtboardList& artboardList,ai::ArtboardProperties& newArtboard, ai::ArtboardID& index);
00154 
00161         AIAPI AIErr (*Delete)(ai::ArtboardList& artboardList,ai::ArtboardID index);
00162 
00167         AIAPI AIErr (*GetCount)(const ai::ArtboardList& artboardList,ai::ArtboardID& count);
00168 
00174         AIAPI AIErr (*GetActive)(const ai::ArtboardList& artboardList,ai::ArtboardID& index);
00175 
00180         AIAPI AIErr (*SetActive)(ai::ArtboardList& artboardList, ai::ArtboardID index);
00181 
00188         AIAPI AIErr (*Update)(ai::ArtboardList& artboardList, ai::ArtboardID index, const ai::ArtboardProperties& properties);
00189 
00198         AIAPI AIErr (*GetArtboardProperties)(ai::ArtboardList& artboardList, ai::ArtboardID index, ai::ArtboardProperties& properties);
00199 
00204         AIAPI AIErr (*GetRulerOrigin)(const ai::ArtboardProperties& properties, AIRealPoint& rulerOrigin);
00205 
00210         AIAPI AIErr (*SetRulerOrigin)(ai::ArtboardProperties& properties, const AIRealPoint& rulerOrigin);
00211 
00218         AIAPI AIErr (*Insert)(ai::ArtboardList& artboardList,ai::ArtboardProperties& artboard, ai::ArtboardID& index);
00219 
00229         AIAPI AIErr (*IsDefaultName)(const ai::ArtboardProperties& properties, AIBoolean& isDefault);
00230 
00233         AIAPI AIErr (*SetIsDefaultName)(ai::ArtboardProperties& properties,const AIBoolean& isDefault);
00234 
00239         AIAPI AIErr (*IsSelected)(const ai::ArtboardProperties& properties, AIBoolean &isSelected);
00240         
00246         AIAPI AIErr (*SelectArtboard)(ai::ArtboardList& artboardList, ai::ArtboardID artboardID, AIBoolean exclusively);
00247 
00253         AIAPI AIErr (*SelectArtboards)(ai::ArtboardList& artboardList, const ai::AutoBuffer<ai::ArtboardID>& artboardIDs, AIBoolean exclusively);
00254 
00258         AIAPI AIErr (*SelectAllArtboards)(ai::ArtboardList& artboardList);
00259 
00264         AIAPI AIErr (*DeleteArtboards)(ai::ArtboardList& artboardList, const ai::AutoBuffer<ai::ArtboardID>& artboardIDs);
00265 
00270         AIAPI AIErr (*DeselectArtboard)(ai::ArtboardList& artboardList, ai::ArtboardID artboardID);
00271 
00275         AIAPI AIErr (*DeselectAllArtboards)(ai::ArtboardList& artboardList);
00276 
00277         AIAPI AIErr(*AreAnyArtboardsOverlapping)(ai::ArtboardList &artboardList, AIBoolean &isOverlapping);
00278     
00279 #if defined(ILLUSTRATOR_MINIMAL)
00280 
00284     AIAPI AIErr (*GetUUID)(const ai::ArtboardProperties& properties, ai::ArtboardUUID& uuid);
00285     
00290     AIAPI AIErr (*CloneWithUniqueUUID)(ai::ArtboardProperties& dest, const ai::ArtboardProperties& source);
00291 #endif
00292 
00293 };
00294 
00295 #include "AIHeaderEnd.h"
00296 
00297 #endif // __AIArtboards__