<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>interfaces/kspeech: kspeechsink.h Source File (interfaces/kspeech)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../../.."><img id="nav_header_logo" alt="Home" align="left" src="../../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../../..">API Reference</a>
/ <a href="../../html/index.html">interfaces</a> / <a href=".">kspeech</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
<div class="header">
<div class="headertitle">
<div class="title">kspeechsink.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***************************************************** vim:set ts=4 sw=4 sts=4:</span>
<a name="l00002"></a>00002 <span class="comment"> kspeechsink.h</span>
<a name="l00003"></a>00003 <span class="comment"> KTTSD DCOP Signal Sink Interface</span>
<a name="l00004"></a>00004 <span class="comment"> --------------------------------</span>
<a name="l00005"></a>00005 <span class="comment"> Copyright:</span>
<a name="l00006"></a>00006 <span class="comment"> (C) 2004 by Gary Cramblitt <garycramblitt@comcast.net></span>
<a name="l00007"></a>00007 <span class="comment"> -------------------</span>
<a name="l00008"></a>00008 <span class="comment"> Original author: Gary Cramblitt <garycramblitt@comcast.net></span>
<a name="l00009"></a>00009 <span class="comment"> ******************************************************************************/</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="comment">/***************************************************************************</span>
<a name="l00012"></a>00012 <span class="comment"> * *</span>
<a name="l00013"></a>00013 <span class="comment"> * This program is free software; you can redistribute it and/or modify *</span>
<a name="l00014"></a>00014 <span class="comment"> * it under the terms of the GNU General Public License as published by *</span>
<a name="l00015"></a>00015 <span class="comment"> * the Free Software Foundation; version 2 of the License. *</span>
<a name="l00016"></a>00016 <span class="comment"> * *</span>
<a name="l00017"></a>00017 <span class="comment"> ***************************************************************************/</span>
<a name="l00018"></a>00018
<a name="l00037"></a>00037 <span class="preprocessor">#ifndef _KSPEECHSINK_H_</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _KSPEECHSINK_H_</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <dcopobject.h></span>
<a name="l00041"></a>00041
<a name="l00042"></a><a class="code" href="classKSpeechSink.html">00042</a> <span class="keyword">class </span><a class="code" href="classKSpeechSink.html" title="KTTSD DCOP Signal Sink.">KSpeechSink</a> : <span class="keyword">virtual</span> <span class="keyword">public</span> <a class="codeRef" doxygen="dcop.tag:../../../dcop/html/" href="../../../dcop/html/classDCOPObject.html">DCOPObject</a> {
<a name="l00043"></a>00043 K_DCOP
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="keyword">public</span>:
<a name="l00050"></a><a class="code" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366">00050</a> <span class="keyword">enum</span> <a class="code" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366" title="Job states returned by method getTextJobState.">kttsdJobState</a>
<a name="l00051"></a>00051 {
<a name="l00052"></a><a class="code" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366a9493092b6bddb3cbcd1a51cd235858c0">00052</a> <a class="code" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366a9493092b6bddb3cbcd1a51cd235858c0" title="Job has been queued but is not yet speakable.">jsQueued</a> = 0,
<a name="l00053"></a><a class="code" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366a030b35c6e703e52d422a30fde9c9adaf">00053</a> <a class="code" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366a030b35c6e703e52d422a30fde9c9adaf" title="Job is speakable, but is not speaking.">jsSpeakable</a> = 1,
<a name="l00054"></a><a class="code" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366ab68f7fd7e7def669e18231cb8910ec79">00054</a> <a class="code" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366ab68f7fd7e7def669e18231cb8910ec79" title="Job is currently speaking.">jsSpeaking</a> = 2,
<a name="l00055"></a><a class="code" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366a20a490619ce6fad34b87aaae76055965">00055</a> <a class="code" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366a20a490619ce6fad34b87aaae76055965" title="Job has been paused.">jsPaused</a> = 3,
<a name="l00056"></a><a class="code" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366a74204d8a6ef835d1ee019f825d957741">00056</a> <a class="code" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366a74204d8a6ef835d1ee019f825d957741" title="Job is finished and is deleteable.">jsFinished</a> = 4
<a name="l00057"></a>00057 };
<a name="l00058"></a>00058
<a name="l00063"></a><a class="code" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aab">00063</a> <span class="keyword">enum</span> <a class="code" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aab" title="Speech markup language types.">kttsdMarkupType</a>
<a name="l00064"></a>00064 {
<a name="l00065"></a><a class="code" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aaba50720098fd0d8e61d84145be7e03ef83">00065</a> <a class="code" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aaba50720098fd0d8e61d84145be7e03ef83" title="Plain text.">mtPlain</a> = 0,
<a name="l00066"></a><a class="code" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aaba47dff5293db342fd3bc17dfbc3e73c98">00066</a> <a class="code" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aaba47dff5293db342fd3bc17dfbc3e73c98" title="Java Speech Markup Language.">mtJsml</a> = 1,
<a name="l00067"></a><a class="code" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aaba0a0a3a9c69586e33dafe262cb28a3568">00067</a> <a class="code" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aaba0a0a3a9c69586e33dafe262cb28a3568" title="Speech Markup Meta-language">mtSmml</a> = 2,
<a name="l00068"></a><a class="code" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aaba9b316b29e2e0d7a75d0c44badb2e1229">00068</a> <a class="code" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aaba9b316b29e2e0d7a75d0c44badb2e1229" title="Sable 2.0.">mtSable</a> = 3
<a name="l00069"></a>00069 };
<a name="l00070"></a>00070
<a name="l00071"></a>00071 k_dcop:
<a name="l00075"></a><a class="code" href="classKSpeechSink.html#afb07abb718b3df287555358b974e9397">00075</a> <span class="keyword">virtual</span> ASYNC <a class="code" href="classKSpeechSink.html#afb07abb718b3df287555358b974e9397" title="This signal is emitted when KTTSD starts or restarts after a call to reinit.">kttsdStarted</a>() { };
<a name="l00079"></a><a class="code" href="classKSpeechSink.html#a7d64f064e9e0ab0369f24b8d548c4651">00079</a> <span class="keyword">virtual</span> ASYNC <a class="code" href="classKSpeechSink.html#a7d64f064e9e0ab0369f24b8d548c4651" title="This signal is emitted just before KTTSD exits.">kttsdExiting</a>() { };
<a name="l00080"></a>00080
<a name="l00087"></a><a class="code" href="classKSpeechSink.html#a17b16f9ef55d24a9ac86616d46300e3b">00087</a> <span class="keyword">virtual</span> ASYNC <a class="code" href="classKSpeechSink.html#a17b16f9ef55d24a9ac86616d46300e3b" title="This signal is emitted when the speech engine/plugin encounters a marker in the text.">markerSeen</a>(<span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& appId, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& markerName) { Q_UNUSED(appId); Q_UNUSED(markerName); };
<a name="l00095"></a><a class="code" href="classKSpeechSink.html#ab8ac055d0a44222ec036922f334b6f0e">00095</a> <span class="keyword">virtual</span> ASYNC <a class="code" href="classKSpeechSink.html#ab8ac055d0a44222ec036922f334b6f0e" title="This signal is emitted whenever a sentence begins speaking.">sentenceStarted</a>(<span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& appId, uint jobNum, uint seq) { Q_UNUSED(appId); Q_UNUSED(jobNum); Q_UNUSED(seq); };
<a name="l00103"></a><a class="code" href="classKSpeechSink.html#a472c9db9aee8033c4fc86ab32d4f1073">00103</a> <span class="keyword">virtual</span> ASYNC <a class="code" href="classKSpeechSink.html#a472c9db9aee8033c4fc86ab32d4f1073" title="This signal is emitted when a sentence has finished speaking.">sentenceFinished</a>(<span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& appId, uint jobNum, uint seq) { Q_UNUSED(appId); Q_UNUSED(jobNum); Q_UNUSED(seq); };
<a name="l00104"></a>00104
<a name="l00110"></a><a class="code" href="classKSpeechSink.html#a8455db7cbb8040a5bd3de4a21b7389c1">00110</a> <span class="keyword">virtual</span> ASYNC <a class="code" href="classKSpeechSink.html#a8455db7cbb8040a5bd3de4a21b7389c1" title="This signal is emitted whenever a new text job is added to the queue.">textSet</a>(<span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& appId, uint jobNum) { Q_UNUSED(appId); Q_UNUSED(jobNum); };
<a name="l00111"></a>00111
<a name="l00119"></a><a class="code" href="classKSpeechSink.html#a498d8559af1f8659f85d0f41bb43e33d">00119</a> <span class="keyword">virtual</span> ASYNC <a class="code" href="classKSpeechSink.html#a498d8559af1f8659f85d0f41bb43e33d" title="This signal is emitted whenever a new part is appended to a text job.">textAppended</a>(<span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& appId, uint jobNum, <span class="keywordtype">int</span> partNum) { Q_UNUSED(appId); Q_UNUSED(jobNum); Q_UNUSED(partNum); };
<a name="l00120"></a>00120
<a name="l00126"></a><a class="code" href="classKSpeechSink.html#ac318cffcad2b6870d295bc3b3a4fb241">00126</a> <span class="keyword">virtual</span> ASYNC <a class="code" href="classKSpeechSink.html#ac318cffcad2b6870d295bc3b3a4fb241" title="This signal is emitted whenever speaking of a text job begins.">textStarted</a>(<span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& appId, uint jobNum) { Q_UNUSED(appId); Q_UNUSED(jobNum); };
<a name="l00136"></a><a class="code" href="classKSpeechSink.html#a608b0dee64cfe28155c94433ce65c51f">00136</a> <span class="keyword">virtual</span> ASYNC <a class="code" href="classKSpeechSink.html#a608b0dee64cfe28155c94433ce65c51f" title="This signal is emitted whenever a text job is finished.">textFinished</a>(<span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& appId, uint jobNum) { Q_UNUSED(appId); Q_UNUSED(jobNum); };
<a name="l00142"></a><a class="code" href="classKSpeechSink.html#ac1737e3345ab95c6ff61ad63a9ab4a16">00142</a> <span class="keyword">virtual</span> ASYNC <a class="code" href="classKSpeechSink.html#ac1737e3345ab95c6ff61ad63a9ab4a16" title="This signal is emitted whenever a speaking text job stops speaking.">textStopped</a>(<span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& appId, uint jobNum) { Q_UNUSED(appId); Q_UNUSED(jobNum); };
<a name="l00148"></a><a class="code" href="classKSpeechSink.html#aca585d406185833999c50197f824673e">00148</a> <span class="keyword">virtual</span> ASYNC <a class="code" href="classKSpeechSink.html#aca585d406185833999c50197f824673e" title="This signal is emitted whenever a speaking text job is paused.">textPaused</a>(<span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& appId, uint jobNum) { Q_UNUSED(appId); Q_UNUSED(jobNum); };
<a name="l00154"></a><a class="code" href="classKSpeechSink.html#a19fd3890bdee4b9afc57349ad1d28969">00154</a> <span class="keyword">virtual</span> ASYNC <a class="code" href="classKSpeechSink.html#a19fd3890bdee4b9afc57349ad1d28969" title="This signal is emitted when a text job, that was previously paused, resumes speaking.">textResumed</a>(<span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& appId, uint jobNum) { Q_UNUSED(appId); Q_UNUSED(jobNum); };
<a name="l00161"></a><a class="code" href="classKSpeechSink.html#affe60057e3b6f90172758fbba28e3c88">00161</a> <span class="keyword">virtual</span> ASYNC <a class="code" href="classKSpeechSink.html#affe60057e3b6f90172758fbba28e3c88" title="This signal is emitted whenever a text job is deleted from the queue.">textRemoved</a>(<span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& appId, uint jobNum) { Q_UNUSED(appId); Q_UNUSED(jobNum); };
<a name="l00162"></a>00162 };
<a name="l00163"></a>00163
<a name="l00164"></a>00164 <span class="preprocessor">#endif // _KSPEECHSINK_H_</span>
</pre></div></div>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>interfaces/kspeech</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKSpeech.html">kspeech</option>, <option value="classKSpeechSink.html">kspeechsink</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../../arts/html/index.html">arts</a></li><li><a href="../../../dcop/html/index.html">dcop</a></li><li><a href="../../../dnssd/html/index.html">dnssd</a></li><li><a href="../../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../../kabc/html/index.html">kabc</a></li><li><a href="../../../kate/html/index.html">kate</a></li><li><a href="../../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../../kdecore/html/index.html">kdecore</a></li><li><a href="../../../kded/html/index.html">kded</a></li><li><a href="../../../kdefx/html/index.html">kdefx</a></li><li><a href="../../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../../kdesu/html/index.html">kdesu</a></li><li><a href="../../../kdeui/html/index.html">kdeui</a></li><li><a href="../../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../../khtml/html/index.html">khtml</a></li><li><a href="../../../kimgio/html/index.html">kimgio</a></li><li><a href="../../../kinit/html/index.html">kinit</a></li><li><a href="../../../kio/html/index.html">kio</a></li><li> <a href="../../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../../kio/kio/html/index.html">kio</a></li><li> <a href="../../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../../kioslave/http/html/index.html">http</a></li><li><a href="../../../kjs/html/index.html">kjs</a></li><li><a href="../../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../../kparts/html/index.html">kparts</a></li><li><a href="../../../kresources/html/index.html">kresources</a></li><li><a href="../../../kspell2/html/index.html">kspell2</a></li><li><a href="../../../kunittest/html/index.html">kunittest</a></li><li><a href="../../../kutils/html/index.html">kutils</a></li><li><a href="../../../kwallet/html/index.html">kwallet</a></li><li><a href="../../../libkmid/html/index.html">libkmid</a></li><li><a href="../../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
