Tizen 2.1 base
[platform/upstream/glib2.0.git] / docs / reference / gio / html / GDBusObjectProxy.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GDBusObjectProxy</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GIO Reference Manual">
8 <link rel="up" href="gdbus-convenience.html" title="Highlevel D-Bus Support">
9 <link rel="prev" href="GDBusObjectSkeleton.html" title="GDBusObjectSkeleton">
10 <link rel="next" href="GDBusObjectManager.html" title="GDBusObjectManager">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="GDBusObjectSkeleton.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="gdbus-convenience.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GIO Reference Manual</th>
21 <td><a accesskey="n" href="GDBusObjectManager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#GDBusObjectProxy.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#GDBusObjectProxy.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#GDBusObjectProxy.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#GDBusObjectProxy.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31                    | 
32                   <a href="#GDBusObjectProxy.properties" class="shortcut">Properties</a>
33 </td></tr>
34 </table>
35 <div class="refentry">
36 <a name="GDBusObjectProxy"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
38 <td valign="top">
39 <h2><span class="refentrytitle"><a name="GDBusObjectProxy.top_of_page"></a>GDBusObjectProxy</span></h2>
40 <p>GDBusObjectProxy — Client-side D-Bus object</p>
41 </td>
42 <td valign="top" align="right"></td>
43 </tr></table></div>
44 <div class="refsynopsisdiv">
45 <a name="GDBusObjectProxy.synopsis"></a><h2>Synopsis</h2>
46 <pre class="synopsis">
47 #include &lt;gio/gio.h&gt;
48
49                     <a class="link" href="GDBusObjectProxy.html#GDBusObjectProxy-struct" title="GDBusObjectProxy">GDBusObjectProxy</a>;
50 struct              <a class="link" href="GDBusObjectProxy.html#GDBusObjectProxyClass" title="struct GDBusObjectProxyClass">GDBusObjectProxyClass</a>;
51 <a class="link" href="GDBusObjectProxy.html" title="GDBusObjectProxy"><span class="returnvalue">GDBusObjectProxy</span></a> *  <a class="link" href="GDBusObjectProxy.html#g-dbus-object-proxy-new" title="g_dbus_object_proxy_new ()">g_dbus_object_proxy_new</a>             (<em class="parameter"><code><a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a> *connection</code></em>,
52                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>);
53 <a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="returnvalue">GDBusConnection</span></a> *   <a class="link" href="GDBusObjectProxy.html#g-dbus-object-proxy-get-connection" title="g_dbus_object_proxy_get_connection ()">g_dbus_object_proxy_get_connection</a>  (<em class="parameter"><code><a class="link" href="GDBusObjectProxy.html" title="GDBusObjectProxy"><span class="type">GDBusObjectProxy</span></a> *proxy</code></em>);
54 </pre>
55 </div>
56 <div class="refsect1">
57 <a name="GDBusObjectProxy.object-hierarchy"></a><h2>Object Hierarchy</h2>
58 <pre class="synopsis">
59   <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
60    +----GDBusObjectProxy
61 </pre>
62 </div>
63 <div class="refsect1">
64 <a name="GDBusObjectProxy.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
65 <p>
66 GDBusObjectProxy implements
67  <a class="link" href="GDBusObject.html" title="GDBusObject">GDBusObject</a>.</p>
68 </div>
69 <div class="refsect1">
70 <a name="GDBusObjectProxy.properties"></a><h2>Properties</h2>
71 <pre class="synopsis">
72   "<a class="link" href="GDBusObjectProxy.html#GDBusObjectProxy--g-connection" title='The "g-connection" property'>g-connection</a>"             <a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a>*      : Read / Write / Construct Only
73   "<a class="link" href="GDBusObjectProxy.html#GDBusObjectProxy--g-object-path" title='The "g-object-path" property'>g-object-path</a>"            <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
74 </pre>
75 </div>
76 <div class="refsect1">
77 <a name="GDBusObjectProxy.description"></a><h2>Description</h2>
78 <p>
79 A <a class="link" href="GDBusObjectProxy.html" title="GDBusObjectProxy"><span class="type">GDBusObjectProxy</span></a> is an object used to represent a remote object
80 with one or more D-Bus interfaces. Normally, you don't instantiate
81 a <a class="link" href="GDBusObjectProxy.html" title="GDBusObjectProxy"><span class="type">GDBusObjectProxy</span></a> yourself - typically <a class="link" href="GDBusObjectManagerClient.html" title="GDBusObjectManagerClient"><span class="type">GDBusObjectManagerClient</span></a>
82 is used to obtain it.
83 </p>
84 </div>
85 <div class="refsect1">
86 <a name="GDBusObjectProxy.details"></a><h2>Details</h2>
87 <div class="refsect2">
88 <a name="GDBusObjectProxy-struct"></a><h3>GDBusObjectProxy</h3>
89 <pre class="programlisting">typedef struct _GDBusObjectProxy GDBusObjectProxy;</pre>
90 <p>
91 The <a class="link" href="GDBusObjectProxy.html" title="GDBusObjectProxy"><span class="type">GDBusObjectProxy</span></a> structure contains private data and should
92 only be accessed using the provided API.
93 </p>
94 <p class="since">Since 2.30</p>
95 </div>
96 <hr>
97 <div class="refsect2">
98 <a name="GDBusObjectProxyClass"></a><h3>struct GDBusObjectProxyClass</h3>
99 <pre class="programlisting">struct GDBusObjectProxyClass {
100   GObjectClass parent_class;
101 };
102 </pre>
103 <p>
104 Class structure for <a class="link" href="GDBusObjectProxy.html" title="GDBusObjectProxy"><span class="type">GDBusObjectProxy</span></a>.
105 </p>
106 <div class="variablelist"><table border="0">
107 <col align="left" valign="top">
108 <tbody><tr>
109 <td><p><span class="term"><a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GDBusObjectProxyClass.parent-class"></a>parent_class</code></em>;</span></p></td>
110 <td>The parent class.</td>
111 </tr></tbody>
112 </table></div>
113 <p class="since">Since 2.30</p>
114 </div>
115 <hr>
116 <div class="refsect2">
117 <a name="g-dbus-object-proxy-new"></a><h3>g_dbus_object_proxy_new ()</h3>
118 <pre class="programlisting"><a class="link" href="GDBusObjectProxy.html" title="GDBusObjectProxy"><span class="returnvalue">GDBusObjectProxy</span></a> *  g_dbus_object_proxy_new             (<em class="parameter"><code><a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a> *connection</code></em>,
119                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>);</pre>
120 <p>
121 Creates a new <a class="link" href="GDBusObjectProxy.html" title="GDBusObjectProxy"><span class="type">GDBusObjectProxy</span></a> for the given connection and
122 object path.
123 </p>
124 <div class="variablelist"><table border="0">
125 <col align="left" valign="top">
126 <tbody>
127 <tr>
128 <td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
129 <td>a <a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a>
130 </td>
131 </tr>
132 <tr>
133 <td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
134 <td>the object path</td>
135 </tr>
136 <tr>
137 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
138 <td>a new <a class="link" href="GDBusObjectProxy.html" title="GDBusObjectProxy"><span class="type">GDBusObjectProxy</span></a>
139 </td>
140 </tr>
141 </tbody>
142 </table></div>
143 <p class="since">Since 2.30</p>
144 </div>
145 <hr>
146 <div class="refsect2">
147 <a name="g-dbus-object-proxy-get-connection"></a><h3>g_dbus_object_proxy_get_connection ()</h3>
148 <pre class="programlisting"><a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="returnvalue">GDBusConnection</span></a> *   g_dbus_object_proxy_get_connection  (<em class="parameter"><code><a class="link" href="GDBusObjectProxy.html" title="GDBusObjectProxy"><span class="type">GDBusObjectProxy</span></a> *proxy</code></em>);</pre>
149 <p>
150 Gets the connection that <em class="parameter"><code>proxy</code></em> is for.
151 </p>
152 <div class="variablelist"><table border="0">
153 <col align="left" valign="top">
154 <tbody>
155 <tr>
156 <td><p><span class="term"><em class="parameter"><code>proxy</code></em> :</span></p></td>
157 <td>a <a class="link" href="GDBusObjectProxy.html" title="GDBusObjectProxy"><span class="type">GDBusObjectProxy</span></a>
158 </td>
159 </tr>
160 <tr>
161 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
162 <td>A <a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a>. Do not free, the
163 object is owned by <em class="parameter"><code>proxy</code></em>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
164 </td>
165 </tr>
166 </tbody>
167 </table></div>
168 <p class="since">Since 2.30</p>
169 </div>
170 </div>
171 <div class="refsect1">
172 <a name="GDBusObjectProxy.property-details"></a><h2>Property Details</h2>
173 <div class="refsect2">
174 <a name="GDBusObjectProxy--g-connection"></a><h3>The <code class="literal">"g-connection"</code> property</h3>
175 <pre class="programlisting">  "g-connection"             <a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a>*      : Read / Write / Construct Only</pre>
176 <p>
177 The connection of the proxy.
178 </p>
179 <p class="since">Since 2.30</p>
180 </div>
181 <hr>
182 <div class="refsect2">
183 <a name="GDBusObjectProxy--g-object-path"></a><h3>The <code class="literal">"g-object-path"</code> property</h3>
184 <pre class="programlisting">  "g-object-path"            <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
185 <p>
186 The object path of the proxy.
187 </p>
188 <p>Default value: NULL</p>
189 <p class="since">Since 2.30</p>
190 </div>
191 </div>
192 </div>
193 <div class="footer">
194 <hr>
195           Generated by GTK-Doc V1.18</div>
196 </body>
197 </html>