kttsd Library API Documentation

pluginproc.h

00001 /***************************************************** vim:set ts=4 sw=4 sts=4:
00002   pluginproc.h
00003   This file is the template for the processing plug ins.
00004   -------------------
00005   Copyright : (C) 2002-2003 by José Pablo Ezequiel "Pupeno" Fernández
00006   Copyright : (C) 2004 by Gary Cramblitt <garycramblitt@comcast.net>
00007   -------------------
00008   Original author: José Pablo Ezequiel "Pupeno" Fernández <pupeno@kde.org>
00009   Current Maintainer: Gary Cramblitt <garycramblitt@comcast.net>
00010  ******************************************************************************/
00011 
00012 /***************************************************************************
00013  *                                                                         *
00014  *   This program is free software; you can redistribute it and/or modify  *
00015  *   it under the terms of the GNU General Public License as published by  *
00016  *   the Free Software Foundation; version 2 of the License.               *
00017  *                                                                         *
00018  ***************************************************************************/
00019 
00020 #ifndef _PLUGINPROC_H_
00021 #define _PLUGINPROC_H_
00022 
00023 #include <qobject.h>
00024 #include <qstring.h>
00025 
00026 #include <kconfig.h>
00027 
00220 enum pluginState
00221 {
00222     psIdle = 0,                  
00223     psSaying = 1,                
00224     psSynthing = 2,              
00225     psFinished = 3               
00226 };
00227 
00228 class PlugInProc : virtual public QObject{
00229     Q_OBJECT
00230 
00231     public:
00235         PlugInProc( QObject *parent = 0, const char *name = 0);
00236 
00241         virtual ~PlugInProc();
00242 
00257         virtual bool init(KConfig *config, const QString &configGroup);
00258 
00268         virtual void sayText(const QString &text);
00269 
00283         virtual void synthText(const QString &text, const QString &suggestedFilename);
00284 
00294         virtual QString getFilename();
00295 
00311         virtual void stopText();
00312 
00320         virtual pluginState getState();
00321 
00330         virtual void ackFinished();
00331 
00341         virtual bool supportsAsync();
00342 
00356         virtual bool supportsSynth();
00357 
00367         virtual QString getSsmlXsltFilename();
00368 
00369     signals:
00373         void synthFinished();
00377         void sayFinished();
00381         void stopped();
00397         void error(const bool keepGoing, const QString &msg);
00398 };
00399 
00400 #endif // _PLUGINPROC_H_
KDE Logo
This file is part of the documentation for kttsd Library Version 3.3.90.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sun Dec 12 14:37:18 2004 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003