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 
00643 // NOTE: kspeech class is now obsolete.  Please use KSpeech instead.
00644 
00645 class KSpeech : virtual public DCOPObject {
00646     K_DCOP
00647 
00648     public:
00653         enum kttsdJobState
00654         {
00655             jsQueued = 0,                
00656             jsSpeakable = 1,             
00657             jsSpeaking = 2,              
00658             jsPaused = 3,                
00659             jsFinished = 4               
00660         };
00661 
00666         enum kttsdMarkupType
00667         {
00668             mtPlain = 0,                 
00669             mtJsml = 1,                  
00670             mtSsml = 2,                  
00671             mtSable = 3,                 
00672             mtHtml = 4                   
00673         };
00674 
00675     k_dcop:
00678 
00688         virtual bool supportsMarkup(const QString &talker, uint markupType = 0) const = 0;
00689 
00697         virtual bool supportsMarkers(const QString &talker) const = 0;
00698 
00712         virtual ASYNC sayScreenReaderOutput(const QString &msg, const QString &talker) = 0;
00713 
00725         virtual ASYNC sayWarning(const QString &warning, const QString &talker) = 0;
00726 
00738         virtual ASYNC sayMessage(const QString &message, const QString &talker) = 0;
00739 
00766         virtual ASYNC setSentenceDelimiter(const QString &delimiter) = 0;
00767 
00792         virtual uint setText(const QString &text, const QString &talker) = 0;
00793 
00822         virtual uint sayText(const QString &text, const QString &talker) = 0;
00823 
00839         virtual int appendText(const QString &text, uint jobNum=0) = 0;
00840 
00866         virtual uint setFile(const QString &filename, const QString &talker,
00867             const QString& encoding) = 0;
00868 
00880         virtual int getTextCount(uint jobNum=0) = 0;
00881 
00891         virtual uint getCurrentTextJob() = 0;
00892 
00897         virtual uint getTextJobCount() = 0;
00898 
00903         virtual QString getTextJobNumbers() = 0;
00904 
00914         virtual int getTextJobState(uint jobNum=0) = 0;
00915 
00956         virtual QByteArray getTextJobInfo(uint jobNum=0) = 0;
00957 
00964         virtual QString talkerCodeToTalkerId(const QString& talkerCode) = 0;
00965 
00975         virtual QString getTextJobSentence(uint jobNum=0, uint seq=0) = 0;
00976 
00981         virtual bool isSpeakingText() const = 0;
00982 
00994         virtual ASYNC removeText(uint jobNum=0) = 0;
00995 
01013         virtual ASYNC startText(uint jobNum=0) = 0;
01014 
01033         virtual ASYNC stopText(uint jobNum=0) = 0;
01034 
01055         virtual ASYNC pauseText(uint jobNum=0) = 0;
01056 
01079         virtual ASYNC resumeText(uint jobNum=0) = 0;
01080 
01088         virtual QStringList getTalkers() = 0;
01089 
01100         virtual ASYNC changeTextTalker(const QString &talker, uint jobNum=0 ) = 0;
01101 
01109         virtual QString userDefaultTalker() = 0;
01110 
01120         virtual ASYNC moveTextLater(uint jobNum=0) = 0;
01121 
01135         virtual int jumpToTextPart(int partNum, uint jobNum=0) = 0;
01136 
01150         virtual uint moveRelTextSentence(int n, uint jobNum=0) = 0;
01151 
01155         virtual ASYNC speakClipboard() = 0;
01156 
01162         virtual void showDialog() = 0;
01163 
01167         virtual void kttsdExit() = 0;
01168 
01172         virtual void reinit() = 0;
01173 
01178         virtual QString version() = 0;
01180 
01181     k_dcop_signals:
01182         void ignoreThis();
01183 
01186 
01190         void kttsdStarted();
01194         void kttsdExiting();
01202         void markerSeen(const QCString& appId, const QString& markerName);
01211         void sentenceStarted(const QCString& appId, uint jobNum, uint seq);
01220         void sentenceFinished(const QCString& appId, uint jobNum, uint seq);
01221 
01227         void textSet(const QCString& appId, uint jobNum);
01228 
01236         void textAppended(const QCString& appId, uint jobNum, int partNum);
01237 
01243         void textStarted(const QCString& appId, uint jobNum);
01253         void textFinished(const QCString& appId, uint jobNum);
01262         void textStopped(const QCString& appId, uint jobNum);
01268         void textPaused(const QCString& appId, uint jobNum);
01274         void textResumed(const QCString& appId, uint jobNum);
01281         void textRemoved(const QCString& appId, uint jobNum);
01283 };
01284 
01285 #endif // _KSPEECH_H_
KDE Home | KDE Accessibility Home | Description of Access Keys