interfaces/kspeech 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-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 00598 // NOTE: kspeech class is now obsolete. Please use KSpeech instead. 00599 00600 class KSpeech : virtual public DCOPObject { 00601 K_DCOP 00602 00603 public: 00608 enum kttsdJobState 00609 { 00610 jsQueued = 0, 00611 jsSpeakable = 1, 00612 jsSpeaking = 2, 00613 jsPaused = 3, 00614 jsFinished = 4 00615 }; 00616 00621 enum kttsdMarkupType 00622 { 00623 mtPlain = 0, 00624 mtJsml = 1, 00625 mtSsml = 2, 00626 mtSable = 3 00627 }; 00628 00629 k_dcop: 00632 00642 virtual bool supportsMarkup(const QString &talker, uint markupType = 0) const = 0; 00643 00651 virtual bool supportsMarkers(const QString &talker) const = 0; 00652 00666 virtual ASYNC sayScreenReaderOutput(const QString &msg, const QString &talker) = 0; 00667 00679 virtual ASYNC sayWarning(const QString &warning, const QString &talker) = 0; 00680 00692 virtual ASYNC sayMessage(const QString &message, const QString &talker) = 0; 00693 00720 virtual ASYNC setSentenceDelimiter(const QString &delimiter) = 0; 00721 00746 virtual uint setText(const QString &text, const QString &talker) = 0; 00747 00763 virtual int appendText(const QString &text, uint jobNum=0) = 0; 00764 00790 virtual uint setFile(const QString &filename, const QString &talker, 00791 const QString& encoding) = 0; 00792 00804 virtual int getTextCount(uint jobNum=0) = 0; 00805 00815 virtual uint getCurrentTextJob() = 0; 00816 00821 virtual uint getTextJobCount() = 0; 00822 00827 virtual QString getTextJobNumbers() = 0; 00828 00838 virtual int getTextJobState(uint jobNum=0) = 0; 00839 00880 virtual QByteArray getTextJobInfo(uint jobNum=0) = 0; 00881 00888 virtual QString talkerCodeToTalkerId(const QString& talkerCode) = 0; 00889 00899 virtual QString getTextJobSentence(uint jobNum=0, uint seq=0) = 0; 00900 00905 virtual bool isSpeakingText() const = 0; 00906 00918 virtual ASYNC removeText(uint jobNum=0) = 0; 00919 00937 virtual ASYNC startText(uint jobNum=0) = 0; 00938 00957 virtual ASYNC stopText(uint jobNum=0) = 0; 00958 00979 virtual ASYNC pauseText(uint jobNum=0) = 0; 00980 00999 virtual ASYNC resumeText(uint jobNum=0) = 0; 01000 01008 virtual QStringList getTalkers() = 0; 01009 01020 virtual ASYNC changeTextTalker(const QString &talker, uint jobNum=0 ) = 0; 01021 01029 virtual QString userDefaultTalker() = 0; 01030 01040 virtual ASYNC moveTextLater(uint jobNum=0) = 0; 01041 01055 virtual int jumpToTextPart(int partNum, uint jobNum=0) = 0; 01056 01070 virtual uint moveRelTextSentence(int n, uint jobNum=0) = 0; 01071 01075 virtual ASYNC speakClipboard() = 0; 01076 01082 virtual void showDialog() = 0; 01083 01087 virtual void kttsdExit() = 0; 01088 01092 virtual void reinit() = 0; 01094 01095 k_dcop_signals: 01096 void ignoreThis(); 01097 01100 01104 void kttsdStarted(); 01108 void kttsdExiting(); 01116 void markerSeen(const QCString& appId, const QString& markerName); 01125 void sentenceStarted(const QCString& appId, uint jobNum, uint seq); 01134 void sentenceFinished(const QCString& appId, uint jobNum, uint seq); 01135 01141 void textSet(const QCString& appId, uint jobNum); 01142 01150 void textAppended(const QCString& appId, uint jobNum, int partNum); 01151 01157 void textStarted(const QCString& appId, uint jobNum); 01167 void textFinished(const QCString& appId, uint jobNum); 01176 void textStopped(const QCString& appId, uint jobNum); 01182 void textPaused(const QCString& appId, uint jobNum); 01188 void textResumed(const QCString& appId, uint jobNum); 01195 void textRemoved(const QCString& appId, uint jobNum); 01197 }; 01198 01199 #endif // _KSPEECH_H_
KDE Logo
This file is part of the documentation for interfaces/kspeech Library Version 3.4.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 14 00:45:46 2005 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003