AIUser.h Go to the documentation of this file. #ifndef __AIUser__ #define __AIUser__ /* * Name: AIUser.h * $Revision: 15 $ * Author: * Date: * Purpose: Adobe Illustrator User Utilities Suite. * * ADOBE SYSTEMS INCORPORATED * Copyright 2016 Adobe Systems Incorporated. * All rights reserved. * * NOTICE: Adobe permits you to use, modify, and distribute this file * in accordance with the terms of the Adobe license agreement * accompanying it. If you have received this file from a source other * than Adobe, then your use, modification, or distribution of it * requires the prior written permission of Adobe. * */ /******************************************************************************* ** ** Imports ** **/ #ifndef __AIArt__ #include "AIArt.h" #endif #ifndef __AITypes__ #include "AITypes.h" #endif #ifndef __AIColor__ #include "AIColor.h" #endif #ifndef __AIMenu__ #include "AIMenu.h" #endif #ifndef __AIFileFormat__ #include "AIFileFormat.h" #endif #ifndef __AIDocumentView__ #include "AIDocumentView.h" #endif #include "IAIFilePath.hpp" #include "IAILocale.h" #include "AIHeaderBegin.h" /************************************************************************s******* ** ** Constants ** **/ // v.14.0 #define kAIUserSuite "AI User Suite" #define kAIUserSuiteVersion14 AIAPI_VERSION(14) #define kAIUserSuiteVersion kAIUserSuiteVersion14 #define kAIUserVersion kAIUserSuiteVersion #if Macintosh || MSWindows #define kAIMacUserSuite "AI Mac User Suite" #define kAIMacUserSuiteVersion7 AIAPI_VERSION(7) #define kAIMacUserSuiteVersion kAIMacUserSuiteVersion7 #define kAIMacUserVersion kAIMacUserSuiteVersion #endif enum { kShortUnits, kLongSingularUnits, kLongPluralUnits }; enum AIAnswer { kAIAnswer_No = 0, kAIAnswer_Yes, kAIAnswer_Cancel, kAIAnswer_Invalid = 0xFFFFFFFF }; enum AIValidationStage { kAIValidationStage_interactive = 0, kAIValidationStage_onOk = 1 }; enum AIPredefinedCursor { kAIIBeamCursorID = -1, kAICrossCursorID = -2, kAIWaitCursorID = -3, kAIArrowCursorID = -4 }; #define kUnknownUnitsErr '?UNT' #define kApplicationNotFoundErr 'App?' #define kObjectNotLinkedErr '!Lnk' typedef ai::uint32 AIUserDateTime; typedef struct _t_Opaque_AIResourceManagerHandle *AIResourceManagerHandle; typedef AIBoolean (*IsValidInputProc) (AIValidationStage validationStage, const ai::UnicodeString &input, ai::UnicodeString &errorStr, void *userdata); #define kAIUniversalLocaleFormat 0x0000 #define kAIResourceLocaleFormat 0x0001 #define kAISystemLocaleFormat 0x0002 #define kAIShortDateFormat 0x0000 #define kAILongDateFormat 0x0100 #define kAIAbbrevDateFormat 0x0200 #define kAIShortTimeFormat 0x0000 #define kAILongTimeFormat 0x0100 /******************************************************************************* ** ** Types ** **/ struct AIAutoNameGenerator { ai::int32 maximumLength; AIBoolean uniqueNames; ai::UnicodeString baseName; ai::int32 nextNewNameIndex; AIAPI AIErr (*HasName) (AIAutoNameGenerator &self, const ai::UnicodeString &name, AIBoolean &hasit); }; struct AIFileDialogFilters { void AddFilter(const ai::UnicodeString &desc); void AddFilter(const ai::UnicodeString &desc, const ai::UnicodeString &pattern); const ai::UnicodeString &GetFilter() const; private: ai::UnicodeString filterStr; }; struct AIExpressionOptions { ai::uint32 unit; AIDouble minValue; AIDouble maxValue; AIDouble oldValue; ai::uint32 precision; }; struct AIUserSuite { AIAPI AIBoolean (*Cancel) ( void ); AIAPI void (*UpdateProgress) ( ai::int32 current, ai::int32 max ); AIAPI void (*SetProgressText) ( const ai::UnicodeString& text ); AIAPI void (*CloseProgress) ( void ); AIAPI void (*AIRealToString) ( AIReal value, ai::int16 precision, ai::UnicodeString& string ); AIAPI void (*StringToAIReal) ( const ai::UnicodeString& string, AIReal *value ); AIAPI void (*IUAIRealToString) ( AIReal value, ai::int16 precision, ai::UnicodeString& string ); AIAPI void (*IUAIRealToStringWithLocale) ( AIReal value, ai::int16 precision, ai::UnicodeString& string, const ai::LocaleID locale ); AIAPI void (*IUStringToAIReal) ( const ai::UnicodeString& string, AIReal *value ); AIAPI AIErr (*IUAIRealToStringUnits) ( AIReal value, ai::int32 precision, ai::UnicodeString& string ); AIAPI void (*IUStringUnitsToAIReal) ( const ai::UnicodeString& string, AIReal *value ); AIAPI AIErr (*GetUnitsString) ( ai::int16 format, ai::UnicodeString& string ); AIAPI AIErr (*GetGlobalObjectDisplayName)( ai::UnicodeString& name ); AIAPI AIErr (*EditInOriginalApp) ( AIArtHandle art ); AIAPI AIErr (*AppIdle) ( void ); AIAPI AIErr (*BuildDirectoryMenu) ( AIPlatformMenuHandle menu, const ai::FilePath &fileSpec); AIAPI AIErr (*GetIndexedDirectorySpec) ( ai::FilePath &fileSpec, ai::int32 index); AIAPI AIErr (*RevealTheFile) ( const ai::FilePath &fileSpec); AIAPI void (*DisableProgressCancel) ( void ); AIAPI AIBoolean (*OKToAllocateMemory) ( void ); // Introduced in AI 11 AIAPI AIErr (*GetDateAndTime)(AIUserDateTime *outValue); /* Formats a date into a Unicode string. @param inValue The date to format, or \c NULL to format the current date-time value. @param formatFlag The format to use, one of: <br> \c #kAIShortDateFormat <br> \c #kAILongDateFormat <br> \c #kAIAbbrevDateFormat @param dateStringUS [out] A buffer in which to return the formatted date string. */ AIAPI AIErr (*GetDateString)(const AIUserDateTime *inValue, const ai::int32 formatFlag, ai::UnicodeString& dateStringUS); /* Formats a time into a Unicode string. @param inValue The time to format, or \c NULL to format the current date-time value. @param formatFlag The format to use, one of: <br> \c #kAIShortTimeFormat <br> \c #kAILongTimeFormat @param dateStringUS [out] A buffer in which to return the formatted time string. */ AIAPI AIErr (*GetTimeString)(const AIUserDateTime *inValue, const ai::int32 formatFlag, ai::UnicodeString& dateStringUS); AIAPI AIErr (*GetYear)(const AIUserDateTime *inValue, int *year); AIAPI AIErr (*GetMonth)(const AIUserDateTime *inValue, int *month); AIAPI AIErr (*GetDay)(const AIUserDateTime *inValue, int *day); AIAPI AIErr (*GetHour)(const AIUserDateTime *inValue, int *hour); AIAPI AIErr (*GetMinute)(const AIUserDateTime *inValue, int *minute); AIAPI AIErr (*GetSecond)(const AIUserDateTime *inValue, int *second); AIAPI AIErr (*GetDayOfWeek)(const AIUserDateTime *inValue, int *dayOfWeek); AIAPI AIErr (*LaunchApp)(const ai::FilePath &spFileSpec, ASBoolean openDoc); AIAPI AIErr (*NextName) (AIAutoNameGenerator &set, ai::UnicodeString &name); AIAPI AIErr (*CopyOfName) (AIAutoNameGenerator &set, const ai::UnicodeString &original, ai::UnicodeString &copy); AIAPI AIErr (*SameName) (const ai::UnicodeString &name1, const ai::UnicodeString &name2, AIBoolean &same); AIAPI AIErr (*PutFileDialog)(const ai::UnicodeString &title, const AIFileDialogFilters*, const ai::UnicodeString &defaultName, ai::FilePath &ioFilePath); AIAPI AIErr (*GetFileDialog)(const ai::UnicodeString &title, const AIFileDialogFilters*, ai::FilePath &ioFilePath); AIAPI AIErr (*GetDirectoryDialog)(const ai::UnicodeString &title, ai::FilePath &ioFilePath); AIAPI AIBoolean (*OKCancelAlert) (const ai::UnicodeString& msg, AIBoolean defaultOk, const char* dontShowKey); AIAPI void (*WarningAlert) (const ai::UnicodeString& msg, const char* dontShowKey); AIAPI void (*MessageAlertEx) (const ai::UnicodeString& msg, const char* dontShowKey); AIAPI AIAnswer (*QuestionAlert)(const ai::UnicodeString &msg); AIAPI AIAnswer (*YesNoAlert)(const ai::UnicodeString &msg); AIAPI void (*ErrorAlert)(const ai::UnicodeString &msg); AIAPI void (*MessageAlert)(const ai::UnicodeString &msg); AIAPI AIBoolean (*ChooseFromOSColorPicker) (const AIPoint &inLocation, const AIRGBColor& inColor, AIRGBColor* outColor); AIAPI AIErr (*EvaluateExpression)(const ai::UnicodeString& expr, const AIExpressionOptions& options, ai::UnicodeString& evaluatedExpr, AIBoolean & isChanged , AIDouble& numericValue); AIAPI AIErr (*GetInputFromUser) ( const ai::UnicodeString &title, const ai::UnicodeString* messageText, const ai::UnicodeString &label, ai::UnicodeString& ioField, IsValidInputProc validator, void *userdata, ai::int32 maxInputChars); AIAPI AIErr (*CreateCursorResourceMgr)(SPPluginRef, AIResourceManagerHandle* inRscMgr); AIAPI AIErr (*SetCursor)(ai::int32 cursorID, AIResourceManagerHandle inRscMgr); AIAPI AIErr (*DisposeCursorResourceMgr)(AIResourceManagerHandle); AIAPI AIErr (*GetAILanguageCode)(ai::UnicodeString& lang); AIAPI AIReal (*GetMaximumScaleFactorOnSystem)(); AIAPI AIReal(*GetArtToViewScaleFactor)(AIDocumentViewHandle view); AIAPI AIErr(*LaunchFolder)(ai::FilePath folderPath); }; /* Inline members */ inline void AIFileDialogFilters::AddFilter(const ai::UnicodeString &desc) { AddFilter(desc, ai::UnicodeString("*")); } inline void AIFileDialogFilters::AddFilter(const ai::UnicodeString &desc, const ai::UnicodeString &pattern) { if (!desc.empty() && !pattern.empty()) { const ai::UnicodeString::size_type len = filterStr.length(); if (len) filterStr.erase(len-1); // erase one null of the previous double null terminators filterStr.append(desc); filterStr.append(1, 0); filterStr.append(pattern); filterStr.append(2, 0); } } inline const ai::UnicodeString &AIFileDialogFilters::GetFilter() const { return filterStr; } #include "AIHeaderEnd.h" #endif

Copyright © 2016 Adobe Systems Incorporated. All rights reserved. Terms of Use Online Privacy Policy Adobe and accessibility Avoid software piracy Permissions and Trademarks