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-2005 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 00644 // NOTE: kspeech class is now obsolete. Please use KSpeech instead. 00645 00646 class KSpeech : virtual public DCOPObject { 00647 K_DCOP 00648 00649 public: 00654 enum kttsdJobState 00655 { 00656 jsQueued = 0, 00657 jsSpeakable = 1, 00658 jsSpeaking = 2, 00659 jsPaused = 3, 00660 jsFinished = 4 00661 }; 00662 00667 enum kttsdMarkupType 00668 { 00669 mtPlain = 0, 00670 mtJsml = 1, 00671 mtSsml = 2, 00672 mtSable = 3, 00673 mtHtml = 4 00674 }; 00675 00676 k_dcop: 00679 00689 virtual bool supportsMarkup(const QString &talker, uint markupType = 0) const = 0; 00690 00698 virtual bool supportsMarkers(const QString &talker) const = 0; 00699 00713 virtual ASYNC sayScreenReaderOutput(const QString &msg, const QString &talker) = 0; 00714 00726 virtual ASYNC sayWarning(const QString &warning, const QString &talker) = 0; 00727 00739 virtual ASYNC sayMessage(const QString &message, const QString &talker) = 0; 00740 00767 virtual ASYNC setSentenceDelimiter(const QString &delimiter) = 0; 00768 00793 virtual uint setText(const QString &text, const QString &talker) = 0; 00794 00823 virtual uint sayText(const QString &text, const QString &talker) = 0; 00824 00840 virtual int appendText(const QString &text, uint jobNum=0) = 0; 00841 00867 virtual uint setFile(const QString &filename, const QString &talker, 00868 const QString& encoding) = 0; 00869 00881 virtual int getTextCount(uint jobNum=0) = 0; 00882 00892 virtual uint getCurrentTextJob() = 0; 00893 00898 virtual uint getTextJobCount() = 0; 00899 00904 virtual QString getTextJobNumbers() = 0; 00905 00915 virtual int getTextJobState(uint jobNum=0) = 0; 00916 00957 virtual QByteArray getTextJobInfo(uint jobNum=0) = 0; 00958 00965 virtual QString talkerCodeToTalkerId(const QString& talkerCode) = 0; 00966 00976 virtual QString getTextJobSentence(uint jobNum=0, uint seq=0) = 0; 00977 00982 virtual bool isSpeakingText() const = 0; 00983 00995 virtual ASYNC removeText(uint jobNum=0) = 0; 00996 01014 virtual ASYNC startText(uint jobNum=0) = 0; 01015 01034 virtual ASYNC stopText(uint jobNum=0) = 0; 01035 01056 virtual ASYNC pauseText(uint jobNum=0) = 0; 01057 01080 virtual ASYNC resumeText(uint jobNum=0) = 0; 01081 01089 virtual QStringList getTalkers() = 0; 01090 01101 virtual ASYNC changeTextTalker(const QString &talker, uint jobNum=0 ) = 0; 01102 01110 virtual QString userDefaultTalker() = 0; 01111 01121 virtual ASYNC moveTextLater(uint jobNum=0) = 0; 01122 01136 virtual int jumpToTextPart(int partNum, uint jobNum=0) = 0; 01137 01151 virtual uint moveRelTextSentence(int n, uint jobNum=0) = 0; 01152 01156 virtual ASYNC speakClipboard() = 0; 01157 01163 virtual void showDialog() = 0; 01164 01168 virtual void kttsdExit() = 0; 01169 01173 virtual void reinit() = 0; 01174 01179 virtual QString version() = 0; 01181 01182 k_dcop_signals: 01183 void ignoreThis(); 01184 01187 01191 void kttsdStarted(); 01195 void kttsdExiting(); 01203 void markerSeen(const QCString& appId, const QString& markerName); 01212 void sentenceStarted(const QCString& appId, uint jobNum, uint seq); 01221 void sentenceFinished(const QCString& appId, uint jobNum, uint seq); 01222 01228 void textSet(const QCString& appId, uint jobNum); 01229 01237 void textAppended(const QCString& appId, uint jobNum, int partNum); 01238 01244 void textStarted(const QCString& appId, uint jobNum); 01254 void textFinished(const QCString& appId, uint jobNum); 01263 void textStopped(const QCString& appId, uint jobNum); 01269 void textPaused(const QCString& appId, uint jobNum); 01275 void textResumed(const QCString& appId, uint jobNum); 01282 void textRemoved(const QCString& appId, uint jobNum); 01284 }; 01285 01286 #endif // _KSPEECH_H_