<?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: KSpeechSink Interface Reference (interfaces)</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=".">interfaces</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>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> </div>
<div class="headertitle">
<div class="title">KSpeechSink Interface Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KSpeechSink" --><!-- doxytag: inherits="DCOPObject" -->
<p>KTTSD DCOP Signal Sink.
<a href="classKSpeechSink.html#details">More...</a></p>
<p><code>#include <<a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KSpeechSink:</div>
<div class="dyncontent">
<div class="center">
<img src="classKSpeechSink.png" usemap="#KSpeechSink_map" alt=""/>
<map id="KSpeechSink_map" name="KSpeechSink_map">
<area doxygen="dcop.tag:../../dcop/html/" href="../../dcop/html/classDCOPObject.html" alt="DCOPObject" shape="rect" coords="0,0,87,24"/>
</map>
</div></div>
<p><a href="interfaceKSpeechSink-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366">kttsdJobState</a> { <br/>
  <a class="el" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366a9493092b6bddb3cbcd1a51cd235858c0">jsQueued</a> = 0,
<a class="el" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366a030b35c6e703e52d422a30fde9c9adaf">jsSpeakable</a> = 1,
<a class="el" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366ab68f7fd7e7def669e18231cb8910ec79">jsSpeaking</a> = 2,
<a class="el" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366a20a490619ce6fad34b87aaae76055965">jsPaused</a> = 3,
<br/>
  <a class="el" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366a74204d8a6ef835d1ee019f825d957741">jsFinished</a> = 4
<br/>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aab">kttsdMarkupType</a> { <a class="el" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aaba50720098fd0d8e61d84145be7e03ef83">mtPlain</a> = 0,
<a class="el" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aaba47dff5293db342fd3bc17dfbc3e73c98">mtJsml</a> = 1,
<a class="el" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aaba0a0a3a9c69586e33dafe262cb28a3568">mtSmml</a> = 2,
<a class="el" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aaba9b316b29e2e0d7a75d0c44badb2e1229">mtSable</a> = 3
}</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>KTTSD DCOP Signal Sink. </p>
<dl class="since"><dt><b>Since:</b></dt><dd><a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/namespaceKDE.html">KDE</a> 3.4</dd></dl>
<p>This defines the interface to sink signals emitted by KTTSD, the <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/namespaceKDE.html">KDE</a> Text-to-speech Deamon. The DCOP IDL Compiler generates a skeleton file from this interface definition that will marshal the arguments for you.</p>
<h2><a class="anchor" id="Usage"></a>
Usage</h2>
<p>See the Signals section of <a class="el" href="kspeech_8h_source.html">kspeech.h</a> for instructions.</p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>The <a class="el" href="classKSpeechSink.html" title="KTTSD DCOP Signal Sink.">KSpeechSink</a> interface is still being developed and is likely to change in the future. </dd></dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00042">42</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="aa26fed0dee544866784041129a254366"></a><!-- doxytag: member="KSpeechSink::kttsdJobState" ref="aa26fed0dee544866784041129a254366" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKSpeechSink.html#aa26fed0dee544866784041129a254366">KSpeechSink::kttsdJobState</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Job states returned by method getTextJobState. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="aa26fed0dee544866784041129a254366a9493092b6bddb3cbcd1a51cd235858c0"></a><!-- doxytag: member="jsQueued" ref="aa26fed0dee544866784041129a254366a9493092b6bddb3cbcd1a51cd235858c0" args="" -->jsQueued</em> </td><td>
<p>Job has been queued but is not yet speakable. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa26fed0dee544866784041129a254366a030b35c6e703e52d422a30fde9c9adaf"></a><!-- doxytag: member="jsSpeakable" ref="aa26fed0dee544866784041129a254366a030b35c6e703e52d422a30fde9c9adaf" args="" -->jsSpeakable</em> </td><td>
<p>Job is speakable, but is not speaking. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa26fed0dee544866784041129a254366ab68f7fd7e7def669e18231cb8910ec79"></a><!-- doxytag: member="jsSpeaking" ref="aa26fed0dee544866784041129a254366ab68f7fd7e7def669e18231cb8910ec79" args="" -->jsSpeaking</em> </td><td>
<p>Job is currently speaking. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa26fed0dee544866784041129a254366a20a490619ce6fad34b87aaae76055965"></a><!-- doxytag: member="jsPaused" ref="aa26fed0dee544866784041129a254366a20a490619ce6fad34b87aaae76055965" args="" -->jsPaused</em> </td><td>
<p>Job has been paused. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa26fed0dee544866784041129a254366a74204d8a6ef835d1ee019f825d957741"></a><!-- doxytag: member="jsFinished" ref="aa26fed0dee544866784041129a254366a74204d8a6ef835d1ee019f825d957741" args="" -->jsFinished</em> </td><td>
<p>Job is finished and is deleteable. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00050">50</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0e2de6ccea714351bb2e96e7f0548aab"></a><!-- doxytag: member="KSpeechSink::kttsdMarkupType" ref="a0e2de6ccea714351bb2e96e7f0548aab" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKSpeechSink.html#a0e2de6ccea714351bb2e96e7f0548aab">KSpeechSink::kttsdMarkupType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Speech markup language types. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a0e2de6ccea714351bb2e96e7f0548aaba50720098fd0d8e61d84145be7e03ef83"></a><!-- doxytag: member="mtPlain" ref="a0e2de6ccea714351bb2e96e7f0548aaba50720098fd0d8e61d84145be7e03ef83" args="" -->mtPlain</em> </td><td>
<p>Plain text. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a0e2de6ccea714351bb2e96e7f0548aaba47dff5293db342fd3bc17dfbc3e73c98"></a><!-- doxytag: member="mtJsml" ref="a0e2de6ccea714351bb2e96e7f0548aaba47dff5293db342fd3bc17dfbc3e73c98" args="" -->mtJsml</em> </td><td>
<p>Java Speech Markup Language. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a0e2de6ccea714351bb2e96e7f0548aaba0a0a3a9c69586e33dafe262cb28a3568"></a><!-- doxytag: member="mtSmml" ref="a0e2de6ccea714351bb2e96e7f0548aaba0a0a3a9c69586e33dafe262cb28a3568" args="" -->mtSmml</em> </td><td>
<p>Speech Markup Meta-language </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a0e2de6ccea714351bb2e96e7f0548aaba9b316b29e2e0d7a75d0c44badb2e1229"></a><!-- doxytag: member="mtSable" ref="a0e2de6ccea714351bb2e96e7f0548aaba9b316b29e2e0d7a75d0c44badb2e1229" args="" -->mtSable</em> </td><td>
<p>Sable 2.0. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00063">63</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7d64f064e9e0ab0369f24b8d548c4651"></a><!-- doxytag: member="KSpeechSink::kttsdExiting" ref="a7d64f064e9e0ab0369f24b8d548c4651" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ASYNC KSpeechSink::kttsdExiting </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted just before KTTSD exits. </p>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00079">79</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<a class="anchor" id="afb07abb718b3df287555358b974e9397"></a><!-- doxytag: member="KSpeechSink::kttsdStarted" ref="afb07abb718b3df287555358b974e9397" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ASYNC KSpeechSink::kttsdStarted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted when KTTSD starts or restarts after a call to reinit. </p>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00075">75</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<a class="anchor" id="a17b16f9ef55d24a9ac86616d46300e3b"></a><!-- doxytag: member="KSpeechSink::markerSeen" ref="a17b16f9ef55d24a9ac86616d46300e3b" args="(const QCString &appId, const QString &markerName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ASYNC KSpeechSink::markerSeen </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> & </td>
<td class="paramname"><em>appId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>markerName</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted when the speech engine/plugin encounters a marker in the text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appId</td><td>DCOP application ID of the application that queued the text. </td></tr>
<tr><td class="paramname">markerName</td><td>The name of the marker seen. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd>markers </dd></dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00087">87</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<a class="anchor" id="a472c9db9aee8033c4fc86ab32d4f1073"></a><!-- doxytag: member="KSpeechSink::sentenceFinished" ref="a472c9db9aee8033c4fc86ab32d4f1073" args="(const QCString &appId, uint jobNum, uint seq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ASYNC KSpeechSink::sentenceFinished </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> & </td>
<td class="paramname"><em>appId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint </td>
<td class="paramname"><em>jobNum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint </td>
<td class="paramname"><em>seq</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted when a sentence has finished speaking. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appId</td><td>DCOP application ID of the application that queued the text. </td></tr>
<tr><td class="paramname">jobNum</td><td>Job number of the text job. </td></tr>
<tr><td class="paramname">seq</td><td>Sequence number of the text. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd>getTextCount </dd></dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00103">103</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab8ac055d0a44222ec036922f334b6f0e"></a><!-- doxytag: member="KSpeechSink::sentenceStarted" ref="ab8ac055d0a44222ec036922f334b6f0e" args="(const QCString &appId, uint jobNum, uint seq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ASYNC KSpeechSink::sentenceStarted </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> & </td>
<td class="paramname"><em>appId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint </td>
<td class="paramname"><em>jobNum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint </td>
<td class="paramname"><em>seq</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted whenever a sentence begins speaking. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appId</td><td>DCOP application ID of the application that queued the text. </td></tr>
<tr><td class="paramname">jobNum</td><td>Job number of the text job. </td></tr>
<tr><td class="paramname">seq</td><td>Sequence number of the text. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd>getTextCount </dd></dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00095">95</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<a class="anchor" id="a498d8559af1f8659f85d0f41bb43e33d"></a><!-- doxytag: member="KSpeechSink::textAppended" ref="a498d8559af1f8659f85d0f41bb43e33d" args="(const QCString &appId, uint jobNum, int partNum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ASYNC KSpeechSink::textAppended </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> & </td>
<td class="paramname"><em>appId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint </td>
<td class="paramname"><em>jobNum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>partNum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted whenever a new part is appended to a text job. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appId</td><td>The DCOP senderId of the application that created the job. </td></tr>
<tr><td class="paramname">jobNum</td><td>Job number of the text job. </td></tr>
<tr><td class="paramname">partNum</td><td>Part number of the new part. Parts are numbered starting at 1. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00119">119</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<a class="anchor" id="a608b0dee64cfe28155c94433ce65c51f"></a><!-- doxytag: member="KSpeechSink::textFinished" ref="a608b0dee64cfe28155c94433ce65c51f" args="(const QCString &appId, uint jobNum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ASYNC KSpeechSink::textFinished </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> & </td>
<td class="paramname"><em>appId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint </td>
<td class="paramname"><em>jobNum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted whenever a text job is finished. </p>
<p>The job has been marked for deletion from the queue and will be deleted when another job reaches the Finished state. (Only one job in the text queue may be in state Finished at one time.) If startText or resumeText is called before the job is deleted, it will remain in the queue for speaking. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appId</td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td class="paramname">jobNum</td><td>Job number of the text job. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00136">136</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<a class="anchor" id="aca585d406185833999c50197f824673e"></a><!-- doxytag: member="KSpeechSink::textPaused" ref="aca585d406185833999c50197f824673e" args="(const QCString &appId, uint jobNum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ASYNC KSpeechSink::textPaused </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> & </td>
<td class="paramname"><em>appId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint </td>
<td class="paramname"><em>jobNum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted whenever a speaking text job is paused. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appId</td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td class="paramname">jobNum</td><td>Job number of the text job. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00148">148</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<a class="anchor" id="affe60057e3b6f90172758fbba28e3c88"></a><!-- doxytag: member="KSpeechSink::textRemoved" ref="affe60057e3b6f90172758fbba28e3c88" args="(const QCString &appId, uint jobNum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ASYNC KSpeechSink::textRemoved </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> & </td>
<td class="paramname"><em>appId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint </td>
<td class="paramname"><em>jobNum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted whenever a text job is deleted from the queue. </p>
<p>The job is no longer in the queue when this signal is emitted. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appId</td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td class="paramname">jobNum</td><td>Job number of the text job. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00161">161</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<a class="anchor" id="a19fd3890bdee4b9afc57349ad1d28969"></a><!-- doxytag: member="KSpeechSink::textResumed" ref="a19fd3890bdee4b9afc57349ad1d28969" args="(const QCString &appId, uint jobNum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ASYNC KSpeechSink::textResumed </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> & </td>
<td class="paramname"><em>appId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint </td>
<td class="paramname"><em>jobNum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted when a text job, that was previously paused, resumes speaking. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appId</td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td class="paramname">jobNum</td><td>Job number of the text job. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00154">154</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8455db7cbb8040a5bd3de4a21b7389c1"></a><!-- doxytag: member="KSpeechSink::textSet" ref="a8455db7cbb8040a5bd3de4a21b7389c1" args="(const QCString &appId, uint jobNum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ASYNC KSpeechSink::textSet </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> & </td>
<td class="paramname"><em>appId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint </td>
<td class="paramname"><em>jobNum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted whenever a new text job is added to the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appId</td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td class="paramname">jobNum</td><td>Job number of the text job. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00110">110</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac318cffcad2b6870d295bc3b3a4fb241"></a><!-- doxytag: member="KSpeechSink::textStarted" ref="ac318cffcad2b6870d295bc3b3a4fb241" args="(const QCString &appId, uint jobNum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ASYNC KSpeechSink::textStarted </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> & </td>
<td class="paramname"><em>appId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint </td>
<td class="paramname"><em>jobNum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted whenever speaking of a text job begins. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appId</td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td class="paramname">jobNum</td><td>Job number of the text job. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00126">126</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac1737e3345ab95c6ff61ad63a9ab4a16"></a><!-- doxytag: member="KSpeechSink::textStopped" ref="ac1737e3345ab95c6ff61ad63a9ab4a16" args="(const QCString &appId, uint jobNum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ASYNC KSpeechSink::textStopped </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> & </td>
<td class="paramname"><em>appId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint </td>
<td class="paramname"><em>jobNum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This signal is emitted whenever a speaking text job stops speaking. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appId</td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td class="paramname">jobNum</td><td>Job number of the text job. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kspeechsink_8h_source.html#l00142">142</a> of file <a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a>.</p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="kspeechsink_8h_source.html">kspeechsink.h</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>interfaces</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</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="namespacemembers.html">Namespace Members</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="classExtTerminalInterface.html">extterminalinterface</option>, <option value="classKFileAudioPreview.html">kfileaudiopreview</option>, <option value="classKHE_1_1BytesEditInterface.html">khe::byteseditinterface</option>, <option value="classKHE_1_1CharColumnInterface.html">khe::charcolumninterface</option>, <option value="classKHE_1_1ClipboardInterface.html">khe::clipboardinterface</option>, <option value="classKHE_1_1ValueColumnInterface.html">khe::valuecolumninterface</option>, <option value="classKHE_1_1ZoomInterface.html">khe::zoominterface</option>, <option value="classKIMIface.html">kimiface</option>, <option value="classKIMProxy.html">kimproxy</option>, <option value="classKMediaPlayer_1_1Player.html">kmediaplayer::player</option>, <option value="classKMediaPlayer_1_1View.html">kmediaplayer::view</option>, <option value="classKRegExpEditorInterface.html">kregexpeditorinterface</option>, <option value="classKScriptClientInterface.html">kscriptclientinterface</option>, <option value="classKScriptInterface.html">kscriptinterface</option>, <option value="classKScriptManager.html">kscriptmanager</option>, <option value="classKSpeech.html">kspeech</option>, <option value="classKSpeechSink.html">kspeechsink</option>, <option value="classKTextEditor_1_1BlockSelectionDCOPInterface.html">ktexteditor::blockselectiondcopinterface</option>, <option value="classKTextEditor_1_1BlockSelectionInterface.html">ktexteditor::blockselectioninterface</option>, <option value="classKTextEditor_1_1ClipboardDCOPInterface.html">ktexteditor::clipboarddcopinterface</option>, <option value="classKTextEditor_1_1ClipboardInterface.html">ktexteditor::clipboardinterface</option>, <option value="classKTextEditor_1_1CodeCompletionInterface.html">ktexteditor::codecompletioninterface</option>, <option value="classKTextEditor_1_1CompletionEntry.html">ktexteditor::completionentry</option>, <option value="classKTextEditor_1_1ConfigInterface.html">ktexteditor::configinterface</option>, <option value="classKTextEditor_1_1ConfigInterfaceExtension.html">ktexteditor::configinterfaceextension</option>, <option value="classKTextEditor_1_1Cursor.html">ktexteditor::cursor</option>, <option value="classKTextEditor_1_1CursorInterface.html">ktexteditor::cursorinterface</option>, <option value="classKTextEditor_1_1Document.html">ktexteditor::document</option>, <option value="classKTextEditor_1_1DocumentInfoDCOPInterface.html">ktexteditor::documentinfodcopinterface</option>, <option value="classKTextEditor_1_1DocumentInfoInterface.html">ktexteditor::documentinfointerface</option>, <option value="classKTextEditor_1_1DynWordWrapInterface.html">ktexteditor::dynwordwrapinterface</option>, <option value="classKTextEditor_1_1EditDCOPInterface.html">ktexteditor::editdcopinterface</option>, <option value="classKTextEditor_1_1EditInterface.html">ktexteditor::editinterface</option>, <option value="classKTextEditor_1_1EditInterfaceExt.html">ktexteditor::editinterfaceext</option>, <option value="classKTextEditor_1_1Editor.html">ktexteditor::editor</option>, <option value="classKTextEditor_1_1EncodingDCOPInterface.html">ktexteditor::encodingdcopinterface</option>, <option value="classKTextEditor_1_1EncodingInterface.html">ktexteditor::encodinginterface</option>, <option value="classKTextEditor_1_1HighlightingInterface.html">ktexteditor::highlightinginterface</option>, <option value="classKTextEditor_1_1MarkInterface.html">ktexteditor::markinterface</option>, <option value="classKTextEditor_1_1MarkInterfaceExtension.html">ktexteditor::markinterfaceextension</option>, <option value="classKTextEditor_1_1Plugin.html">ktexteditor::plugin</option>, <option value="classKTextEditor_1_1PluginViewInterface.html">ktexteditor::pluginviewinterface</option>, <option value="classKTextEditor_1_1PopupMenuInterface.html">ktexteditor::popupmenuinterface</option>, <option value="classKTextEditor_1_1PrintDCOPInterface.html">ktexteditor::printdcopinterface</option>, <option value="classKTextEditor_1_1PrintInterface.html">ktexteditor::printinterface</option>, <option value="classKTextEditor_1_1SearchDCOPInterface.html">ktexteditor::searchdcopinterface</option>, <option value="classKTextEditor_1_1SearchInterface.html">ktexteditor::searchinterface</option>, <option value="classKTextEditor_1_1SelectionDCOPInterface.html">ktexteditor::selectiondcopinterface</option>, <option value="classKTextEditor_1_1SelectionExtDCOPInterface.html">ktexteditor::selectionextdcopinterface</option>, <option value="classKTextEditor_1_1SelectionInterface.html">ktexteditor::selectioninterface</option>, <option value="classKTextEditor_1_1SelectionInterfaceExt.html">ktexteditor::selectioninterfaceext</option>, <option value="classKTextEditor_1_1SessionConfigInterface.html">ktexteditor::sessionconfiginterface</option>, <option value="classKTextEditor_1_1TemplateInterface.html">ktexteditor::templateinterface</option>, <option value="classKTextEditor_1_1TextHintInterface.html">ktexteditor::texthintinterface</option>, <option value="classKTextEditor_1_1UndoDCOPInterface.html">ktexteditor::undodcopinterface</option>, <option value="classKTextEditor_1_1UndoInterface.html">ktexteditor::undointerface</option>, <option value="classKTextEditor_1_1VariableInterface.html">ktexteditor::variableinterface</option>, <option value="classKTextEditor_1_1View.html">ktexteditor::view</option>, <option value="classKTextEditor_1_1ViewCursorDCOPInterface.html">ktexteditor::viewcursordcopinterface</option>, <option value="classKTextEditor_1_1ViewCursorInterface.html">ktexteditor::viewcursorinterface</option>, <option value="classKTextEditor_1_1ViewStatusMsgDCOPInterface.html">ktexteditor::viewstatusmsgdcopinterface</option>, <option value="classKTextEditor_1_1ViewStatusMsgInterface.html">ktexteditor::viewstatusmsginterface</option>, <option value="classKTextEditor_1_1WordWrapInterface.html">ktexteditor::wordwrapinterface</option>, <option value="classScriptLoader.html">scriptloader</option>, <option value="classTerminalInterface.html">terminalinterface</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>
