Modules | Files | Inheritance Tree | Inheritance Graph | Name Index
module GNOME::Speech::Synthesis
interface SpeakableEvent
Files: GNOME_Speech.idl
GNOME-Speech-Synthesis-SpeakableEvent-inheritance GNOME-Speech-SpeechEvent.html GNOME-Speech-SpeechObject.html Bonobo-Unknown.html
Operations Summary:
 voidinitWithMarkerType(in SpeechObject source, in long id, in string text, in long markerType)
 voidinitWithWordEnd(in SpeechObject source, in long id, in string text, in long wordStart, in long wordEnd)
 longgetMarkerType()
 stringgetText()
 longgetWordEnd()
 longgetWordStart()

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

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

Operation Details:
 void initWithMarkerType(in SpeechObject source, in long id, in string text, in long markerType)

Initialises an SpeakableEvent with a specified source, identifier, text and marker type (used for a MARKER_REACHED event).

Parameters:
source - the specified source.
id - the identifier.
text - the text.
markerType - the marker type (used for a MARKER_REACHED event).


 void initWithWordEnd(in SpeechObject source, in long id, in string text, in long wordStart, in long wordEnd)

Initializer for a specified source, identifier, text, wordStart and wordEnd (called for a WORD_STARTED event).

Parameters:
source - the specified source.
id - the identifier.
text - the text.
wordStart - the word start (called for a WORD_STARTED event).
wordEnd - the word end.


 long getMarkerType()

Get the marker type.

Return:
the type of a MARKER_REACHED event.
See Also:
MARKER_REACHED
ELEMENT_OPEN
ELEMENT_CLOSE
ELEMENT_EMPTY


 string getText()

Get the text associated with the event.

For WORD_STARTED, the text is the next word to be spoken. This text may differ from the text between the wordStart and wordEnd points is the original marked up text.

For MARKER_REACHED, the text is the MARK attribute in the marked up text.

Return:
the text associated with the event.
See Also:
WORD_STARTED
MARKER_REACHED


 long getWordEnd()

For a WORD_STARTED event, return the index of the last character of the word in the marked up text.

Return:
the index of the last character of the word in the marked up text.


 long getWordStart()

For a WORD_STARTED event, return the index of the first character of the word in the marked up text.

Return:
the index of the first character of the word in the marked up text.