diff options
Diffstat (limited to 'kttsd/filters/talkerchooser/talkerchooserproc.h')
-rw-r--r-- | kttsd/filters/talkerchooser/talkerchooserproc.h | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/kttsd/filters/talkerchooser/talkerchooserproc.h b/kttsd/filters/talkerchooser/talkerchooserproc.h new file mode 100644 index 0000000..07cde68 --- /dev/null +++ b/kttsd/filters/talkerchooser/talkerchooserproc.h @@ -0,0 +1,87 @@ +/***************************************************** vim:set ts=4 sw=4 sts=4: + Generic Talker Chooser Filter Configuration class. + ------------------- + Copyright: + (C) 2005 by Gary Cramblitt <garycramblitt@comcast.net> + ------------------- + Original author: Gary Cramblitt <garycramblitt@comcast.net> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + ******************************************************************************/ + +#ifndef _TALKERCHOOSERPROC_H_ +#define _TALKERCHOOSERPROC_H_ + +// KTTS includes. +#include "filterproc.h" +#include "talkercode.h" + +class TalkerChooserProc : virtual public KttsFilterProc +{ + Q_OBJECT + +public: + /** + * Constructor. + */ + TalkerChooserProc( QObject *parent, const char *name, const QStringList &args = QStringList() ); + + /** + * Destructor. + */ + virtual ~TalkerChooserProc(); + + /** + * Initialize the filter. + * @param config Settings object. + * @param configGroup Settings Group. + * @return False if filter is not ready to filter. + * + * Note: The parameters are for reading from kttsdrc file. Plugins may wish to maintain + * separate configuration files of their own. + */ + virtual bool init(KConfig *config, const QString &configGroup); + + /** + * Returns True if the plugin supports asynchronous processing, + * i.e., supports asyncConvert method. + * @return True if this plugin supports asynchronous processing. + * + * If the plugin returns True, it must also implement @ref getState . + * It must also emit @ref filteringFinished when filtering is completed. + * If the plugin returns True, it must also implement @ref stopFiltering . + * It must also emit @ref filteringStopped when filtering has been stopped. + */ + virtual bool supportsAsync(); + + /** + * Convert input, returning output. Runs synchronously. + * @param inputText Input text. + * @param talkerCode TalkerCode structure for the talker that KTTSD intends to + * use for synthing the text. Useful for extracting hints about + * how to filter the text. For example, languageCode. + * @param appId The DCOP appId of the application that queued the text. + * Also useful for hints about how to do the filtering. + */ + virtual QString convert(const QString& inputText, TalkerCode* talkerCode, const QCString& appId); + +private: + + QString m_re; + QStringList m_appIdList; + TalkerCode m_chosenTalkerCode; +}; + +#endif // _TALKERCHOOSERPROC_H_ |