AIUser.h File Reference

#include "AIArt.h"
#include "AITypes.h"
#include "AIColor.h"
#include "AIMenu.h"
#include "AIFileFormat.h"
#include "AIDocumentView.h"
#include "IAIFilePath.hpp"
#include "IAILocale.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIAutoNameGenerator
	Information about the kind of names allowed for a named entity (such as layers, swatches, and styles). More...
struct	AIFileDialogFilters
	These functions manage a collection of file type specifiers for dialog functions in AIUserSuite, which show drop-down lists for each file type. More...
struct	AIExpressionOptions
	A structure that describes how the result should be returned by AIUserSuite::EvaluateExpression(). More...
struct	AIUserSuite
	This suite provides utility functions for working with Illustrator, including unit conversion utilities and a progress bar. More...
Defines
#define	kAIUserSuite   "AI User Suite"
#define	kAIUserSuiteVersion14   AIAPI_VERSION(14)
#define	kAIUserSuiteVersion   kAIUserSuiteVersion14
#define	kAIUserVersion   kAIUserSuiteVersion
#define	kAIMacUserSuite   "AI Mac User Suite"
#define	kAIMacUserSuiteVersion7   AIAPI_VERSION(7)
#define	kAIMacUserSuiteVersion   kAIMacUserSuiteVersion7
#define	kAIMacUserVersion   kAIMacUserSuiteVersion
#define	kUnknownUnitsErr   '?UNT'
	See AIUserSuite.
#define	kApplicationNotFoundErr   'App?'
	See AIUserSuite::EditInOriginalApp().
#define	kObjectNotLinkedErr   '!Lnk'
	See AIUserSuite::EditInOriginalApp().
#define	kAIUniversalLocaleFormat   0x0000
	Global locale format.
#define	kAIResourceLocaleFormat   0x0001
	Local resource locale format.
#define	kAISystemLocaleFormat   0x0002
	System locale format.
#define	kAIShortDateFormat   0x0000
	Short date display format.
#define	kAILongDateFormat   0x0100
	Long date display format.
#define	kAIAbbrevDateFormat   0x0200
	Abbreviated date display format.
#define	kAIShortTimeFormat   0x0000
	Short time display format.
#define	kAILongTimeFormat   0x0100
	Long time display format.
Typedefs
typedef ai::uint32	AIUserDateTime
	Opaque reference to a date-time value.
typedef struct _t_Opaque_AIResourceManagerHandle *	AIResourceManagerHandle
	Opaque reference to a resource manager handle.
typedef AIBoolean(*	IsValidInputProc )(AIValidationStage validationStage, const ai::UnicodeString &input, ai::UnicodeString &errorStr, void *userdata)
	Callback function pointer passed to AIUserSuite::GetInputFromUser().
Enumerations
enum	{ kShortUnits, kLongSingularUnits, kLongPluralUnits }
	Unit formats for AIUserSuite::GetUnitsString(). More...
enum	AIAnswer { kAIAnswer_No = 0, kAIAnswer_Yes, kAIAnswer_Cancel, kAIAnswer_Invalid = 0xFFFFFFFF }
	Constants for alert button choices. More...
enum	AIValidationStage { kAIValidationStage_interactive = 0, kAIValidationStage_onOk = 1 }
	Flag values to determine the stage of input for which a validation callback has been called. More...
enum	AIPredefinedCursor { kAIIBeamCursorID = -1, kAICrossCursorID = -2, kAIWaitCursorID = -3, kAIArrowCursorID = -4 }
	Identifiers for predefined cursors. More...

---

Detailed Description

---

Define Documentation

#define kAIAbbrevDateFormat   0x0200

Abbreviated date display format.

In Windows, equivalent to the short format except in Japanese locale, where it is the long format. In Mac OS, an abbreviated date is "Tue, Mar 20, 2007". The exact form is locale dependent. See AIUserSuite::GetDateString()

#define kAILongDateFormat   0x0100

Long date display format.

An example of a long date is "Tuesday, March 20, 2007". The exact form is locale dependent. See AIUserSuite::GetDateString()

#define kAILongTimeFormat   0x0100

Long time display format.

An example is "hh:mm:ss". The exact form is locale dependent. See AIUserSuite::GetTimeString()

#define kAIMacUserSuite   "AI Mac User Suite"

#define kAIMacUserSuiteVersion   kAIMacUserSuiteVersion7

#define kAIMacUserSuiteVersion7   AIAPI_VERSION(7)

#define kAIMacUserVersion   kAIMacUserSuiteVersion

#define kAIResourceLocaleFormat   0x0001

Local resource locale format.

Defined by the locale of the current resource chain.

#define kAIShortDateFormat   0x0000

Short date display format.

An example of a short date is along the lines of "1/1/2007". The exact form is locale dependent. See AIUserSuite::GetDateString()

#define kAIShortTimeFormat   0x0000

Short time display format.

An example is "hh:mm". The exact form is locale dependent. See AIUserSuite::GetTimeString()

#define kAISystemLocaleFormat   0x0002

System locale format.

Defined by the current system locale.

#define kAIUniversalLocaleFormat   0x0000

Global locale format.

Equivalent to the ENGLISH locale.

#define kAIUserSuite   "AI User Suite"

#define kAIUserSuiteVersion   kAIUserSuiteVersion14

#define kAIUserSuiteVersion14   AIAPI_VERSION(14)

#define kAIUserVersion   kAIUserSuiteVersion

---

Typedef Documentation

typedef struct _t_Opaque_AIResourceManagerHandle* AIResourceManagerHandle

Opaque reference to a resource manager handle.

See AIUserSuite::CreateCursorResourceMgr().

typedef ai::uint32 AIUserDateTime

Opaque reference to a date-time value.

Access with the AIUserSuite.

typedef AIBoolean(* IsValidInputProc)(AIValidationStage validationStage, const ai::UnicodeString &input, ai::UnicodeString &errorStr, void *userdata)

Callback function pointer passed to AIUserSuite::GetInputFromUser().

Can be called at either of two stages: when the alert dialog OK button is pressed (kAIValidationStage_onOk) or when a character of text is entered in the text field (kAIValidationStage_interactive). The function must validate the input string, and return true if the string is valid in the context. If the string fails validation, return false and set the errorStr output parameter to a string suitable for display in the alert dialog as a tool tip.

---

Enumeration Type Documentation

anonymous enum

Unit formats for AIUserSuite::GetUnitsString().

Enumerator:

kShortUnits	Short unit format; for example, "in".
kLongSingularUnits	Long singular unit format; for example, "inch".
kLongPluralUnits	Long plural unit format; for example, "inches".

enum AIAnswer

Constants for alert button choices.

See AIUserSuite.

Enumerator:

kAIAnswer_No
kAIAnswer_Yes
kAIAnswer_Cancel
kAIAnswer_Invalid

enum AIPredefinedCursor

Identifiers for predefined cursors.

See AIUserSuite::SetCursor()

Enumerator:

kAIIBeamCursorID
kAICrossCursorID
kAIWaitCursorID
kAIArrowCursorID

enum AIValidationStage

Flag values to determine the stage of input for which a validation callback has been called.

See AIUserSuite::GetInputFromUser() and IsValidInputProc.

Enumerator:

kAIValidationStage_interactive	Callback invoked on entry of a single character in the text field.
kAIValidationStage_onOk	Callback invoked on dismissal of alert dialog with OK button.