Modules | Files | Inheritance Tree | Inheritance Graph | Name Index
module GNOME::Speech
interface EngineErrorEvent
Files: GNOME_Speech.idl
GNOME-Speech-EngineErrorEvent-inheritance GNOME-Speech-EngineEvent.html GNOME-Speech-SpeechEvent.html GNOME-Speech-SpeechObject.html Bonobo-Unknown.html

EngineErrorEvent is an asynchronous notification of an internal error in the engine which prevents normal behavior of that engine. The event encapsulates a string that provides details about the error.

See Also:
EngineListener#engineError


Consts Summary:
longENGINE_ERROR = 550

Operations Summary:
 voidinitWithError(in Engine source, in long id, in string error, in long long oldEngineState, in long long newEngineState)
 stringgetEngineError()

Consts Inherited from EngineEvent
ENGINE_ALLOCATED, ENGINE_DEALLOCATED, ENGINE_ALLOCATING_RESOURCES, ENGINE_DEALLOCATING_RESOURCES, ENGINE_PAUSED, ENGINE_RESUMED

Operations Inherited from EngineEvent
initWithEngineAndState, getNewEngineState, getOldEngineState

Operations Inherited from SpeechEvent
init, initWithId, getId, getSource, paramString, toString

Operations Inherited from Bonobo::Unknown
ref, unref, queryInterface

Const Details:
long ENGINE_ERROR = 550

Identifier for event issued when engine error occurs.

See Also:
EngineListener#engineError


Operation Details:
 void initWithError(in Engine source, in long id, in string error, in long long oldEngineState, in long long newEngineState)

Initializes an EngineErrorEvent with an event identifier, error string, old engine state and new engine state. The old and new states are zero if the engine states are unknown or undefined.

Parameters:
source - the object that issued the event.
id - the identifier for the event type.
error - description of the detected error.
oldEngineState - engine state prior to this event.
newEngineState - engine state following this event.
See Also:
Engine#getEngineState


 string getEngineError()

Return the string (Exception or Error) that describes the engine problem.

Return:
the error description.