kspeech.h

/*
  kspeech.h
  KTTSD DCOP Interface
  --------------------
  Copyright:
  (C) 2002-2003 by José Pablo Ezequiel "Pupeno" Fernández <pupeno@kde.org>
  (C) 2003-2004 by Olaf Schmidt <ojschmidt@kde.org>
  (C) 2004-2005 by Gary Cramblitt <garycramblitt@comcast.net>
  -------------------
  Original author: José Pablo Ezequiel "Pupeno" Fernández
 ******************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; version 2 of the License.               *
 *                                                                         *
 ***************************************************************************/
 
#ifndef _KSPEECH_H_
#define _KSPEECH_H_
 
#include <dcopobject.h>
#include <tqstringlist.h>
 
// NOTE: kspeech class is now obsolete.  Please use KSpeech instead.
 
class KSpeech : virtual public DCOPObject {
    K_DCOP
 
    public:
        enum kttsdJobState
        {
            jsQueued = 0,                
            jsSpeakable = 1,             
            jsSpeaking = 2,              
            jsPaused = 3,                
            jsFinished = 4               
        };
 
        enum kttsdMarkupType
        {
            mtPlain = 0,                 
            mtJsml = 1,                  
            mtSsml = 2,                  
            mtSable = 3,                 
            mtHtml = 4                   
        };
 
    k_dcop:
 
        virtual bool supportsMarkup(const TQString &talker, uint markupType = 0) const = 0;
 
        virtual bool supportsMarkers(const TQString &talker) const = 0;
 
        virtual ASYNC sayScreenReaderOutput(const TQString &msg, const TQString &talker) = 0;
 
        virtual ASYNC sayWarning(const TQString &warning, const TQString &talker) = 0;
 
        virtual ASYNC sayMessage(const TQString &message, const TQString &talker) = 0;
 
        virtual ASYNC setSentenceDelimiter(const TQString &delimiter) = 0;
 
        virtual uint setText(const TQString &text, const TQString &talker) = 0;
 
        virtual uint sayText(const TQString &text, const TQString &talker) = 0;
 
        virtual int appendText(const TQString &text, uint jobNum=0) = 0;
 
        virtual uint setFile(const TQString &filename, const TQString &talker,
            const TQString& encoding) = 0;
 
        virtual int getTextCount(uint jobNum=0) = 0;
 
        virtual uint getCurrentTextJob() = 0;
 
        virtual uint getTextJobCount() = 0;
 
        virtual TQString getTextJobNumbers() = 0;
 
        virtual int getTextJobState(uint jobNum=0) = 0;
 
        virtual TQByteArray getTextJobInfo(uint jobNum=0) = 0;
 
        virtual TQString talkerCodeToTalkerId(const TQString& talkerCode) = 0;
 
        virtual TQString getTextJobSentence(uint jobNum=0, uint seq=0) = 0;
 
        virtual bool isSpeakingText() const = 0;
 
        virtual ASYNC removeText(uint jobNum=0) = 0;
 
        virtual ASYNC startText(uint jobNum=0) = 0;
 
        virtual ASYNC stopText(uint jobNum=0) = 0;
 
        virtual ASYNC pauseText(uint jobNum=0) = 0;
 
        virtual ASYNC resumeText(uint jobNum=0) = 0;
 
        virtual TQStringList getTalkers() = 0;
 
        virtual ASYNC changeTextTalker(const TQString &talker, uint jobNum=0 ) = 0;
 
        virtual TQString userDefaultTalker() = 0;
 
        virtual ASYNC moveTextLater(uint jobNum=0) = 0;
 
        virtual int jumpToTextPart(int partNum, uint jobNum=0) = 0;
 
        virtual uint moveRelTextSentence(int n, uint jobNum=0) = 0;
 
        virtual ASYNC speakClipboard() = 0;
 
        virtual void showDialog() = 0;
 
        virtual void kttsdExit() = 0;
 
        virtual void reinit() = 0;
 
        virtual TQString version() = 0;
 
    k_dcop_signals:
        void ignoreThis();
 
 
        void kttsdStarted();
        void kttsdExiting();
        void markerSeen(const TQCString& appId, const TQString& markerName);
        void sentenceStarted(const TQCString& appId, uint jobNum, uint seq);
        void sentenceFinished(const TQCString& appId, uint jobNum, uint seq);
 
        void textSet(const TQCString& appId, uint jobNum);
 
        void textAppended(const TQCString& appId, uint jobNum, int partNum);
 
        void textStarted(const TQCString& appId, uint jobNum);
        void textFinished(const TQCString& appId, uint jobNum);
        void textStopped(const TQCString& appId, uint jobNum);
        void textPaused(const TQCString& appId, uint jobNum);
        void textResumed(const TQCString& appId, uint jobNum);
        void textRemoved(const TQCString& appId, uint jobNum);
};
 
#endif // _KSPEECH_H_