File: //usr/local/ssl/share/gtk-doc/html/libbonobo/libbonobo-bonobo-app-client.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>bonobo-app-client</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="Libbonobo Reference Manual">
<link rel="up" href="general.html" title="General">
<link rel="prev" href="libbonobo-bonobo-application.html" title="bonobo-application">
<link rel="next" href="factories.html" title="Objects, Factories, Reference Counting">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="general.html" title="General">
<link rel="chapter" href="factories.html" title="Objects, Factories, Reference Counting">
<link rel="chapter" href="property-bags.html" title="Property Bags, Events, Listeners">
<link rel="chapter" href="monikers.html" title="Monikers">
<link rel="chapter" href="streams.html" title="Storages and Streams">
<link rel="chapter" href="persist.html" title="Persistency">
<link rel="chapter" href="misc.html" title="Miscellaneous">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libbonobo-bonobo-application.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libbonobo Reference Manual</th>
<td><a accesskey="n" href="factories.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2696196" class="shortcut">Top</a>
 | 
<a href="#id2696444" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libbonobo-bonobo-app-client"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2696196"></a><span class="refentrytitle">bonobo-app-client</span>
</h2>
<p>bonobo-app-client — client interface to remote <span class="type">BonoboApplication</span> objects</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="libbonobo-bonobo-app-client.html#BonoboAppClientMsgDesc">BonoboAppClientMsgDesc</a>;
BonoboAppClient* <a href="libbonobo-bonobo-app-client.html#bonobo-app-client-new">bonobo_app_client_new</a> (Bonobo_Application app_server);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> <a href="libbonobo-bonobo-app-client.html#bonobo-app-client-new-instance">bonobo_app_client_new_instance</a> (BonoboAppClient *app_client,
int argc,
char *argv[],
CORBA_Environment *opt_env);
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"
>GValue</a>* <a href="libbonobo-bonobo-app-client.html#bonobo-app-client-msg-send-valist">bonobo_app_client_msg_send_valist</a>
(BonoboAppClient *app_client,
const char *message,
CORBA_Environment *opt_env,
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> first_arg_type,
va_list var_args);
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"
>GValue</a>* <a href="libbonobo-bonobo-app-client.html#bonobo-app-client-msg-send-argv">bonobo_app_client_msg_send_argv</a> (BonoboAppClient *app_client,
const char *message,
const <a
href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"
>GValue</a> *argv[],
CORBA_Environment *opt_env);
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"
>GValue</a>* <a href="libbonobo-bonobo-app-client.html#bonobo-app-client-msg-send">bonobo_app_client_msg_send</a> (BonoboAppClient *app_client,
const char *message,
CORBA_Environment *opt_env,
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> first_arg_type,
...);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2696444"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2696458"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2696469"></a><h3>
<a name="BonoboAppClientMsgDesc"></a>BonoboAppClientMsgDesc</h3>
<a class="indexterm" name="id2696482"></a><pre class="programlisting">typedef struct {
gchar *name;
GType return_type;
GType *types; /* G_TYPE_NONE-terminated array */
gchar *description;
} BonoboAppClientMsgDesc;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2696500"></a><h3>
<a name="bonobo-app-client-new"></a>bonobo_app_client_new ()</h3>
<a class="indexterm" name="id2696512"></a><pre class="programlisting">BonoboAppClient* bonobo_app_client_new (Bonobo_Application app_server);</pre>
<p>
<em class="parameter"><code>app_server</code></em>: object reference to a Bonobo::Application; this
function takes ownership of this reference (use
<a href="libbonobo-bonobo-object.html#bonobo-object-dup-ref"><code class="function">bonobo_object_dup_ref()</code></a> if you want to keep your own reference.)
</p>
<p>
Create an application client object connected to the remote (or
local) Bonobo::Application object.
</p>
<p>
</p>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>Applications should not use this function. See
<a href="libbonobo-bonobo-application.html#bonobo-application-register-unique"><code class="function">bonobo_application_register_unique()</code></a>.</div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_server</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a <span class="type">BonoboAppClient</span> object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2696625"></a><h3>
<a name="bonobo-app-client-new-instance"></a>bonobo_app_client_new_instance ()</h3>
<a class="indexterm" name="id2696638"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> bonobo_app_client_new_instance (BonoboAppClient *app_client,
int argc,
char *argv[],
CORBA_Environment *opt_env);</pre>
<p>
Ask the application server to emit a "new-instance" signal
containing the specified string vector.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_client</code></em> :</span></td>
<td> a <span class="type">BonoboAppClient</span>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
<td> length of <em class="parameter"><code>argv</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
<td> array of command-line arguments
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opt_env</code></em> :</span></td>
<td> a <span class="type">CORBA_Environment</span>, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the message return value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2696797"></a><h3>
<a name="bonobo-app-client-msg-send-valist"></a>bonobo_app_client_msg_send_valist ()</h3>
<a class="indexterm" name="id2696811"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"
>GValue</a>* bonobo_app_client_msg_send_valist
(BonoboAppClient *app_client,
const char *message,
CORBA_Environment *opt_env,
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> first_arg_type,
va_list var_args);</pre>
<p>
See <a href="libbonobo-bonobo-app-client.html#bonobo-app-client-msg-send"><code class="function">bonobo_app_client_msg_send()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_client</code></em> :</span></td>
<td> client
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>message</code></em> :</span></td>
<td> message name
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opt_env</code></em> :</span></td>
<td> optional corba environment
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>first_arg_type</code></em> :</span></td>
<td> first message parameter
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>var_args</code></em> :</span></td>
<td> remaining parameters
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> return value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2696971"></a><h3>
<a name="bonobo-app-client-msg-send-argv"></a>bonobo_app_client_msg_send_argv ()</h3>
<a class="indexterm" name="id2696984"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"
>GValue</a>* bonobo_app_client_msg_send_argv (BonoboAppClient *app_client,
const char *message,
const <a
href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"
>GValue</a> *argv[],
CORBA_Environment *opt_env);</pre>
<p>
Like <a href="libbonobo-bonobo-app-client.html#bonobo-app-client-msg-send"><code class="function">bonobo_app_client_msg_send()</code></a>, except that it receives a single
argument vector instead of a variable number of arguments.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_client</code></em> :</span></td>
<td> client
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>message</code></em> :</span></td>
<td> message name
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
<td> <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>-terminated vector of pointers to GValue, the arguments
to pass with the message.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opt_env</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the message return value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2697134"></a><h3>
<a name="bonobo-app-client-msg-send"></a>bonobo_app_client_msg_send ()</h3>
<a class="indexterm" name="id2697148"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"
>GValue</a>* bonobo_app_client_msg_send (BonoboAppClient *app_client,
const char *message,
CORBA_Environment *opt_env,
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> first_arg_type,
...);</pre>
<p>
Send a message to the application server. Takes a variable length
argument list of GType, value pairs, terminated with
<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-NONE:CAPS"
><code class="literal">G_TYPE_NONE</code></a>. Values are direct C values, not GValues! Example:
</p>
<div class="informalexample"><pre class="programlisting">
GValue *retval;
retval = bonobo_app_client_msg_send (app_client, "openURL",
G_TYPE_STRING, "http://www.gnome.org",
G_TYPE_BOOLEAN, TRUE,
G_TYPE_NONE);
</pre></div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_client</code></em> :</span></td>
<td> the client interface associated with the application
to which we wish to send a message
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>message</code></em> :</span></td>
<td> message name
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opt_env</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>first_arg_type</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>...</code></em> :</span></td>
<td> arguments
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a GValue containing the value returned from the
aplication server.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>