API: AIArtSet.h Source File

00001 #ifndef __AIArtSet__
00002 #define __AIArtSet__
00003 
00004 /*
00005  *        Name: AIArtSet.h
00006  *   $Revision: 6 $
00007  *      Author:
00008  *        Date:
00009  *     Purpose: Adobe Illustrator Art Set Suite.
00010  *
00011  * ADOBE SYSTEMS INCORPORATED
00012  * Copyright 1986-2014 Adobe Systems Incorporated.
00013  * All rights reserved.
00014  *
00015  * NOTICE:  Adobe permits you to use, modify, and distribute this file 
00016  * in accordance with the terms of the Adobe license agreement 
00017  * accompanying it. If you have received this file from a source other 
00018  * than Adobe, then your use, modification, or distribution of it 
00019  * requires the prior written permission of Adobe.
00020  *
00021  */
00022 
00023 
00024 /*******************************************************************************
00025  **
00026  **     Imports
00027  **
00028  **/
00029 
00030 #ifndef __AITypes__
00031 #include "AITypes.h"
00032 #endif
00033 
00034 #ifndef __AIArt__
00035 #include "AIArt.h"
00036 #endif
00037 
00038 #ifndef __AILayer__
00039 #include "AILayer.h"
00040 #endif
00041 
00042 
00043 #include "AIHeaderBegin.h"
00044 
00047 /*******************************************************************************
00048  **
00049  **     Constants
00050  **
00051  **/
00052 
00053 #define kAIArtSetSuite                  "AI Art Set Suite"
00054 #define kAIArtSetSuiteVersion   AIAPI_VERSION(9)
00055 #define kAIArtSetVersion                kAIArtSetSuiteVersion
00056 
00057 
00058 /*******************************************************************************
00059  **
00060  **     Types
00061  **
00062  **/
00063 
00080 typedef struct {
00082         ai::int16 type;
00086         ai::int32 whichAttr, attr;
00087 } AIArtSpec;
00088 
00090 typedef struct _t_AIArt *AIArtSet;
00091 
00092 /*******************************************************************************
00093  **
00094  **     Suite
00095  **
00096  **/
00097 
00107 typedef struct {
00108 
00114         AIAPI AIErr (*NewArtSet) ( AIArtSet *artSet );
00115 
00120         AIAPI AIErr (*DisposeArtSet) ( AIArtSet *artSet );
00121 
00127         AIAPI AIErr (*CountArtSet) ( AIArtSet artSet, size_t *count );
00128 
00138         AIAPI AIErr (*IndexArtSet) ( AIArtSet artSet, size_t index, AIArtHandle *art );
00139 
00149         AIAPI AIErr (*ArrayArtSet) ( AIArtSet artSet, AIArtHandle *artArray, size_t count );
00150 
00159         AIAPI AIErr (*SelectedArtSet) ( AIArtSet artSet );
00160 
00170         AIAPI AIErr (*MatchingArtSet) ( AIArtSpec *specs, ai::int16 numSpecs, AIArtSet artSet );
00171 
00177         AIAPI AIErr (*LayerArtSet) ( AILayerHandle layer, AIArtSet artSet );
00178 
00179 
00184         AIAPI AIErr (*NotArtSet) ( AIArtSet src, AIArtSet dst );
00185 
00192         AIAPI AIErr (*UnionArtSet) ( AIArtSet src0, AIArtSet src1, AIArtSet dst );
00193 
00199         AIAPI AIErr (*IntersectArtSet) ( AIArtSet src0, AIArtSet src1, AIArtSet dst );
00200 
00210         AIAPI AIErr (*NextInArtSet) ( AIArtSet artSet, AIArtHandle prevArt, AIArtHandle *nextArt );
00211 
00212         /* AI 9 additions. */
00213 
00218         AIAPI AIErr (*AddArtToArtSet) (AIArtSet artSet, AIArtHandle art);
00219 
00224         AIAPI AIErr (*RemoveArtFromArtSet) (AIArtSet artSet, AIArtHandle art);
00225 
00226         /* AI 9.01 addition */
00227 
00235         AIAPI AIErr (*ReplaceArtInArtSet) (AIArtSet artSet, AIArtHandle oldArt, AIArtHandle newArt);
00236 
00237         /* AI 18.1 addition */
00238 
00242         AIAPI AIErr (*ClearArtSet) (AIArtSet artSet);
00243 
00244 } AIArtSetSuite;
00245 
00246 
00247 #include "AIHeaderEnd.h"
00248 
00249 
00250 #endif