AIXMLElement.h File Reference

#include "AITypes.h"
#include "AIEntry.h"
#include "AIDictionary.h"
#include "AIArray.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIXMLNodeSuite
	This suite allows you to create and manipulate XML nodes. More...
struct	AIXMLDocumentSuite
	An Illustrator document can store an XML document element in its dictionary. More...
struct	AIXMLElementSuite
	This suite allows you to access XML metadata attributes. More...
struct	AIXMLNodeListSuite
	This suite allows you to iterate through and manage lists of XML nodes. More...
struct	AIXMLNamedNodeMapSuite
	This suite allows you to access XML named node maps. More...
Defines
#define	kAIXMLNodeSuite   "AI XML Node Suite"
#define	kAIXMLNodeSuiteVersion5   AIAPI_VERSION(5)
#define	kAIXMLNodeSuiteVersion   kAIXMLNodeSuiteVersion5
#define	kAIXMLNodeVersion   kAIXMLNodeSuiteVersion
#define	kAIXMLDocumentSuite   "AI XML Document Suite"
#define	kAIXMLDocumentSuiteVersion4   AIAPI_VERSION(4)
#define	kAIXMLDocumentSuiteVersion   kAIXMLDocumentSuiteVersion4
#define	kAIXMLDocumentVersion   kAIXMLDocumentSuiteVersion
#define	kAIXMLElementSuite   "AI XML Element Suite"
#define	kAIXMLElementSuiteVersion4   AIAPI_VERSION(4)
#define	kAIXMLElementSuiteVersion   kAIXMLElementSuiteVersion4
#define	kAIXMLElementVersion   kAIXMLElementSuiteVersion
#define	kAIXMLNodeListSuite   "AI XML Node List Suite"
#define	kAIXMLNodeListSuiteVersion3   AIAPI_VERSION(3)
#define	kAIXMLNodeListSuiteVersion   kAIXMLNodeListSuiteVersion3
#define	kAIXMLNodeListVersion   kAIXMLNodeListSuiteVersion
#define	kAIXMLNamedNodeMapSuite   "AI XML Named Node Map Suite"
#define	kAIXMLNamedNodeMapSuiteVersion4   AIAPI_VERSION(4)
#define	kAIXMLNamedNodeMapSuiteVersion   kAIXMLNamedNodeMapSuiteVersion4
#define	kAIXMLNamedNodeMapVersion   kAIXMLNamedNodeMapSuiteVersion
#define	kAIXMLIndexSizeErr   'xInd'
	See AIXMLElementSuite, AIXMLNodeListSuite.
#define	kAIXMLDOMStringSizeErr   'xDSt'
	See AIXMLElementSuite.
#define	kAIXMLHierarchyRequestErr   'xHer'
	See AIXMLDocumentSuite.
#define	kAIXMLWrongDocumentErr   'xDoc'
	See AIXMLDocumentSuite.
#define	kAIXMLInvalidCharacterErr   'xChr'
	See AIXMLElementSuite, AIXMLDocumentSuite.
#define	kAIXMLNoDataAllowedErr   'x!dt'
	See AIXMLDocumentSuite.
#define	kAIXMLNoModifyAllowedErr   'x!mo'
	See AIXMLDocumentSuite.
#define	kAIXMLNotFoundErr   'x!fd'
	See AIXMLDocumentSuite.
#define	kAIXMLNotSupportedErr   'x!sp'
	See AIXMLDocumentSuite.
#define	kAIXMLInUseAttributeErr   'xInU'
	See AIXMLElementSuite.
#define	kAIMetadataSyncNotifier   "AI Metadata Sync Notifier"
	Sent when an operation requiring update of metadata is about to occur.
Typedefs
typedef struct _AIXMLNodeList *	AIXMLNodeListRef
	Opaque reference to an XML node list.
typedef struct _AIXMLNamedNodeMap *	AIXMLNamedNodeMapRef
	Opaque reference to an XML named node map.
typedef struct _AIXMLName *	AIXMLName
	Opaque reference to an XML name.
typedef AIEntryRef	AIXMLString
	An abstract name that can be converted to or from a simple C string or Unicode string.
typedef ai::int32	AIXMLNodeType
	XML node type, an AIXMLNodeTypeValue.
Enumerations
enum	AIXMLNodeTypeValue {   kAIXMLUnknownNode, kAIXMLElementNode, kAIXMLAttributeNode, kAIXMLTextNode,   kAIXMLCDATASectionNode, kAIXMLCommentNode, kAIXMLEntityReferenceNode, kAIXMLEntityNode,   kAIXMLProcessingInstructionNode, kAIXMLDocumentNode, kAIXMLDocumentTypeNode, kAIXMLDocumentFragmentNode,   kAIXMLNotationNode }
	Possible values for AIXMLNodeType. More...

---

Detailed Description

---

Define Documentation

#define kAIXMLDocumentSuite   "AI XML Document Suite"

#define kAIXMLDocumentSuiteVersion   kAIXMLDocumentSuiteVersion4

#define kAIXMLDocumentSuiteVersion4   AIAPI_VERSION(4)

#define kAIXMLDocumentVersion   kAIXMLDocumentSuiteVersion

#define kAIXMLElementSuite   "AI XML Element Suite"

#define kAIXMLElementSuiteVersion   kAIXMLElementSuiteVersion4

#define kAIXMLElementSuiteVersion4   AIAPI_VERSION(4)

#define kAIXMLElementVersion   kAIXMLElementSuiteVersion

#define kAIXMLNamedNodeMapSuite   "AI XML Named Node Map Suite"

#define kAIXMLNamedNodeMapSuiteVersion   kAIXMLNamedNodeMapSuiteVersion4

#define kAIXMLNamedNodeMapSuiteVersion4   AIAPI_VERSION(4)

#define kAIXMLNamedNodeMapVersion   kAIXMLNamedNodeMapSuiteVersion

#define kAIXMLNodeListSuite   "AI XML Node List Suite"

#define kAIXMLNodeListSuiteVersion   kAIXMLNodeListSuiteVersion3

#define kAIXMLNodeListSuiteVersion3   AIAPI_VERSION(3)

#define kAIXMLNodeListVersion   kAIXMLNodeListSuiteVersion

#define kAIXMLNodeSuite   "AI XML Node Suite"

#define kAIXMLNodeSuiteVersion   kAIXMLNodeSuiteVersion5

#define kAIXMLNodeSuiteVersion5   AIAPI_VERSION(5)

#define kAIXMLNodeVersion   kAIXMLNodeSuiteVersion

---

Typedef Documentation

typedef struct _AIXMLName* AIXMLName

Opaque reference to an XML name.

See AIXMLNodeSuite::NameFromString(), AIXMLNodeSuite::SetNodeName().

typedef struct _AIXMLNamedNodeMap* AIXMLNamedNodeMapRef

Opaque reference to an XML named node map.

Access with AIXMLNamedNodeMapSuite

typedef struct _AIXMLNodeList* AIXMLNodeListRef

Opaque reference to an XML node list.

Access with AIXMLNodeListSuite

typedef ai::int32 AIXMLNodeType

XML node type, an AIXMLNodeTypeValue.

See AIXMLNodeSuite::GetNodeType(), AIXMLDocumentSuite

typedef AIEntryRef AIXMLString

An abstract name that can be converted to or from a simple C string or Unicode string.

See AIXMLNodeSuite.

---

Enumeration Type Documentation

enum AIXMLNodeTypeValue

Possible values for AIXMLNodeType.

Enumerator:

kAIXMLUnknownNode
kAIXMLElementNode	Element. See AIXMLDocumentSuite::CreateElement()
kAIXMLAttributeNode	Attribute. See AIXMLDocumentSuite::CreateAttribute()
kAIXMLTextNode	Text. See AIXMLDocumentSuite::CreateTextNode()
kAIXMLCDATASectionNode	CData section. See AIXMLDocumentSuite::CreateCDATASection()
kAIXMLCommentNode	Comment. See AIXMLDocumentSuite::CreateComment()
kAIXMLEntityReferenceNode	Not supported.
kAIXMLEntityNode	Not supported.
kAIXMLProcessingInstructionNode	Not supported.
kAIXMLDocumentNode	Not supported.
kAIXMLDocumentTypeNode	Not supported.
kAIXMLDocumentFragmentNode	Not supported.
kAIXMLNotationNode	Not supported.