<?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: dcopstub.cpp 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.7.4 -->
<div class="header">
<div class="headertitle">
<div class="title">dcopstub.cpp</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*****************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment">Copyright (c) 1999 Preston Brown <pbrown@kde.org></span>
<a name="l00004"></a>00004 <span class="comment">Copyright (c) 1999 Matthias Ettrich <ettrich@kde.org></span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">Permission is hereby granted, free of charge, to any person obtaining a copy</span>
<a name="l00007"></a>00007 <span class="comment">of this software and associated documentation files (the "Software"), to deal</span>
<a name="l00008"></a>00008 <span class="comment">in the Software without restriction, including without limitation the rights</span>
<a name="l00009"></a>00009 <span class="comment">to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
<a name="l00010"></a>00010 <span class="comment">copies of the Software, and to permit persons to whom the Software is</span>
<a name="l00011"></a>00011 <span class="comment">furnished to do so, subject to the following conditions:</span>
<a name="l00012"></a>00012 <span class="comment"></span>
<a name="l00013"></a>00013 <span class="comment">The above copyright notice and this permission notice shall be included in</span>
<a name="l00014"></a>00014 <span class="comment">all copies or substantial portions of the Software.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<a name="l00017"></a>00017 <span class="comment">IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<a name="l00018"></a>00018 <span class="comment">FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
<a name="l00019"></a>00019 <span class="comment">AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN</span>
<a name="l00020"></a>00020 <span class="comment">AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span>
<a name="l00021"></a>00021 <span class="comment">CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
<a name="l00022"></a>00022 <span class="comment"></span>
<a name="l00023"></a>00023 <span class="comment">******************************************************************/</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#include "dcopstub.h"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "dcopclient.h"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "dcopref.h"</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">class </span>DCOPStubPrivate
<a name="l00030"></a>00030 {
<a name="l00031"></a>00031 <span class="keyword">public</span>:
<a name="l00032"></a>00032 DCOPStubPrivate():dcopClient(0){}
<a name="l00033"></a>00033 <a class="code" href="classDCOPClient.html" title="Inter-process communication and remote procedure calls for KDE applications.">DCOPClient</a>* dcopClient;
<a name="l00034"></a>00034 };
<a name="l00035"></a>00035
<a name="l00036"></a><a class="code" href="classDCOPStub.html#a7f23f3b09c26360ca9d7991984e45430">00036</a> <a class="code" href="classDCOPStub.html#a7f23f3b09c26360ca9d7991984e45430" title="Creates a DCOPStub for application app and object obj.">DCOPStub::DCOPStub</a>( <span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& app, <span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& obj )
<a name="l00037"></a>00037 : m_app( app ), m_obj( obj ), m_status( CallSucceeded ),d(0)
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 }
<a name="l00040"></a>00040
<a name="l00041"></a><a class="code" href="classDCOPStub.html#a6f22ecf7c14d51db42bf25a1d7d16370">00041</a> <a class="code" href="classDCOPStub.html#a7f23f3b09c26360ca9d7991984e45430" title="Creates a DCOPStub for application app and object obj.">DCOPStub::DCOPStub</a>( <a class="code" href="classDCOPClient.html" title="Inter-process communication and remote procedure calls for KDE applications.">DCOPClient</a>* client, <span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& app, <span class="keyword">const</span> <a class="codeRef" href="qcstring.html">QCString</a>& obj )
<a name="l00042"></a>00042 : m_app( app ), m_obj( obj ), m_status( CallSucceeded ),d(0)
<a name="l00043"></a>00043 {
<a name="l00044"></a>00044 <span class="keywordflow">if</span> ( client ) {
<a name="l00045"></a>00045 d = <span class="keyword">new</span> DCOPStubPrivate;
<a name="l00046"></a>00046 d->dcopClient = client;
<a name="l00047"></a>00047 }
<a name="l00048"></a>00048 }
<a name="l00049"></a>00049
<a name="l00050"></a><a class="code" href="classDCOPStub.html#a99e77954718ed99cb1e99eff909f22b2">00050</a> <a class="code" href="classDCOPStub.html#a7f23f3b09c26360ca9d7991984e45430" title="Creates a DCOPStub for application app and object obj.">DCOPStub::DCOPStub</a>( <span class="keyword">const</span> <a class="code" href="classDCOPRef.html" title="A DCOPRef(erence) encapsulates a remote DCOP object as a triple <app,obj,type> where type is optional...">DCOPRef</a>& ref )
<a name="l00051"></a>00051 : m_app( ref.app() ), m_obj( ref.obj() ), m_status( CallSucceeded ),d(0)
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 }
<a name="l00054"></a>00054
<a name="l00055"></a>00055 DCOPStub::~DCOPStub()
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057 <span class="keyword">delete</span> d;
<a name="l00058"></a>00058 }
<a name="l00059"></a>00059
<a name="l00060"></a><a class="code" href="classDCOPStub.html#ab481bd6b14141b05da0618d1e410d8c1">00060</a> <a class="code" href="classDCOPClient.html" title="Inter-process communication and remote procedure calls for KDE applications.">DCOPClient</a>* <a class="code" href="classDCOPStub.html#ab481bd6b14141b05da0618d1e410d8c1" title="The dcopClient this stub operates on.">DCOPStub::dcopClient</a>()
<a name="l00061"></a>00061 {
<a name="l00062"></a>00062 <span class="keywordflow">if</span> ( d )
<a name="l00063"></a>00063 <span class="keywordflow">return</span> d->dcopClient;
<a name="l00064"></a>00064 <span class="keywordflow">return</span> <a class="code" href="classDCOPClient.html#aa53dc8b77e9551859db246a04d87d0a8" title="Returns the application's main dcop client.">DCOPClient::mainClient</a>();
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066
<a name="l00067"></a><a class="code" href="classDCOPStub.html#afa8120e8338cb480e6c4d5bbccd00648">00067</a> DCOPStub::Status <a class="code" href="classDCOPStub.html#afa8120e8338cb480e6c4d5bbccd00648" title="Return the status of the last call, either CallSucceeded or CallFailed.">DCOPStub::status</a>()<span class="keyword"> const</span>
<a name="l00068"></a>00068 <span class="keyword"></span>{
<a name="l00069"></a>00069 <span class="keywordflow">return</span> m_status;
<a name="l00070"></a>00070 }
<a name="l00071"></a>00071
<a name="l00072"></a><a class="code" href="classDCOPStub.html#a299aa899ad5cb341370e9247fdc82df8">00072</a> <span class="keywordtype">void</span> <a class="code" href="classDCOPStub.html#a299aa899ad5cb341370e9247fdc82df8" title="Sets the status to status.">DCOPStub::setStatus</a>( Status _status )
<a name="l00073"></a>00073 {
<a name="l00074"></a>00074 m_status = _status;
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076
<a name="l00077"></a><a class="code" href="classDCOPStub.html#ab440a386e5ac73af966b8ab0581afa68">00077</a> <span class="keywordtype">bool</span> <a class="code" href="classDCOPStub.html#ab440a386e5ac73af966b8ab0581afa68" title="Return whether no error occurred,.">DCOPStub::ok</a>()<span class="keyword"> const</span>
<a name="l00078"></a>00078 <span class="keyword"></span>{
<a name="l00079"></a>00079 <span class="keywordflow">return</span> m_status != CallFailed;
<a name="l00080"></a>00080 }
<a name="l00081"></a>00081
<a name="l00082"></a><a class="code" href="classDCOPStub.html#a36328d34ebe927635b9dfece4e5f3cee">00082</a> <span class="keywordtype">void</span> <a class="code" href="classDCOPStub.html#a36328d34ebe927635b9dfece4e5f3cee" title="Invoked whenever a call fails.">DCOPStub::callFailed</a>()
<a name="l00083"></a>00083 {
<a name="l00084"></a>00084 <a class="code" href="classDCOPStub.html#a299aa899ad5cb341370e9247fdc82df8" title="Sets the status to status.">setStatus</a>( CallFailed );
<a name="l00085"></a>00085 }
<a name="l00086"></a>00086
<a name="l00087"></a><a class="code" href="classDCOPStub.html#a417fced16b20bd4311ddcfb5e1e862b6">00087</a> <a class="codeRef" href="qcstring.html">QCString</a> <a class="code" href="classDCOPStub.html#a417fced16b20bd4311ddcfb5e1e862b6" title="Return the application id.">DCOPStub::app</a>()<span class="keyword"> const</span>
<a name="l00088"></a>00088 <span class="keyword"></span>{
<a name="l00089"></a>00089 <span class="keywordflow">return</span> m_app;
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091
<a name="l00092"></a><a class="code" href="classDCOPStub.html#a22803bf7139f9c06f14a2ba31eff0521">00092</a> <a class="codeRef" href="qcstring.html">QCString</a> <a class="code" href="classDCOPStub.html#a22803bf7139f9c06f14a2ba31eff0521" title="Return the object id.">DCOPStub::obj</a>()<span class="keyword"> const</span>
<a name="l00093"></a>00093 <span class="keyword"></span>{
<a name="l00094"></a>00094 <span class="keywordflow">return</span> m_obj;
<a name="l00095"></a>00095 }
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keywordtype">void</span> DCOPStub::virtual_hook( <span class="keywordtype">int</span>, <span class="keywordtype">void</span>* )
<a name="l00098"></a>00098 { <span class="comment">/*BASE::virtual_hook( id, data );*/</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>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="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="classDCOPObject.html">dcopobject</option>, <option value="classDCOPObjectProxy.html">dcopobjectproxy</option>, <option value="classDCOPRef.html">dcopref</option>, <option value="classDCOPReply.html">dcopreply</option>, <option value="classDCOPStub.html">dcopstub</option>, <option value="classTest.html">test</option>, <option value="classTestObject.html">testobject</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>
