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 
00029 
00030 #include "AIHeaderBegin.h"
00031 
00034 /*******************************************************************************
00035 **
00036 ** Constants
00037 **
00038 **/
00039 
00040 #define kAIArtboardSuite                                "AI Artboard Suite"
00041 #define kAIArtboardSuiteVersion                 AIAPI_VERSION(3)
00042 #define kAIArtboardVersion                              kAIArtboardSuiteVersion
00043 
00044 /*******************************************************************************
00045 **
00046 ** Types
00047 **
00048 **/
00049 
00050 /*******************************************************************************
00051 **
00052 **      Suite
00053 **
00054 **/
00055 
00068 typedef struct
00069 {
00073         AIAPI AIErr (*Init)(ai::ArtboardProperties& artboard);
00074 
00079         AIAPI AIErr (*CloneArtboard)(ai::ArtboardProperties& artboard,const ai::ArtboardProperties& newArtboard);
00080 
00085         AIAPI AIErr (*Dispose)(ai::ArtboardProperties& properties);
00086 
00091         AIAPI AIErr (*GetPosition)(const ai::ArtboardProperties& properties, AIRealRect& bounds);
00092 
00098         AIAPI AIErr (*SetPosition)(ai::ArtboardProperties& properties,const AIRealRect& bounds);
00099 
00104         AIAPI AIErr (*GetPAR)(const ai::ArtboardProperties& properties, AIReal& par);
00105 
00111         AIAPI AIErr (*SetPAR)(ai::ArtboardProperties& properties,AIReal par);
00112 
00113         /* Retrieves the name associated with an artboard.
00114         @param properties The artboard properties object.
00115         @param name [out] A buffer in which to return the name.
00116         */
00117         AIAPI AIErr (*GetName)(const ai::ArtboardProperties& properties, ai::UnicodeString& name);
00118 
00119         /* Sets the name associated with an artboard.
00120         @param properties The artboard properties object.
00121         @param name The new name.
00122         */
00123         AIAPI AIErr (*SetName)(ai::ArtboardProperties& properties, const ai::UnicodeString& name);
00124 
00130         AIAPI AIErr (*GetShowDisplayMark)(const ai::ArtboardProperties& properties,ai::ArtboardProperties::DisplayMarkType type, AIBoolean& show);
00131 
00132         /* Sets the display state of a particular type of artboard annotation.
00133         @param properties The artboard properties object.
00134         @param  type The annotation type.
00135         @param  show True to show, false to hide the annotation type.
00136         */
00137         AIAPI AIErr (*SetShowDisplayMark)(ai::ArtboardProperties& properties,ai::ArtboardProperties::DisplayMarkType type, AIBoolean show);
00141         AIAPI AIErr (*GetArtboardList)(ai::ArtboardList& artboardList);
00142 
00146         AIAPI AIErr (*ReleaseArtboardList)(ai::ArtboardList& artboardList);
00147 
00154         AIAPI AIErr (*AddNew)(ai::ArtboardList& artboardList,ai::ArtboardProperties& newArtboard, ai::ArtboardID& index);
00155 
00162         AIAPI AIErr (*Delete)(ai::ArtboardList& artboardList,ai::ArtboardID index);
00163 
00168         AIAPI AIErr (*GetCount)(const ai::ArtboardList& artboardList,ai::ArtboardID& count);
00169 
00175         AIAPI AIErr (*GetActive)(const ai::ArtboardList& artboardList,ai::ArtboardID& index);
00176 
00181         AIAPI AIErr (*SetActive)(ai::ArtboardList& artboardList, ai::ArtboardID index);
00182 
00189         AIAPI AIErr (*Update)(ai::ArtboardList& artboardList, ai::ArtboardID index, const ai::ArtboardProperties& properties);
00190 
00199         AIAPI AIErr (*GetArtboardProperties)(ai::ArtboardList& artboardList, ai::ArtboardID index, ai::ArtboardProperties& properties);
00200 
00205         AIAPI AIErr (*GetRulerOrigin)(const ai::ArtboardProperties& properties, AIRealPoint& rulerOrigin);
00206 
00211         AIAPI AIErr (*SetRulerOrigin)(ai::ArtboardProperties& properties, const AIRealPoint& rulerOrigin);
00212 
00219         AIAPI AIErr (*Insert)(ai::ArtboardList& artboardList,ai::ArtboardProperties& artboard, ai::ArtboardID& index);
00220 
00230         AIAPI AIErr (*IsDefaultName)(const ai::ArtboardProperties& properties, AIBoolean& isDefault);
00231 
00234         AIAPI AIErr (*SetIsDefaultName)(ai::ArtboardProperties& properties,const AIBoolean& isDefault);
00235 
00236 } AIArtboardSuite;
00237 #include "AIHeaderEnd.h"
00238 
00239 
00240 
00241 #endif // __AIArtboards__