API: AIUndo.h Source File

00001 #pragma once
00002 
00003 /*************************************************************************
00004 *
00005 * ADOBE CONFIDENTIAL
00006 *
00007 * Copyright 1986 Adobe
00008 *
00009 * All Rights Reserved.
00010 *
00011 * NOTICE: Adobe permits you to use, modify, and distribute this file in
00012 * accordance with the terms of the Adobe license agreement accompanying
00013 * it. If you have received this file from a source other than Adobe,
00014 * then your use, modification, or distribution of it requires the prior
00015 * written permission of Adobe.
00016 *
00017 **************************************************************************/
00018 
00019 
00020 /*******************************************************************************
00021  **
00022  **     Imports
00023  **
00024  **/
00025 
00026 #include "AITypes.h"
00027 #include "IAIUnicodeString.h"
00028 
00029 #include "AIHeaderBegin.h"
00030 
00034 /*******************************************************************************
00035  **
00036  ** Constants
00037  **
00038  **/
00039 
00040 #define kAIUndoSuite                    "AI Undo Suite"
00041 #define kAIUndoSuiteVersion             AIAPI_VERSION(9)
00042 #define kAIUndoVersion                  kAIUndoSuiteVersion
00043 
00044 
00046 enum AIUndoContextKind {
00049         kAIStandardUndoContext = 0,
00052         kAISilentUndoContext,
00058         kAIAppendUndoContext
00059 };
00060 
00061 
00062 /*******************************************************************************
00063  **
00064  **     Suite
00065  **
00066  **/
00067 
00108 typedef struct {
00109 
00117         AIAPI AIErr (*SetUndoTextUS) ( const ai::UnicodeString& undoText, const ai::UnicodeString& redoText );
00118 
00121         AIAPI AIErr (*UndoChanges) ( void );
00122 
00125         AIAPI AIErr (*SetActionPaletteUndo) ( void );
00126 
00131         AIAPI AIErr (*RevertAndForgetLastTransaction) ( 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 #if defined(ILLUSTRATOR_MINIMAL)
00210 
00213     AIAPI AIErr (*BeginSilentChanges) ( void );
00214     
00218     AIAPI AIErr (*EndSilentChanges) ( void );
00219 
00220 #endif
00221 
00222 } AIUndoSuite;
00223 
00224 
00225 #include "AIHeaderEnd.h"