# ECXMLControlEvent

## Abstract

An event holder carrying the XML event and the current context

## Methods

`-attributeName`
  Used to return the currently selected attribute name in case of an "eventId_addAttribute" event
`-attributes`
`-attributeValue`
  Used to return the currently selected attribute value in case of an "eventId_addAttribute" event
`-elementName`
  returns the name of the xml element type in case of an `` or `` event
`-eventId`
`+eventId_addAllAttributes`
`+eventId_addAttribute`
`+eventId_elementEnded`
`+eventId_elementStarted`
`-initAddAttributeEventWithName`
  Creates an event used to add one attribute which is specified within an xml element.
`-initAddAttributeEventWithName:withAttributeName:withAttributeValue:`
  Creates an event used to add one attribute which is specified within an xml element.
`-initElementEndedEventWithName:`
  Used to create an event that indicates the closing of an xml element type
`-initElementStartedEventWithName`
  Used to create an event that indicates the begining of an xml element type
`-initElementStartedEventWithName:withAttributes:`
  Used to create an event that indicates the begining of an xml element type

### attributeName

Used to return the currently selected attribute name in case of an "eventId_addAttribute" event

>     - (NSString *) attributeName;

method result
  name of the currently selected attribute or nil

### attributes

>     - (NSMutableDictionary *) attributes;

method result
  the attributes given by the event `` or nil. Note that you may change this set but while doing so you should take care of any side-effects.

### attributeValue

Used to return the currently selected attribute value in case of an "eventId_addAttribute" event

>     - (NSString *) attributeValue;

method result
  value of the currently selected attribute or nil

### elementName

returns the name of the xml element type in case of an `` or `` event

>     - (NSString *) elementName;

method result
  the name of the xml element type or nil

### eventId

>     - eventId;

method result
  identifier for the event

### eventId_addAllAttributes

>     + (const id) eventId_addAllAttributes;

method result
  identifying object for the event that marks passing of all attributes

##### Discussion

You may not call retain or release on the returned reference

### eventId_addAttribute

>     + (const id) eventId_addAttribute;

method result
  identifying object for the event that marks the passing of an attribute value

##### Discussion

You may not call retain or release on the returned reference

### eventId_elementEnded

>     + (const id) eventId_elementEnded;

method result
  identifying object for the event that marks the ending of an element

##### Discussion

You may not call retain or release on the returned reference

### eventId_elementStarted

>     + (const id) eventId_elementStarted;

method result
  identifying object for the event that marks the opening of an element

##### Discussion

You may not call retain or release on the returned reference

### initAddAttributeEventWithName

Creates an event used to add one attribute which is specified within an xml element.

See Also:

> initAddAttributeEventWithName:withAttributeName:withAttributeValue:

>     - initAddAttributeEventWithName: (NSString *) anElementName withAttributeName: (NSString *) anAttributeName withAttributeValue: (NSString *) anAttributeValue;

##### Parameter Descriptions

> `anElementName`
>   xml element name
> `anAttributeName`
>   name of the attribute
> `anAttributeValue`
>   related value of attribute

method result
  self

### initAddAttributeEventWithName:withAttributeName:withAttributeValue:

Creates an event used to add one attribute which is specified within an xml element.

See Also:

> initAddAttributeEventWithName

>     - initAddAttributeEventWithName: (NSString *) anElementName withAttributeName: (NSString *) anAttributeName withAttributeValue: (NSString *) anAttributeValue;

##### Parameter Descriptions

> `anElementName`
>   xml element name
> `anAttributeName`
>   name of the attribute
> `anAttributeValue`
>   related value of attribute

### initElementEndedEventWithName:

Used to create an event that indicates the closing of an xml element type

>     - initElementEndedEventWithName: (NSString *) anElementName;

##### Parameter Descriptions

> `anElementName`
>   name of the ending xml element type

method result
  self

### initElementStartedEventWithName

Used to create an event that indicates the begining of an xml element type

See Also:

> initElementStartedEventWithName:withAttributes:

>     - initElementStartedEventWithName: (NSString *) anElementName withAttributes: (NSDictionary *) theAttributes;

##### Parameter Descriptions

> `anElementName`
>   name of the begining xml element type

method result
  self

### initElementStartedEventWithName:withAttributes:

Used to create an event that indicates the begining of an xml element type

See Also:

> initElementStartedEventWithName

>     - initElementStartedEventWithName: (NSString *) anElementName withAttributes: (NSDictionary *) theAttributes;

##### Parameter Descriptions

> `anElementName`
>   name of the begining xml element type

(Last Updated August 27, 2006)