Sophie

Sophie

distrib > PLD > ac > amd64 > media > dist > by-pkgid > 90467ea6a387df728f7218a11e972208 > files > 814

kdelibs-apidocs-3.5.6-3.amd64.rpm

<?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/kimproxy/interface: kimiface.h Source File (interfaces/kimproxy/interface)</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="../../html/index.html">kimproxy</a> / <a href=".">interface</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.4.4 -->
<div class="nav">
<a class="el" href="dir_000000.html">interfaces</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000001.html">kimproxy</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000002.html">interface</a></div>
<h1>kimiface.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    kimiface.h - KDE Instant Messenger DCOP Interface</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">    Copyright (c) 2004-5 Will Stephenson   &lt;lists@stevello.free-online.co.uk&gt;</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00008"></a>00008 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00009"></a>00009 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00014"></a>00014 <span class="comment">    Library General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">    You should have received a copy of the GNU Library General Public License</span>
<a name="l00017"></a>00017 <span class="comment">    along with this library; see the file COPYING.LIB.  If not, write to</span>
<a name="l00018"></a>00018 <span class="comment">    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,</span>
<a name="l00019"></a>00019 <span class="comment">    Boston, MA 02110-1301, USA.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef KIMIFACE_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define KIMIFACE_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;qpixmap.h&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;dcopobject.h&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;qstringlist.h&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;kurl.h&gt;</span>
<a name="l00029"></a>00029 
<a name="l00085"></a><a class="code" href="classKIMIface.html">00085</a> <span class="keyword">class </span><a class="code" href="classKIMIface.html">KIMIface</a> : <span class="keyword">virtual</span> <span class="keyword">public</span> DCOPObject
<a name="l00086"></a>00086 {
<a name="l00087"></a>00087     K_DCOP
<a name="l00088"></a>00088 
<a name="l00089"></a>00089 k_dcop:
<a name="l00090"></a>00090 <span class="comment">// ACCESSORS</span>
<a name="l00091"></a>00091 <span class="comment">// contact list</span>
<a name="l00105"></a>00105 <span class="comment"></span>    <span class="keyword">virtual</span> <a class="codeRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> <a class="code" href="classKIMIface.html#z0">allContacts</a>() = 0;
<a name="l00106"></a>00106 
<a name="l00125"></a>00125     <span class="keyword">virtual</span> <a class="codeRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> <a class="code" href="classKIMIface.html#z1">reachableContacts</a>() = 0;
<a name="l00126"></a>00126 
<a name="l00143"></a>00143     <span class="keyword">virtual</span> <a class="codeRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> <a class="code" href="classKIMIface.html#z2">onlineContacts</a>() = 0;
<a name="l00144"></a>00144 
<a name="l00168"></a>00168     <span class="keyword">virtual</span> <a class="codeRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> <a class="code" href="classKIMIface.html#z3">fileTransferContacts</a>() = 0;
<a name="l00169"></a>00169 
<a name="l00170"></a>00170 <span class="comment">// individual</span>
<a name="l00185"></a>00185 <span class="comment"></span>    <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKIMIface.html#z4">isPresent</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp; uid ) = 0;
<a name="l00186"></a>00186 
<a name="l00203"></a>00203     <span class="keyword">virtual</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> <a class="code" href="classKIMIface.html#z5">displayName</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp; uid ) = 0;
<a name="l00204"></a>00204 
<a name="l00220"></a>00220     <span class="keyword">virtual</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> <a class="code" href="classKIMIface.html#z6">presenceString</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp; uid ) = 0;
<a name="l00221"></a>00221 
<a name="l00250"></a>00250     <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classKIMIface.html#z7">presenceStatus</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp; uid ) = 0;
<a name="l00251"></a>00251 
<a name="l00261"></a>00261     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKIMIface.html#z8">canReceiveFiles</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp; uid ) = 0;
<a name="l00262"></a>00262 
<a name="l00279"></a>00279     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKIMIface.html#z9">canRespond</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp; uid ) = 0;
<a name="l00280"></a>00280 
<a name="l00296"></a>00296     <span class="keyword">virtual</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> <a class="code" href="classKIMIface.html#z10">locate</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp; contactId, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp; protocol ) = 0;
<a name="l00297"></a>00297 
<a name="l00298"></a>00298 <span class="comment">// metadata</span>
<a name="l00315"></a>00315 <span class="comment"></span>    <span class="keyword">virtual</span> <a class="codeRef" doxygen="qt.tag:" href="qpixmap.html">QPixmap</a> <a class="code" href="classKIMIface.html#z11">icon</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp; uid ) = 0;
<a name="l00316"></a>00316 
<a name="l00330"></a>00330     <span class="keyword">virtual</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> <a class="code" href="classKIMIface.html#z12">context</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp; uid ) = 0;
<a name="l00331"></a>00331 
<a name="l00332"></a>00332 <span class="comment">// App capabilities</span>
<a name="l00352"></a>00352 <span class="comment"></span>    <span class="keyword">virtual</span> <a class="codeRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> <a class="code" href="classKIMIface.html#z13">protocols</a>() = 0;
<a name="l00353"></a>00353 
<a name="l00354"></a>00354 <span class="comment">// ACTORS</span>
<a name="l00377"></a>00377 <span class="comment"></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKIMIface.html#z14">messageContact</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;uid, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a>&amp; message ) = 0;
<a name="l00378"></a>00378 
<a name="l00397"></a>00397     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKIMIface.html#z15">messageNewContact</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;contactId, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;protocol ) = 0;
<a name="l00398"></a>00398 
<a name="l00415"></a>00415     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKIMIface.html#z16">chatWithContact</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;uid ) = 0;
<a name="l00416"></a>00416 
<a name="l00441"></a>00441     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKIMIface.html#z17">sendFile</a>(<span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;uid, <span class="keyword">const</span> KURL &amp;sourceURL,
<a name="l00442"></a>00442         <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;altFileName = QString::null, uint fileSize = 0) = 0;
<a name="l00443"></a>00443 
<a name="l00444"></a>00444 <span class="comment">// MUTATORS</span>
<a name="l00445"></a>00445 <span class="comment">// Contact list</span>
<a name="l00463"></a>00463 <span class="comment"></span>    <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKIMIface.html#z18">addContact</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;contactId, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> &amp;protocol ) = 0;
<a name="l00464"></a>00464 
<a name="l00465"></a>00465 <span class="comment">// SIGNALS</span>
<a name="l00466"></a>00466 k_dcop_signals:
<a name="l00485"></a><a class="code" href="classKIMIface.html#o2">00485</a>     <span class="keywordtype">void</span> contactPresenceChanged( <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> uid, <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> <a class="code" href="classKIMIface.html#o1">appId</a>, <span class="keywordtype">int</span> <a class="code" href="classKIMIface.html#o2">presence</a> );
<a name="l00486"></a>00486 };
<a name="l00487"></a>00487 
<a name="l00488"></a>00488 <span class="preprocessor">#endif</span>
<a name="l00489"></a>00489 <span class="preprocessor"></span>
<a name="l00490"></a>00490 
<a name="l00491"></a>00491 
<a name="l00492"></a>00492 <span class="comment">/*</span>
<a name="l00493"></a>00493 <span class="comment"> * Local variables:</span>
<a name="l00494"></a>00494 <span class="comment"> * c-indentation-style: k&amp;r</span>
<a name="l00495"></a>00495 <span class="comment"> * c-basic-offset: 8</span>
<a name="l00496"></a>00496 <span class="comment"> * indent-tabs-mode: t</span>
<a name="l00497"></a>00497 <span class="comment"> * End:</span>
<a name="l00498"></a>00498 <span class="comment"> */</span>
<a name="l00499"></a>00499 <span class="comment">// vim: set noet ts=4 sts=4 sw=4:</span>
<a name="l00500"></a>00500 
</pre></div>    </div></div>


      </td>
  </tr>
  <tr>
    <td valign="top" id="leftmenu" width="25%">
      <a name="navigation"></a>
      <div class="menu_box"><h2>interfaces/kimproxy/interface</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="dirs.html">Directories</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="classKIMIface.html">kimiface</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>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../../interfaces/kimproxy/library/html/index.html">library</a></li><li>&nbsp;&nbsp;<a href="../../../../interfaces/kspeech/html/index.html">kspeech</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<a href="../../../../kio/bookmarks/html/index.html">bookmarks</a></li><li>&nbsp;&nbsp;<a href="../../../../kio/httpfilter/html/index.html">httpfilter</a></li><li>&nbsp;&nbsp;<a href="../../../../kio/kfile/html/index.html">kfile</a></li><li>&nbsp;&nbsp;<a href="../../../../kio/kio/html/index.html">kio</a></li><li>&nbsp;&nbsp;<a href="../../../../kio/kioexec/html/index.html">kioexec</a></li><li>&nbsp;&nbsp;<a href="../../../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li>&nbsp;&nbsp;<a href="../../../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../../../kioslave/html/index.html">kioslave</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<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="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">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>