API: AIArtboardRange.h Source File

00001 /*************************************************************************
00002 *
00003 *ADOBE SYSTEMS INCORPORATED
00004 * Copyright 2007 Adobe Systems Incorporated
00005 * All Rights Reserved.
00006 *
00007 *NOTICE:  Adobe permits you to use, modify, and distribute this file in accordance with the 
00008 *terms of the Adobe license agreement accompanying it.  If you have received this file from a 
00009 *source other than Adobe, then your use, modification, or distribution of it requires the prior 
00010 *written permission of Adobe.
00011 *
00012 **************************************************************************/
00013 
00014 #ifndef _AI_ARTBOARD_RANGE_H_
00015 #define _AI_ARTBOARD_RANGE_H_
00016 
00017 /*******************************************************************************
00018 **
00019 **      Imports
00020 **
00021 **/
00022 #include "ASTypes.h"
00023 #include "AIPlugin.h"
00024 
00025 #include "AIHeaderBegin.h"
00026 
00029 #define kAIArtboardRangeSuite                   "AI Artboard Range Suite"
00030 #define kAIArtboardRangeSuiteVersion4           AIAPI_VERSION(4)
00031 
00032 /* Latest version */
00033 #define kAIArtboardRangeSuiteVersion            kAIArtboardRangeSuiteVersion4
00034 #define kAIArtboardRangeVersion                 kAIArtboardRangeSuiteVersion
00035 
00036 
00039 #define kStdExceptionCaughtError ('SECE')
00040 
00043 #define kEndOfRangeErr                   ('ECRG')
00044 
00045 
00047 typedef struct _t_Opaque_ArtboardRange* AIArtboardRangeHandle;
00049 typedef struct _t_Opaque_ArtboardRangeIterator* AIArtboardRangeIterator;
00050 
00059 typedef struct
00060 {
00068         AIAPI AIErr (*Create)(ASBoolean allArtboards, const ai::UnicodeString *rangeStr, AIArtboardRangeHandle* range);
00069 
00076         AIAPI AIErr (*GetCount)(AIArtboardRangeHandle range, ASInt32 *count);
00077 
00086         AIAPI AIErr (*Begin)(AIArtboardRangeHandle range, AIArtboardRangeIterator *rangeItr);
00087 
00095         AIAPI AIErr (*Next)(AIArtboardRangeIterator rangeItr, ASInt32 *artboardNumber);
00096 
00104         AIAPI AIErr (*Previous)(AIArtboardRangeIterator rangeItr, ASInt32 *artboardNumber);
00105 
00111         AIAPI AIErr(*Back)(AIArtboardRangeIterator rangeItr);
00112 
00118         AIAPI AIErr (*DisposeIterator)(AIArtboardRangeIterator rangeItr);
00119 
00125         AIAPI AIErr (*Dispose) (AIArtboardRangeHandle);
00126 
00135         AIAPI AIErr (*ValidateString)(const ai::UnicodeString *rangeStr);
00136 
00143         AIAPI AIErr (*IsAllSelected)(AIArtboardRangeHandle range,ASBoolean * result);
00144 
00151         AIAPI AIErr (*RemoveDuplicate)(AIArtboardRangeHandle range);
00152 
00153 } AIArtboardRangeSuite;
00154 
00155 #include "AIHeaderEnd.h"
00156 
00157 #endif // _AI_ARTBOARD_RANGE_H_