AccessEngine :: AEUserInterface :: AEUserInterface :: Class AEUserInterface

Class AEUserInterface

object --+
         |
        AEUserInterface

Most base class for all user interface elements. Subclasses of this class include AEOutput, AEInput, AEMonitor, AEChooser, AEScript, and task. Provides methods for getting metadata about a loaded instance of a UIE including its class name, human readable name, description, and path on disk (when applicable).

Instance Methods

[hide private]

string

getClassName(self)
Returns: Name of this object's class

source code

string

getName(self)
Returns: Human readable name of this object.

source code

string

getPath(self)
Returns: Absolute path location of the module containing the implementor of this interface

source code

string

getDescription(self)
Returns: Description of this component.

source code

Inherited from object: __delattr__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

getClassName(self)

source code

Returns: string: Name of this object's class

getName(self)

source code

Returns: string: Human readable name of this object. Defaults to its class name.

getPath(self)

source code

Returns: string: Absolute path location of the module containing the implementor of this interface

getDescription(self)

source code

Returns: string: Description of this component. Defaults to the first paragraph (all lines up to the first blank line) in its class docstring.