/usr/share/gtk-doc/html/libhud-client/HudClientParam.html is in libhud-client2-doc 13.10.1+14.04.20140402-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libhud-client Docs: HudClientParam</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libhud-client Docs">
<link rel="up" href="ch01.html" title="Data Types">
<link rel="prev" href="HudClientConnection.html" title="HudClientConnection">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#HudClientParam.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#HudClientParam.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#HudClientParam.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="HudClientConnection.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="HudClientParam"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="HudClientParam.top_of_page"></a>HudClientParam</span></h2>
<p>HudClientParam — Track a parameterized view</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="HudClientParam.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsect1">
<a name="HudClientParam.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="HudClientParam.html" title="HudClientParam"><span class="returnvalue">HudClientParam</span></a> *
</td>
<td class="function_name">
<a class="link" href="HudClientParam.html#hud-client-param-new" title="hud_client_param_new ()">hud_client_param_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<GTKDOCLINK HREF="GActionGroup"><span class="returnvalue">GActionGroup</span></GTKDOCLINK> *
</td>
<td class="function_name">
<a class="link" href="HudClientParam.html#hud-client-param-get-actions" title="hud_client_param_get_actions ()">hud_client_param_get_actions</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<GTKDOCLINK HREF="GMenuModel"><span class="returnvalue">GMenuModel</span></GTKDOCLINK> *
</td>
<td class="function_name">
<a class="link" href="HudClientParam.html#hud-client-param-get-model" title="hud_client_param_get_model ()">hud_client_param_get_model</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK>
</td>
<td class="function_name">
<a class="link" href="HudClientParam.html#hud-client-param-send-reset" title="hud_client_param_send_reset ()">hud_client_param_send_reset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK>
</td>
<td class="function_name">
<a class="link" href="HudClientParam.html#hud-client-param-send-cancel" title="hud_client_param_send_cancel ()">hud_client_param_send_cancel</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK>
</td>
<td class="function_name">
<a class="link" href="HudClientParam.html#hud-client-param-send-commit" title="hud_client_param_send_commit ()">hud_client_param_send_commit</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="HudClientParam.signals"></a><h2>Signals</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK></td>
<td class="signal_name"><a class="link" href="HudClientParam.html#HudClientParam-model-ready" title="The “model-ready” signal">model-ready</a></td>
<td class="signal_flags"><GTKDOCLINK HREF="G-SIGNAL-RUN-LAST:CAPS">Run Last</GTKDOCLINK></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="HudClientParam.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="HudClientParam.html#HUD-CLIENT-PARAM-SIGNAL-MODEL-READY:CAPS" title="HUD_CLIENT_PARAM_SIGNAL_MODEL_READY">HUD_CLIENT_PARAM_SIGNAL_MODEL_READY</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="HudClientParam.html#HudClientParamClass" title="struct HudClientParamClass">HudClientParamClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="HudClientParam.html#HudClientParam-struct" title="struct HudClientParam">HudClientParam</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="HudClientParam.html#HudClientParamPrivate" title="HudClientParamPrivate">HudClientParamPrivate</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="HudClientParam.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK>
<span class="lineart">╰──</span> HudClientParam
</pre>
</div>
<div class="refsect1">
<a name="HudClientParam.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libhud-client/param.h>
</pre>
</div>
<div class="refsect1">
<a name="HudClientParam.description"></a><h2>Description</h2>
<p>This makes it much easier to interact with the parameterized
pane of the HUD. Provides the links to the menu model and the
actions that should be shown. Also provides convienience functions
for resetting it and fun stuff like that.</p>
</div>
<div class="refsect1">
<a name="HudClientParam.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="hud-client-param-new"></a><h3>hud_client_param_new ()</h3>
<pre class="programlisting"><a class="link" href="HudClientParam.html" title="HudClientParam"><span class="returnvalue">HudClientParam</span></a> *
hud_client_param_new (<em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *dbus_address</code></em>,
<em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *prefix</code></em>,
<em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *base_action</code></em>,
<em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *action_path</code></em>,
<em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *model_path</code></em>,
<em class="parameter"><code><GTKDOCLINK HREF="gint"><span class="type">gint</span></GTKDOCLINK> model_section</code></em>);</pre>
<p>Create a new <a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> object for adjusting a specified
paramaterized dialog.</p>
<div class="refsect3">
<a name="id-1.2.4.10.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dbus_address</p></td>
<td class="parameter_description"><p>The address on dbus to find the actions</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prefix</p></td>
<td class="parameter_description"><p>The prefix the menu is using</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>base_action</p></td>
<td class="parameter_description"><p>The action to send events for the dialog on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>action_path</p></td>
<td class="parameter_description"><p>DBus path to the action object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>model_path</p></td>
<td class="parameter_description"><p>DBus path to the menu model object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>model_section</p></td>
<td class="parameter_description"><p>Section of the model to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.10.2.6"></a><h4>Returns</h4>
<p> A new <a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> dialog. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="hud-client-param-get-actions"></a><h3>hud_client_param_get_actions ()</h3>
<pre class="programlisting"><GTKDOCLINK HREF="GActionGroup"><span class="returnvalue">GActionGroup</span></GTKDOCLINK> *
hud_client_param_get_actions (<em class="parameter"><code><a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> *param</code></em>);</pre>
<p>The object path to the actions</p>
<div class="refsect3">
<a name="id-1.2.4.10.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>param</p></td>
<td class="parameter_description"><p>The <a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.10.3.6"></a><h4>Returns</h4>
<p> A <GTKDOCLINK HREF="GActionGroup"><span class="type">GActionGroup</span></GTKDOCLINK> that has the actions in it. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="hud-client-param-get-model"></a><h3>hud_client_param_get_model ()</h3>
<pre class="programlisting"><GTKDOCLINK HREF="GMenuModel"><span class="returnvalue">GMenuModel</span></GTKDOCLINK> *
hud_client_param_get_model (<em class="parameter"><code><a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> *param</code></em>);</pre>
<p>The object path to the model</p>
<div class="refsect3">
<a name="id-1.2.4.10.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>param</p></td>
<td class="parameter_description"><p>The <a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.10.4.6"></a><h4>Returns</h4>
<p> The menu model of the pane. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="hud-client-param-send-reset"></a><h3>hud_client_param_send_reset ()</h3>
<pre class="programlisting"><GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK>
hud_client_param_send_reset (<em class="parameter"><code><a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> *param</code></em>);</pre>
<p>Send the command to the application to reset the values
of the actions in the pane.</p>
<div class="refsect3">
<a name="id-1.2.4.10.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>param</p></td>
<td class="parameter_description"><p>The <a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="hud-client-param-send-cancel"></a><h3>hud_client_param_send_cancel ()</h3>
<pre class="programlisting"><GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK>
hud_client_param_send_cancel (<em class="parameter"><code><a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> *param</code></em>);</pre>
<p>Send the command to the application to cancel the values
of the actions in the panel and expect it to close soon.</p>
<div class="refsect3">
<a name="id-1.2.4.10.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>param</p></td>
<td class="parameter_description"><p>The <a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="hud-client-param-send-commit"></a><h3>hud_client_param_send_commit ()</h3>
<pre class="programlisting"><GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK>
hud_client_param_send_commit (<em class="parameter"><code><a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> *param</code></em>);</pre>
<p>Tell the application that the user has requested the values
be applied. This doesn't mean that there isn't a dialog
still open, when it closes "end" will be sent.</p>
<div class="refsect3">
<a name="id-1.2.4.10.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>param</p></td>
<td class="parameter_description"><p>The <a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="HudClientParam.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="HUD-CLIENT-PARAM-SIGNAL-MODEL-READY:CAPS"></a><h3>HUD_CLIENT_PARAM_SIGNAL_MODEL_READY</h3>
<pre class="programlisting">#define HUD_CLIENT_PARAM_SIGNAL_MODEL_READY "model-ready"
</pre>
<p>Signal to indicate when the model is ready</p>
</div>
<hr>
<div class="refsect2">
<a name="HudClientParamClass"></a><h3>struct HudClientParamClass</h3>
<pre class="programlisting">struct HudClientParamClass {
GObjectClass parent_class;
/*< Private >*/
void (*model_ready) (HudClientParamClass * param, gpointer user_data);
};
</pre>
<p>Class information for <a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a></p>
<div class="refsect3">
<a name="id-1.2.4.11.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><GTKDOCLINK HREF="GObjectClass"><span class="type">GObjectClass</span></GTKDOCLINK> <em class="structfield"><code><a name="HudClientParamClass.parent-class"></a>parent_class</code></em>;</p></td>
<td class="struct_member_description"><p><GTKDOCLINK HREF="GObjectClass"><span class="type">GObjectClass</span></GTKDOCLINK></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="HudClientParamClass.model-ready"></a>model_ready</code></em> ()</p></td>
<td class="struct_member_description"><p>Slot for the model-ready signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="HudClientParam-struct"></a><h3>struct HudClientParam</h3>
<pre class="programlisting">struct HudClientParam;</pre>
<p>An object that tracks all the of the stuff needed to handle
a parameterized dialog of actions.</p>
</div>
<hr>
<div class="refsect2">
<a name="HudClientParamPrivate"></a><h3>HudClientParamPrivate</h3>
<pre class="programlisting">typedef struct _HudClientParamPrivate HudClientParamPrivate;</pre>
<p>Private data for <a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a>.</p>
</div>
</div>
<div class="refsect1">
<a name="HudClientParam.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="HudClientParam-model-ready"></a><h3>The <code class="literal">“model-ready”</code> signal</h3>
<pre class="programlisting"><GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK>
user_function (<a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> *arg0,
<GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK> user_data)</pre>
<p>Emitted when the model can be used. It may also be updating, but
the base item is there.</p>
<div class="refsect3">
<a name="id-1.2.4.12.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>arg0</p></td>
<td class="parameter_description"><p>The <a class="link" href="HudClientParam.html" title="HudClientParam"><span class="type">HudClientParam</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <GTKDOCLINK HREF="G-SIGNAL-RUN-LAST:CAPS">Run Last</GTKDOCLINK></p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|