API: AILayer.h Source File

00001 #ifndef __AILayer__
00002 #define __AILayer__
00003 
00004 /*
00005  *        Name: AILayer.h
00006  *   $Revision: 12 $
00007  *      Author:
00008  *        Date:
00009  *     Purpose: Adobe Illustrator Layers.
00010  *
00011  * ADOBE SYSTEMS INCORPORATED
00012  * Copyright 1986-2007 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 #include "IAIUnicodeString.h"
00035 
00036 
00037 #include "AIHeaderBegin.h"
00038 
00041 /*******************************************************************************
00042  **
00043  ** Constants
00044  **
00045  **/
00046 
00047 #define kAILayerSuiteVersion10          AIAPI_VERSION(13)               // Illustrator 12.0
00048 
00049 
00050 #define kAILayerSuite                           "AI Layer Suite"
00051 #define kAILayerSuiteVersion            kAILayerSuiteVersion10          // The current version
00052 
00053 #define kAILayerVersion                         kAILayerSuiteVersion
00054 
00059 #define kAICurrentLayerNotifier                 "AI Current Layer Notifier"
00060 
00065 #define kAILayerDeletionNotifier                "AI Layer Deletion Notifier"
00066 
00070 #define kAILayerSetNotifier                             "AI Layer Set Notifier"
00071 
00075 #define kAILayerOptionsNotifier                 "AI Layer Options Notifier"
00076 
00079 #define kAILayerArtStyleChangeNotifier  "AI Layer Art Style Change Notifier"
00080 
00081 
00084 #define kCantDeleteLastLayerErr                 '!XLL'
00085 
00086 
00087 /*******************************************************************************
00088  **
00089  **     Suite
00090  **
00091  **/
00092 
00130 typedef struct {
00131 
00138         AIAPI AIErr (*CountLayers) ( ai::int32 *count );
00139 
00151         AIAPI AIErr (*GetNthLayer) ( ai::int32 n, AILayerHandle *layer );
00152 
00158         AIAPI AIErr     (*GetCurrentLayer) ( AILayerHandle *layer );
00159 
00165         AIAPI AIErr     (*SetCurrentLayer) ( AILayerHandle layer );
00166 
00172         AIAPI AIErr     (*GetFirstLayer) ( AILayerHandle *first );
00173 
00182         AIAPI AIErr     (*GetNextLayer) ( AILayerHandle prev, AILayerHandle *next );
00183 
00195         AIAPI AIErr     (*InsertLayer) ( AILayerHandle layer, ai::int16 paintOrder, AILayerHandle *newLayer );
00196 
00202         AIAPI AIErr     (*DeleteLayer) ( AILayerHandle layer );
00203 
00208         AIAPI AIErr (*GetLayerTitle) ( AILayerHandle layer, ai::UnicodeString& title );
00209 
00214         AIAPI AIErr (*SetLayerTitle) ( AILayerHandle layer, const ai::UnicodeString& newTitle );
00215 
00220         AIAPI AIErr (*GetLayerColor) ( AILayerHandle layer, AIRGBColor *color );
00221 
00226         AIAPI AIErr (*SetLayerColor) ( AILayerHandle layer, AIRGBColor color );
00227 
00236         AIAPI AIErr (*GetLayerVisible) ( AILayerHandle layer, AIBoolean *visible );
00237 
00246         AIAPI AIErr (*SetLayerVisible) ( AILayerHandle layer, AIBoolean visible );
00247 
00256         AIAPI AIErr (*GetLayerPreview) ( AILayerHandle layer, AIBoolean *preview );
00257 
00264         AIAPI AIErr (*SetLayerPreview) ( AILayerHandle layer, AIBoolean preview );
00265 
00274         AIAPI AIErr (*GetLayerEditable) ( AILayerHandle layer, AIBoolean *editable );
00275 
00284         AIAPI AIErr (*SetLayerEditable) ( AILayerHandle layer, AIBoolean editable );
00285 
00292         AIAPI AIErr (*GetLayerPrinted) ( AILayerHandle layer, AIBoolean *printed );
00293 
00300         AIAPI AIErr (*SetLayerPrinted) ( AILayerHandle layer, AIBoolean printed );
00301 
00309         AIAPI AIErr (*GetLayerDimPlacedImages) ( AILayerHandle layer, AIBoolean *dimmed );
00310 
00317         AIAPI AIErr (*SetLayerDimPlacedImages) ( AILayerHandle layer, AIBoolean dimmed );
00318 
00319 
00320         // version 5, new for AI 6.0.1
00321 
00329         AIAPI AIErr (*GetLayerSelected) ( AILayerHandle layer, AIBoolean *selected );
00330 
00338         AIAPI AIErr (*SetLayerSelected) ( AILayerHandle layer, AIBoolean selected );
00339 
00340 
00341         // version 6, new for AI 7.0
00342 
00347         AIAPI AIErr (*GetLayerByTitle) ( AILayerHandle *layer, const ai::UnicodeString& title );
00348 
00354         AIAPI AIErr (*LayerHasArt) ( AILayerHandle layer, AIBoolean *hasArt );
00355 
00361         AIAPI AIErr (*LayerHasSelectedArt) ( AILayerHandle layer, AIBoolean *hasSel );
00362 
00366         AIAPI AIErr (*DeselectArtOnLayer) ( AILayerHandle layer );
00367 
00371         AIAPI AIErr (*SelectArtOnLayer) ( AILayerHandle layer );
00372 
00373         // version 7, new for AI 8.0
00374 
00381         AIAPI AIErr (*GetLayerIsTemplate) ( AILayerHandle layer, AIBoolean *isTemplate );
00382 
00388         AIAPI AIErr (*SetLayerIsTemplate) ( AILayerHandle layer, AIBoolean isTemplate );
00389 
00398         AIAPI AIErr (*GetPrevLayer) ( AILayerHandle next, AILayerHandle *prev );
00399 
00407         AIAPI AIErr (*GetLayerDimmedPercent) ( AILayerHandle layer, ai::int32 *percent );
00408 
00414         AIAPI AIErr (*SetLayerDimmedPercent) ( AILayerHandle layer, ai::int32 percent );
00415 
00416         // version 8, new for AI 9.0
00417 
00423         AIAPI AIErr (*GetLayerFirstChild) ( const AILayerHandle layer, AILayerHandle *child );
00424 
00430         AIAPI AIErr (*GetLayerParent) ( const AILayerHandle layer, AILayerHandle *parent );
00431 
00442         AIAPI AIErr (*InsertLayerAtArt) ( const AIArtHandle art, AIPaintOrder paintOrder,
00443                 AILayerHandle *newLayer );
00444 
00453         AIAPI AIErr (*ChangeLayerToGroup) ( const AILayerHandle layer, const AIArtHandle group );
00454 
00462         AIAPI AIErr (*GetNextPreorderLayer) ( AILayerHandle prev, AILayerHandle *next );
00463 
00471         AIAPI AIErr (*GetNextNonChildPreorderLayer) ( AILayerHandle prev, AILayerHandle *next );
00472 
00473 } AILayerSuite;
00474 
00475 
00476 #include "AIHeaderEnd.h"
00477 
00478 #endif