• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • interfaces/kspeech
 

interfaces/kspeech

  • interfaces
  • kspeech
kspeech.h
1 /***************************************************** vim:set ts=4 sw=4 sts=4:
2  kspeech.h
3  KTTSD DCOP Interface
4  --------------------
5  Copyright:
6  (C) 2002-2003 by José Pablo Ezequiel "Pupeno" Fernández <pupeno@kde.org>
7  (C) 2003-2004 by Olaf Schmidt <ojschmidt@kde.org>
8  (C) 2004-2005 by Gary Cramblitt <garycramblitt@comcast.net>
9  -------------------
10  Original author: José Pablo Ezequiel "Pupeno" Fernández
11  ******************************************************************************/
12 
13 /***************************************************************************
14  * *
15  * This program is free software; you can redistribute it and/or modify *
16  * it under the terms of the GNU General Public License as published by *
17  * the Free Software Foundation; version 2 of the License. *
18  * *
19  ***************************************************************************/
20 
21 #ifndef _KSPEECH_H_
22 #define _KSPEECH_H_
23 
24 #include <dcopobject.h>
25 #include <tqstringlist.h>
26 
644 // NOTE: kspeech class is now obsolete. Please use KSpeech instead.
645 
646 class KSpeech : virtual public DCOPObject {
647  K_DCOP
648 
649  public:
654  enum kttsdJobState
655  {
656  jsQueued = 0,
657  jsSpeakable = 1,
658  jsSpeaking = 2,
659  jsPaused = 3,
660  jsFinished = 4
661  };
662 
667  enum kttsdMarkupType
668  {
669  mtPlain = 0,
670  mtJsml = 1,
671  mtSsml = 2,
672  mtSable = 3,
673  mtHtml = 4
674  };
675 
676  k_dcop:
679 
689  virtual bool supportsMarkup(const TQString &talker, uint markupType = 0) const = 0;
690 
698  virtual bool supportsMarkers(const TQString &talker) const = 0;
699 
713  virtual ASYNC sayScreenReaderOutput(const TQString &msg, const TQString &talker) = 0;
714 
726  virtual ASYNC sayWarning(const TQString &warning, const TQString &talker) = 0;
727 
739  virtual ASYNC sayMessage(const TQString &message, const TQString &talker) = 0;
740 
767  virtual ASYNC setSentenceDelimiter(const TQString &delimiter) = 0;
768 
793  virtual uint setText(const TQString &text, const TQString &talker) = 0;
794 
823  virtual uint sayText(const TQString &text, const TQString &talker) = 0;
824 
840  virtual int appendText(const TQString &text, uint jobNum=0) = 0;
841 
867  virtual uint setFile(const TQString &filename, const TQString &talker,
868  const TQString& encoding) = 0;
869 
881  virtual int getTextCount(uint jobNum=0) = 0;
882 
892  virtual uint getCurrentTextJob() = 0;
893 
898  virtual uint getTextJobCount() = 0;
899 
904  virtual TQString getTextJobNumbers() = 0;
905 
915  virtual int getTextJobState(uint jobNum=0) = 0;
916 
957  virtual TQByteArray getTextJobInfo(uint jobNum=0) = 0;
958 
965  virtual TQString talkerCodeToTalkerId(const TQString& talkerCode) = 0;
966 
976  virtual TQString getTextJobSentence(uint jobNum=0, uint seq=0) = 0;
977 
982  virtual bool isSpeakingText() const = 0;
983 
995  virtual ASYNC removeText(uint jobNum=0) = 0;
996 
1014  virtual ASYNC startText(uint jobNum=0) = 0;
1015 
1034  virtual ASYNC stopText(uint jobNum=0) = 0;
1035 
1056  virtual ASYNC pauseText(uint jobNum=0) = 0;
1057 
1080  virtual ASYNC resumeText(uint jobNum=0) = 0;
1081 
1089  virtual TQStringList getTalkers() = 0;
1090 
1101  virtual ASYNC changeTextTalker(const TQString &talker, uint jobNum=0 ) = 0;
1102 
1110  virtual TQString userDefaultTalker() = 0;
1111 
1121  virtual ASYNC moveTextLater(uint jobNum=0) = 0;
1122 
1136  virtual int jumpToTextPart(int partNum, uint jobNum=0) = 0;
1137 
1151  virtual uint moveRelTextSentence(int n, uint jobNum=0) = 0;
1152 
1156  virtual ASYNC speakClipboard() = 0;
1157 
1163  virtual void showDialog() = 0;
1164 
1168  virtual void kttsdExit() = 0;
1169 
1173  virtual void reinit() = 0;
1174 
1179  virtual TQString version() = 0;
1181 
1182  k_dcop_signals:
1183  void ignoreThis();
1184 
1187 
1191  void kttsdStarted();
1195  void kttsdExiting();
1203  void markerSeen(const TQCString& appId, const TQString& markerName);
1212  void sentenceStarted(const TQCString& appId, uint jobNum, uint seq);
1221  void sentenceFinished(const TQCString& appId, uint jobNum, uint seq);
1222 
1228  void textSet(const TQCString& appId, uint jobNum);
1229 
1237  void textAppended(const TQCString& appId, uint jobNum, int partNum);
1238 
1244  void textStarted(const TQCString& appId, uint jobNum);
1254  void textFinished(const TQCString& appId, uint jobNum);
1263  void textStopped(const TQCString& appId, uint jobNum);
1269  void textPaused(const TQCString& appId, uint jobNum);
1275  void textResumed(const TQCString& appId, uint jobNum);
1282  void textRemoved(const TQCString& appId, uint jobNum);
1284 };
1285 
1286 #endif // _KSPEECH_H_

interfaces/kspeech

Skip menu "interfaces/kspeech"
  • Main Page
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members

interfaces/kspeech

Skip menu "interfaces/kspeech"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for interfaces/kspeech by doxygen 1.8.3.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |