API: AIUndo.h Source File

00001 #ifndef __AIUndo__
00002 #define __AIUndo__
00003 
00004 /*
00005  *        Name: AIUndo.h
00006  *      Author:
00007  *        Date:
00008  *     Purpose: Adobe Illustrator Undo Suite.
00009  *
00010  * ADOBE SYSTEMS INCORPORATED
00011  * Copyright 1986-2016 Adobe Systems Incorporated.
00012  * All rights reserved.
00013  *
00014  * NOTICE:  Adobe permits you to use, modify, and distribute this file
00015  * in accordance with the terms of the Adobe license agreement
00016  * accompanying it. If you have received this file from a source other
00017  * than Adobe, then your use, modification, or distribution of it
00018  * requires the prior written permission of Adobe.
00019  *
00020  */
00021 
00022 
00023 /*******************************************************************************
00024  **
00025  **     Imports
00026  **
00027  **/
00028 
00029 #include "AITypes.h"
00030 #include "IAIUnicodeString.h"
00031 
00032 #include "AIHeaderBegin.h"
00033 
00037 /*******************************************************************************
00038  **
00039  ** Constants
00040  **
00041  **/
00042 
00043 #define kAIUndoSuite                    "AI Undo Suite"
00044 #define kAIUndoSuiteVersion             AIAPI_VERSION(8)
00045 #define kAIUndoVersion                  kAIUndoSuiteVersion
00046 
00047 
00049 enum AIUndoContextKind {
00052         kAIStandardUndoContext = 0,
00055         kAISilentUndoContext,
00061         kAIAppendUndoContext
00062 };
00063 
00064 
00065 /*******************************************************************************
00066  **
00067  **     Suite
00068  **
00069  **/
00070 
00111 typedef struct {
00112 
00120         AIAPI AIErr (*SetUndoTextUS) ( const ai::UnicodeString& undoText, const ai::UnicodeString& redoText );
00121 
00124         AIAPI AIErr (*UndoChanges) ( void );
00125 
00128         AIAPI AIErr (*SetActionPaletteUndo) ( void );
00129 
00131         AIAPI AIErr (*PurgeAllUndos) ( void );
00132 
00138         AIAPI AIErr (*SetSilent) ( AIBoolean silent );
00139 
00145         AIAPI AIErr (*SetKind) ( ai::int32 kind );
00146 
00155         AIAPI AIErr (*CountTransactions) ( ai::int32* past, ai::int32* future );
00156 
00163         AIAPI AIErr (*IsSilent) ( AIBoolean* silent );
00164 
00170         AIAPI AIErr (*SetTagUS) ( const ai::UnicodeString& tagString, ai::int32 tagInteger );
00171 
00177         AIAPI AIErr (*GetTagUS) ( ai::UnicodeString& tagString, ai::int32* tagInteger );
00178 
00187         AIAPI AIErr (*SetNthTransactionTagUS) ( ai::int32 n, const ai::UnicodeString& tagString, ai::int32 tagInteger );
00188 
00197         AIAPI AIErr (*GetNthTransactionTagUS) ( ai::int32 n, ai::UnicodeString& tagString, ai::int32* tagInteger );
00198 
00202     AIAPI AIErr (*SetRecordingSuspended) ( AIBoolean inSuspend );
00203 
00207     AIAPI AIErr (*IsRecordingSuspended) ( AIBoolean* outIsSuspended );
00208 
00209 } AIUndoSuite;
00210 
00211 
00212 #include "AIHeaderEnd.h"
00213 
00214 
00215 #endif