<?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>dcop: dcopsignals.h Source File (dcop)</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=".">dcop</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.7 --> <h1>dcopsignals.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">Copyright (c) 2000 Waldo Bastian <bastian@kde.org></span> <a name="l00003"></a>00003 <span class="comment"></span> <a name="l00004"></a>00004 <span class="comment">Permission is hereby granted, free of charge, to any person obtaining a copy</span> <a name="l00005"></a>00005 <span class="comment">of this software and associated documentation files (the "Software"), to deal</span> <a name="l00006"></a>00006 <span class="comment">in the Software without restriction, including without limitation the rights</span> <a name="l00007"></a>00007 <span class="comment">to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span> <a name="l00008"></a>00008 <span class="comment">copies of the Software, and to permit persons to whom the Software is</span> <a name="l00009"></a>00009 <span class="comment">furnished to do so, subject to the following conditions:</span> <a name="l00010"></a>00010 <span class="comment"></span> <a name="l00011"></a>00011 <span class="comment">The above copyright notice and this permission notice shall be included in</span> <a name="l00012"></a>00012 <span class="comment">all copies or substantial portions of the Software.</span> <a name="l00013"></a>00013 <span class="comment"></span> <a name="l00014"></a>00014 <span class="comment">THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span> <a name="l00015"></a>00015 <span class="comment">IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span> <a name="l00016"></a>00016 <span class="comment">FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span> <a name="l00017"></a>00017 <span class="comment">AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN</span> <a name="l00018"></a>00018 <span class="comment">AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span> <a name="l00019"></a>00019 <span class="comment">CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span> <a name="l00020"></a>00020 <span class="comment">*/</span> <a name="l00021"></a>00021 <a name="l00022"></a>00022 <span class="preprocessor">#ifndef DCOPSIGNALS_H</span> <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define DCOPSIGNALS_H "$Id: dcopsignals.h 345236 2004-09-09 15:23:55Z dfaure $"</span> <a name="l00024"></a>00024 <span class="preprocessor"></span> <a name="l00025"></a>00025 <span class="preprocessor">#include <qdict.h></span> <a name="l00026"></a>00026 <span class="preprocessor">#include <qasciidict.h></span> <a name="l00027"></a>00027 <span class="preprocessor">#include <qptrlist.h></span> <a name="l00028"></a>00028 <span class="preprocessor">#include <qstring.h></span> <a name="l00029"></a>00029 <span class="preprocessor">#include "kdelibs_export.h"</span> <a name="l00030"></a>00030 <a name="l00031"></a>00031 <span class="keyword">class </span><a class="code" href="classDCOPConnection.html">DCOPConnection</a>; <a name="l00032"></a>00032 <a name="l00037"></a><a class="code" href="classDCOPSignalConnection.html">00037</a> <span class="keyword">class </span>DCOP_EXPORT <a class="code" href="classDCOPSignalConnection.html">DCOPSignalConnection</a> <a name="l00038"></a>00038 { <a name="l00039"></a>00039 <span class="keyword">public</span>: <a name="l00040"></a><a class="code" href="classDCOPSignalConnection.html#e46a865d98a81e177a5d3b80c667b874">00040</a> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> sender; <span class="comment">// Sender client, empty means any client</span> <a name="l00041"></a><a class="code" href="classDCOPSignalConnection.html#a0c492035d032d85e136127a6cb13a22">00041</a> <a class="code" href="classDCOPConnection.html">DCOPConnection</a> *senderConn; <span class="comment">//Sender client.</span> <a name="l00042"></a><a class="code" href="classDCOPSignalConnection.html#b082c2676ae5a82a44db0989d554356f">00042</a> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> senderObj; <span class="comment">// Object that sends the signal.</span> <a name="l00043"></a><a class="code" href="classDCOPSignalConnection.html#55f7cac427540c04c4900040112966b7">00043</a> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> signal; <span class="comment">// Signal name. Connections are sorted on signal name.</span> <a name="l00044"></a>00044 <a name="l00045"></a><a class="code" href="classDCOPSignalConnection.html#22e61404382ff0652b00584be09f171b">00045</a> <a class="code" href="classDCOPConnection.html">DCOPConnection</a> *recvConn; <span class="comment">// Client that wants to receive the signal</span> <a name="l00046"></a><a class="code" href="classDCOPSignalConnection.html#10c65e068b341fc45608b51d2e07ec9d">00046</a> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> recvObj; <span class="comment">// Object that wants to receive the signal</span> <a name="l00047"></a><a class="code" href="classDCOPSignalConnection.html#af4c8b57f6839b0de358269e8aef0171">00047</a> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> slot; <span class="comment">// Function to send to in the object.</span> <a name="l00048"></a>00048 }; <a name="l00049"></a>00049 <a name="l00051"></a><a class="code" href="classDCOPSignalConnectionList.html">00051</a> <span class="keyword">class </span>DCOP_EXPORT DCOPSignalConnectionList : <span class="keyword">public</span> <a class="codeRef" doxygen="qt.tag:" href="qptrlist.html">QPtrList</a><DCOPSignalConnection> <a name="l00052"></a>00052 { <a name="l00053"></a>00053 <span class="keyword">public</span>: <a name="l00054"></a><a class="code" href="classDCOPSignalConnectionList.html#10d8ba220dd0ff342b2805918c5647c4">00054</a> DCOPSignalConnectionList() { }; <a name="l00055"></a>00055 }; <a name="l00056"></a>00056 <a name="l00060"></a><a class="code" href="classDCOPSignals.html">00060</a> <span class="keyword">class </span>DCOP_EXPORT DCOPSignals <a name="l00061"></a>00061 { <a name="l00062"></a>00062 <span class="keyword">public</span>: <a name="l00063"></a>00063 DCOPSignals(); <a name="l00064"></a>00064 <a name="l00073"></a>00073 <span class="keywordtype">void</span> emitSignal( <a class="code" href="classDCOPConnection.html">DCOPConnection</a> *conn, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &fun, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qbytearray.html">QByteArray</a> &data, <span class="keywordtype">bool</span> excludeSelf); <a name="l00074"></a>00074 <a name="l00089"></a>00089 <span class="keywordtype">bool</span> connectSignal( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &sender, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &senderObj, <a name="l00090"></a>00090 <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &signal, <a name="l00091"></a>00091 <a class="code" href="classDCOPConnection.html">DCOPConnection</a> *conn, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &receiverObj, <a name="l00092"></a>00092 <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &slot, <span class="keywordtype">bool</span> Volatile); <a name="l00093"></a>00093 <a name="l00103"></a>00103 <span class="keywordtype">bool</span> disconnectSignal( <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &sender, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &senderObj, <a name="l00104"></a>00104 <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &signal, <a name="l00105"></a>00105 <a class="code" href="classDCOPConnection.html">DCOPConnection</a> *conn, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &receiverObj, <a name="l00106"></a>00106 <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &slot); <a name="l00107"></a>00107 <a name="l00114"></a>00114 <span class="keywordtype">void</span> removeConnections(<a class="code" href="classDCOPConnection.html">DCOPConnection</a> *conn, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &obj=0); <a name="l00115"></a>00115 <a name="l00116"></a>00116 <a name="l00117"></a>00117 <span class="comment">/*</span> <a name="l00118"></a>00118 <span class="comment"> * The administration.</span> <a name="l00119"></a>00119 <span class="comment"> *</span> <a name="l00120"></a>00120 <span class="comment"> * All connections are sorted by "signal" and then inserted in the</span> <a name="l00121"></a>00121 <span class="comment"> * administration as a list.</span> <a name="l00122"></a>00122 <span class="comment"> *</span> <a name="l00123"></a>00123 <span class="comment"> * connections[signal] gives a list of all connections related to</span> <a name="l00124"></a>00124 <span class="comment"> * a given signal. The connections in this list may specify different</span> <a name="l00125"></a>00125 <span class="comment"> * senders and receiving clients/objects.</span> <a name="l00126"></a>00126 <span class="comment"> */</span> <a name="l00127"></a><a class="code" href="classDCOPSignals.html#54186259b58464b5f3078e7f0af9f3db">00127</a> <a class="codeRef" doxygen="qt.tag:" href="qasciidict.html">QAsciiDict<DCOPSignalConnectionList></a> connections; <a name="l00128"></a>00128 }; <a name="l00129"></a>00129 <a name="l00130"></a>00130 <span class="comment">//</span> <a name="l00131"></a>00131 <span class="comment">// connectSignal:</span> <a name="l00132"></a>00132 <span class="comment">//</span> <a name="l00133"></a>00133 <span class="comment">// Check whether signal and slot match wrt arguments.</span> <a name="l00134"></a>00134 <span class="comment">// A slot may ignore arguments from the signal.</span> <a name="l00135"></a>00135 <span class="comment">//</span> <a name="l00136"></a>00136 <span class="comment">// If volatile</span> <a name="l00137"></a>00137 <span class="comment">// then lookup senderConn...</span> <a name="l00138"></a>00138 <span class="comment">// If not found?</span> <a name="l00139"></a>00139 <span class="comment">// then return false</span> <a name="l00140"></a>00140 <span class="comment">// Create DCOPSignalConnection.</span> <a name="l00141"></a>00141 <span class="comment">// Add DCOPSignalConnection to "connections".</span> <a name="l00142"></a>00142 <span class="comment">// Add DCOPSignalConnection to conn->connectionList()</span> <a name="l00143"></a>00143 <span class="comment">// If volatile</span> <a name="l00144"></a>00144 <span class="comment">// then Add DCOPSignalConnection to senderConn->connectionList()</span> <a name="l00145"></a>00145 <span class="comment">// Return true</span> <a name="l00146"></a>00146 <a name="l00147"></a>00147 <a name="l00148"></a>00148 <span class="comment">// removeConnections:</span> <a name="l00149"></a>00149 <span class="comment">//</span> <a name="l00150"></a>00150 <span class="comment">// For each DCOPSignalConnection in conn->connectionList</span> <a name="l00151"></a>00151 <span class="comment">// if DCOPSignalConnection->sender == conn->appId</span> <a name="l00152"></a>00152 <span class="comment">// then remove DCOPSignalConnection from DCOPSIgnalConnection->conn</span> <a name="l00153"></a>00153 <span class="comment">// if DCOPSignalConnection->conn == conn</span> <a name="l00154"></a>00154 <span class="comment">// then.. this is ugly.. remove DCOPSignalConnection from DCOPSignalConnection->sender</span> <a name="l00155"></a>00155 <span class="comment">// WARNING: Take care when sender and conn are the same client!</span> <a name="l00156"></a>00156 <span class="comment">// Remove DCOPSignalConnection from connections[DCOPSignalConnection->signal]</span> <a name="l00157"></a>00157 <a name="l00158"></a>00158 <span class="preprocessor">#endif</span> </pre></div> </div></div> </td> </tr> <tr> <td valign="top" id="leftmenu" width="25%"> <a name="navigation"></a> <div class="menu_box"><h2>dcop</h2> <div class="nav_list"> <ul><li><a href="index.html">Main Page</a></li><li><a href="modules.html">Modules</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="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</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="classDCOPArg.html">dcoparg</option>, <option value="classDCOPClient.html">dcopclient</option>, <option value="classDCOPConnection.html">dcopconnection</option>, <option value="classDCOPObject.html">dcopobject</option>, <option value="classDCOPObjectProxy.html">dcopobjectproxy</option>, <option value="classDCOPRef.html">dcopref</option>, <option value="classDCOPReply.html">dcopreply</option>, <option value="classDCOPServer.html">dcopserver</option>, <option value="classDCOPSignalConnection.html">dcopsignalconnection</option>, <option value="classDCOPSignalConnectionList.html">dcopsignalconnectionlist</option>, <option value="classDCOPSignals.html">dcopsignals</option>, <option value="classDCOPStub.html">dcopstub</option>, <option value="classDefaultTest.html">defaulttest</option>, <option value="classHashingTest.html">hashingtest</option>, <option value="classMyDCOPObject.html">mydcopobject</option>, <option value="classNoFunctions.html">nofunctions</option>, <option value="classNonDCOPObject.html">nondcopobject</option>, <option value="classNonHashingTest.html">nonhashingtest</option>, <option value="classNoSuper.html">nosuper</option>, <option value="classSignalTest.html">signaltest</option>, <option value="classTest.html">test</option>, <option value="classTest2.html">test2</option>, <option value="classTestNamespace_1_1NamespaceTest.html">testnamespace::namespacetest</option>, <option value="classTestObject.html">testobject</option>, <option value="classTheNameSpace_1_1Test3.html">thenamespace::test3</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:wintert@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>