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

EngineList is a container for a set of EngineModeDesc objects. An EngineList is used in the selection of speech engines in conjuction with the methods of the Central class. It provides convenience methods for the purpose of testing and manipulating the EngineModeDesc objects it contains.

An EngineList object is typically obtained through the availableSynthesizers or availableRecognizers methods of the Central class. The orderByMatch, anyMatch, requireMatch and rejectMatch methods are used to prune the list to find the best match given multiple criteria.

See Also:
EngineModeDesc
Central
Central#availableRecognizers
Central#availableSynthesizers


Operations Summary:
EngineListArraygetEngineList()
 booleananyMatch(in EngineModeDesc require)
 voidorderByMatch(in EngineModeDesc require)
 voidrejectMatch(in EngineModeDesc reject)
 voidrequireMatch(in EngineModeDesc require)

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

Operation Details:
EngineListArray getEngineList()

Return an array of EngineModeDesc objects in this EngineList.

Return:
an array of EngineModeDesc objects.


 boolean anyMatch(in EngineModeDesc require)

Return true if one or more EngineModeDesc in the EngineList match the required properties. The require object is tested with the match method of each EngineModeDesc in the list. If any match call returns true then this method returns true.

anyMatch is often used to test whether pruning a list (with requireMatch or rejectMatch) would leave the list empty.

Parameters:
require - the required EngineModeDesc object to compare against.
Return:
a boolean indication of whether this EngineList contains one (or more) EngineModeDesc objects matching require.
See Also:
EngineModeDesc#match


 void orderByMatch(in EngineModeDesc require)

Order the list so that elements matching the required features are at the head of the list, and others are at the end. Within categories, the original order of the list is preserved.

Parameters:
require - the EngineModeDesc object containing the required features.


 void rejectMatch(in EngineModeDesc reject)

Remove EngineModeDesc entries from the list that do match reject. The match method for each EngineModeDesc in the list is called: if it returns true it is removed from the list.

Parameters:
reject - the EngineModeDesc object containing the features to remove.
See Also:
requireMatch


 void requireMatch(in EngineModeDesc require)

Remove EngineModeDesc entries from the list that do not match require. The match method for each EngineModeDesc in the list is called: if it returns false it is removed from the list.

See Also:
rejectMatch
EngineModeDesc#match