Modules | Files | Inheritance Tree | Inheritance Graph | Name Index
module GNOME::Speech::Recognition
interface GrammarEvent
Files: GNOME_Speech.idl
GNOME-Speech-Recognition-GrammarEvent-inheritance GNOME-Speech-SpeechEvent.html GNOME-Speech-SpeechObject.html Bonobo-Unknown.html
Operations Summary:
 voidinitWithGrammarAndId(in Grammar source, in long id)
 voidinitWithState(in Grammar source, in long id, in boolean enabledChanged, in boolean definitionChanged, in GrammarExceptionValue grammarExceptionValue)
 booleangetDefinitionChanged()
 booleangetEnabledChanged()
GrammarExceptionValuegetGrammarExceptionValue()

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

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

Operation Details:
 void initWithGrammarAndId(in Grammar source, in long id)

Initializes a GrammarEvent event with a specified event identifier. The enabledChanged and definitionChanged fields are set to false. The grammarException field is set to null.

Parameters:
source - the object that issued the event.
id - the identifier for the event type.


 void initWithState(in Grammar source, in long id, in boolean enabledChanged, in boolean definitionChanged, in GrammarExceptionValue grammarExceptionValue)

Initializes a GrammarEvent event with a specified event identifier plus state change and exception values. For a GRAMMAR_CHANGES_COMMITTED event, the enabledChanged and definitionChanged parameters should indicate what properties of the Grammar has changed, otherwise they should be false. For a GRAMMAR_CHANGES_COMMITTED, the grammarException parameter should be non-null only if an error is encountered in the grammar definition.

Parameters:
source - the object that issued the event.
id - the identifier for the event type.
enabledChanged - true if the grammar's enabled property changed.
definitionChanged - true if the grammar's definition has changed.
grammarExceptionValue - non-null if an error is detected in a grammar's definition.


 boolean getDefinitionChanged()

Returns true for a GRAMMAR_CHANGES_COMMITTED event if the definition of the source Grammar has changed.

Return:
true for a GRAMMAR_CHANGES_COMMITTED event if the definition of the source Grammar has changed.


 boolean getEnabledChanged()

Returns true for a GRAMMAR_CHANGES_COMMITTED event if the enabled property of the Grammar changed.

Return:
true for a GRAMMAR_CHANGES_COMMITTED event if the enabled property of the Grammar changed.


GrammarExceptionValue getGrammarExceptionValue()

Returns non-null for a GRAMMAR_CHANGES_COMMITTED event if an error is found in the grammar definition.

Return:
non-null for a GRAMMAR_CHANGES_COMMITTED event if an error is found in the grammar definition.