AMControl Class Reference

Superclass of all control objects. More...

#import <AMControl.h>

Inheritance diagram for AMControl:

AMMix2DControl AMMix3DControl AMSoundControl AMSpawnControl AMTempoControl AMTriggerControl

List of all members.

Public Member Functions

(void) - setValue:forAttribute:
 Sets the value of the specified attribute.
(id) - valueOfAttribute:
 Gets the value of the specified attribute.
(int) - attributeCode:
 Gets the attribute code (enum int value) for the specified attribute name.

Static Public Member Functions

(AMControl *) + controlWithName:controllable:
 Creates a control object with the given name.

Properties

id parent
 The parent object holding the control.


Detailed Description

Superclass of all control objects.

This class is not destined to be used directly, but to be derived.


Member Function Documentation

- (int) attributeCode: (NSString *)  _attribute  

Gets the attribute code (enum int value) for the specified attribute name.

(THIS METHOD SHOULD ALWAYS BE OVERRIDEN IN SUBCLASSES.)

Parameters:
atribute The name of the attribute.
Returns:
The enumeration integer value of the attribute, or -1 if the attribute doesn't exists for the control.

+ (AMControl *) controlWithName: (NSString *)  _name
controllable: (id)  _controllable 

Creates a control object with the given name.

If the name does not bind to a valid control, nil is returned.

Parameters:
name The name of the control to create.
controllable The object parameterized by the control.
Returns:
The corresponding control object if it can be created or nil else.

- (void) setValue: (id)  _value
forAttribute: (int)  _attribute 

Sets the value of the specified attribute.

(THIS METHOD SHOULD ALWAYS BE OVERRIDEN IN SUBCLASSES.)

Parameters:
value The value to set.
attribute The attribute to set, as specified in the control attributes enumeration.

- (id) valueOfAttribute: (int)  _attribute  

Gets the value of the specified attribute.

(THIS METHOD SHOULD ALWAYS BE OVERRIDEN IN SUBCLASSES.)

Parameters:
attribute The attribute to get the value of.
Returns:
The value of the attribute, or nil if no attribute with this name was found.


The documentation for this class was generated from the following files:

Generated on Mon May 16 16:29:48 2011 for ARIA by  doxygen 1.5.9