kttsd Library API Documentation

kspeech.h

00001 /***************************************************** vim:set ts=4 sw=4 sts=4:
00002   kspeech.h
00003   KTTSD DCOP Interface
00004   --------------------
00005   Copyright:
00006   (C) 2002-2003 by José Pablo Ezequiel "Pupeno" Fernández <pupeno@kde.org>
00007   (C) 2003-2004 by Olaf Schmidt <ojschmidt@kde.org>
00008   (C) 2004 by Gary Cramblitt <garycramblitt@comcast.net>
00009   -------------------
00010   Original author: José Pablo Ezequiel "Pupeno" Fernández
00011  ******************************************************************************/
00012 
00013 /***************************************************************************
00014  *                                                                         *
00015  *   This program is free software; you can redistribute it and/or modify  *
00016  *   it under the terms of the GNU General Public License as published by  *
00017  *   the Free Software Foundation; version 2 of the License.               *
00018  *                                                                         *
00019  ***************************************************************************/
00020 
00021 #ifndef _KSPEECH_H_
00022 #define _KSPEECH_H_
00023 
00024 #include <dcopobject.h>
00025 #include <qstringlist.h>
00026 
00651 class kspeech : virtual public DCOPObject {
00652     K_DCOP
00653 
00654     public:
00659         enum kttsdJobState
00660         {
00661             jsQueued = 0,                
00662             jsSpeakable = 1,             
00663             jsSpeaking = 2,              
00664             jsPaused = 3,                
00665             jsFinished = 4               
00666         };
00667         
00672         enum kttsdMarkupType
00673         {
00674             mtPlain = 0,                 
00675             mtJsml = 1,                  
00676             mtSsml = 2,                  
00677             mtSable = 3                  
00678         };
00679     
00680     k_dcop:
00683         
00693         virtual bool supportsMarkup(const QString &talker=NULL, const uint markupType = 0) = 0;
00694         
00702         virtual bool supportsMarkers(const QString &talker=NULL) = 0;
00703         
00717         virtual ASYNC sayScreenReaderOutput(const QString &msg, const QString &talker=NULL) = 0;
00718         
00730         virtual ASYNC sayWarning(const QString &warning, const QString &talker=NULL) = 0;
00731 
00743         virtual ASYNC sayMessage(const QString &message, const QString &talker=NULL) = 0;
00744 
00771         virtual ASYNC setSentenceDelimiter(const QString &delimiter) = 0;
00772         
00797         virtual uint setText(const QString &text, const QString &talker=NULL) = 0;
00798         
00814         virtual int appendText(const QString &text, const uint jobNum=0) = 0;
00815         
00839         virtual uint setFile(const QString &filename, const QString &talker=NULL) = 0;
00840         
00852         virtual int getTextCount(const uint jobNum=0) = 0;
00853 
00863         virtual uint getCurrentTextJob() = 0;
00864         
00869         virtual uint getTextJobCount() = 0;
00870         
00875         virtual QString getTextJobNumbers() = 0;
00876         
00886         virtual int getTextJobState(const uint jobNum=0) = 0;
00887         
00928         virtual QByteArray getTextJobInfo(const uint jobNum=0) = 0;
00929         
00936         virtual QString talkerCodeToTalkerId(const QString& talkerCode) = 0;
00937         
00947         virtual QString getTextJobSentence(const uint jobNum=0, const uint seq=0) = 0;
00948        
00953         virtual bool isSpeakingText() = 0;
00954         
00966         virtual ASYNC removeText(const uint jobNum=0) = 0;
00967 
00985         virtual ASYNC startText(const uint jobNum=0) = 0;
00986 
01005         virtual ASYNC stopText(const uint jobNum=0) = 0;
01006 
01027         virtual ASYNC pauseText(const uint jobNum=0) = 0;
01028 
01047         virtual ASYNC resumeText(const uint jobNum=0) = 0;
01048         
01056         virtual QStringList getTalkers() = 0;
01057         
01068         virtual ASYNC changeTextTalker(const uint jobNum=0, const QString &talker=NULL) = 0;
01069         
01077         virtual QString userDefaultTalker() = 0;
01078         
01088         virtual ASYNC moveTextLater(const uint jobNum=0) = 0;
01089 
01103         virtual int jumpToTextPart(const int partNum, const uint jobNum=0) = 0;
01104         
01118         virtual uint moveRelTextSentence(const int n, const uint jobNum=0) = 0;
01119 
01123         virtual ASYNC speakClipboard() = 0;
01124         
01130         virtual void showDialog() = 0;
01131 
01135         virtual void kttsdExit() = 0;
01136 
01140         virtual void reinit() = 0;
01142         
01143     k_dcop_signals:
01144         void ignoreThis();
01145     
01148         
01152         void kttsdStarted();
01156         void kttsdExiting();
01164         void markerSeen(const QCString& appId, const QString& markerName);
01173         void sentenceStarted(const QCString& appId, const uint jobNum, const uint seq);
01182         void sentenceFinished(const QCString& appId, const uint jobNum, const uint seq);
01183         
01189         void textSet(const QCString& appId, const uint jobNum);
01190         
01198         void textAppended(const QCString& appId, const uint jobNum, const int partNum);
01199     
01205         void textStarted(const QCString& appId, const uint jobNum);
01215         void textFinished(const QCString& appId, const uint jobNum);
01224         void textStopped(const QCString& appId, const uint jobNum);
01230         void textPaused(const QCString& appId, const uint jobNum);
01236         void textResumed(const QCString& appId, const uint jobNum);
01243         void textRemoved(const QCString& appId, const uint jobNum);
01245 };
01246 #endif // _KSPEECH_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