<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>CallyActor: Clutter Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> <link rel="home" href="index.html" title="Clutter Reference Manual"> <link rel="up" href="ch13.html" title="Base Classes"> <link rel="prev" href="ch13.html" title="Base Classes"> <link rel="next" href="CallyGroup.html" title="CallyGroup"> <meta name="generator" content="GTK-Doc V1.25.1 (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="5"><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="#CallyActor.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> <a href="#CallyActor.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> <a href="#CallyActor.implemented-interfaces" class="shortcut">Implemented Interfaces</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="ch13.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> <td><a accesskey="p" href="ch13.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="CallyGroup.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="CallyActor"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="CallyActor.top_of_page"></a>CallyActor</span></h2> <p>CallyActor — Implementation of the ATK interfaces for <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a></p> </td> <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> <a name="CallyActor.functions"></a><h2>Functions</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="functions_return"> <col class="functions_name"> </colgroup> <tbody> <tr> <td class="function_type"> <span class="returnvalue">void</span> </td> <td class="function_name"> <span class="c_punctuation">(</span><a class="link" href="CallyActor.html#CallyActionFunc" title="CallyActionFunc ()">*CallyActionFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">void</span> </td> <td class="function_name"> <span class="c_punctuation">(</span><a class="link" href="CallyActor.html#CallyActionCallback" title="CallyActionCallback ()">*CallyActionCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">AtkObject</span> * </td> <td class="function_name"> <a class="link" href="CallyActor.html#cally-actor-new" title="cally_actor_new ()">cally_actor_new</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">guint</span> </td> <td class="function_name"> <a class="link" href="CallyActor.html#cally-actor-add-action" title="cally_actor_add_action ()">cally_actor_add_action</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">guint</span> </td> <td class="function_name"> <a class="link" href="CallyActor.html#cally-actor-add-action-full" title="cally_actor_add_action_full ()">cally_actor_add_action_full</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">gboolean</span> </td> <td class="function_name"> <a class="link" href="CallyActor.html#cally-actor-remove-action" title="cally_actor_remove_action ()">cally_actor_remove_action</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">gboolean</span> </td> <td class="function_name"> <a class="link" href="CallyActor.html#cally-actor-remove-action-by-name" title="cally_actor_remove_action_by_name ()">cally_actor_remove_action_by_name</a> <span class="c_punctuation">()</span> </td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="CallyActor.other"></a><h2>Types and Values</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="name"> <col class="description"> </colgroup> <tbody> <tr> <td class="datatype_keyword">struct</td> <td class="function_name"><a class="link" href="CallyActor.html#CallyActor-struct" title="struct CallyActor">CallyActor</a></td> </tr> <tr> <td class="datatype_keyword">struct</td> <td class="function_name"><a class="link" href="CallyActor.html#CallyActorClass" title="struct CallyActorClass">CallyActorClass</a></td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="CallyActor.object-hierarchy"></a><h2>Object Hierarchy</h2> <pre class="screen"> GObject <span class="lineart">╰──</span> AtkObject <span class="lineart">╰──</span> AtkGObjectAccessible <span class="lineart">╰──</span> CallyActor <span class="lineart">├──</span> <a class="link" href="CallyClone.html" title="CallyClone">CallyClone</a> <span class="lineart">├──</span> <a class="link" href="CallyGroup.html" title="CallyGroup">CallyGroup</a> <span class="lineart">├──</span> <a class="link" href="CallyRectangle.html" title="CallyRectangle">CallyRectangle</a> <span class="lineart">├──</span> <a class="link" href="CallyText.html" title="CallyText">CallyText</a> <span class="lineart">╰──</span> <a class="link" href="CallyTexture.html" title="CallyTexture">CallyTexture</a> </pre> </div> <div class="refsect1"> <a name="CallyActor.implemented-interfaces"></a><h2>Implemented Interfaces</h2> <p> CallyActor implements AtkComponent and AtkAction.</p> </div> <div class="refsect1"> <a name="CallyActor.description"></a><h2>Description</h2> <p><a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a> implements the required ATK interfaces of <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> exposing the common elements on each actor (position, extents, etc).</p> </div> <div class="refsect1"> <a name="CallyActor.functions_details"></a><h2>Functions</h2> <div class="refsect2"> <a name="CallyActionFunc"></a><h3>CallyActionFunc ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> <span class="c_punctuation">(</span>*CallyActionFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a> *cally_actor</code></em>);</pre> <p>Action function, to be used on <span class="type">AtkAction</span> implementations as a individual action</p> <div class="refsect3"> <a name="CallyActionFunc.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" 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>cally_actor</p></td> <td class="parameter_description"><p>a <a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p> </div> <hr> <div class="refsect2"> <a name="CallyActionCallback"></a><h3>CallyActionCallback ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> <span class="c_punctuation">(</span>*CallyActionCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a> *cally_actor</code></em>, <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> <p>Action function, to be used on <span class="type">AtkAction</span> implementations as an individual action. Unlike <a class="link" href="CallyActor.html#CallyActionFunc" title="CallyActionFunc ()"><span class="type">CallyActionFunc</span></a>, this function uses the <em class="parameter"><code>user_data</code></em> argument passed to <a class="link" href="CallyActor.html#cally-actor-add-action-full" title="cally_actor_add_action_full ()"><code class="function">cally_actor_add_action_full()</code></a>.</p> <div class="refsect3"> <a name="CallyActionCallback.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" 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>cally_actor</p></td> <td class="parameter_description"><p>a <a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a></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 passed to the function</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <p class="since">Since: <a class="link" href="ix10.html#api-index-1.6">1.6</a></p> </div> <hr> <div class="refsect2"> <a name="cally-actor-new"></a><h3>cally_actor_new ()</h3> <pre class="programlisting"><span class="returnvalue">AtkObject</span> * cally_actor_new (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre> <p>Creates a new <a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a> for the given <em class="parameter"><code>actor</code></em> </p> <div class="refsect3"> <a name="cally-actor-new.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" 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>actor</p></td> <td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="cally-actor-new.returns"></a><h4>Returns</h4> <p> the newly created <span class="type">AtkObject</span></p> </div> <p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p> </div> <hr> <div class="refsect2"> <a name="cally-actor-add-action"></a><h3>cally_actor_add_action ()</h3> <pre class="programlisting"><span class="returnvalue">guint</span> cally_actor_add_action (<em class="parameter"><code><a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a> *cally_actor</code></em>, <em class="parameter"><code>const <span class="type">gchar</span> *action_name</code></em>, <em class="parameter"><code>const <span class="type">gchar</span> *action_description</code></em>, <em class="parameter"><code>const <span class="type">gchar</span> *action_keybinding</code></em>, <em class="parameter"><code><a class="link" href="CallyActor.html#CallyActionFunc" title="CallyActionFunc ()"><span class="type">CallyActionFunc</span></a> action_func</code></em>);</pre> <p>Adds a new action to be accessed with the <span class="type">AtkAction</span> interface.</p> <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> <a name="cally-actor-add-action.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" 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>cally_actor</p></td> <td class="parameter_description"><p>a <a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>action_name</p></td> <td class="parameter_description"><p>the action name</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>action_description</p></td> <td class="parameter_description"><p>the action description</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>action_keybinding</p></td> <td class="parameter_description"><p>the action keybinding</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>action_func</p></td> <td class="parameter_description"><p>the callback of the action, to be executed with do_action</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="cally-actor-add-action.returns"></a><h4>Returns</h4> <p> added action id, or -1 if failure</p> </div> <p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p> </div> <hr> <div class="refsect2"> <a name="cally-actor-add-action-full"></a><h3>cally_actor_add_action_full ()</h3> <pre class="programlisting"><span class="returnvalue">guint</span> cally_actor_add_action_full (<em class="parameter"><code><a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a> *cally_actor</code></em>, <em class="parameter"><code>const <span class="type">gchar</span> *action_name</code></em>, <em class="parameter"><code>const <span class="type">gchar</span> *action_description</code></em>, <em class="parameter"><code>const <span class="type">gchar</span> *action_keybinding</code></em>, <em class="parameter"><code><a class="link" href="CallyActor.html#CallyActionCallback" title="CallyActionCallback ()"><span class="type">CallyActionCallback</span></a> callback</code></em>, <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>, <em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre> <p>Adds a new action to be accessed with the <span class="type">AtkAction</span> interface.</p> <p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> cally_actor_add_action]</span></p> <div class="refsect3"> <a name="cally-actor-add-action-full.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" 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>cally_actor</p></td> <td class="parameter_description"><p>a <a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>action_name</p></td> <td class="parameter_description"><p>the action name</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>action_description</p></td> <td class="parameter_description"><p>the action description</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>action_keybinding</p></td> <td class="parameter_description"><p>the action keybinding</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>callback</p></td> <td class="parameter_description"><p> the callback of the action. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td> </tr> <tr> <td class="parameter_name"><p>user_data</p></td> <td class="parameter_description"><p> data to be passed to <em class="parameter"><code>callback</code></em> . </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td> </tr> <tr> <td class="parameter_name"><p>notify</p></td> <td class="parameter_description"><p>function to be called when removing the action</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="cally-actor-add-action-full.returns"></a><h4>Returns</h4> <p> added action id, or -1 if failure</p> </div> <p class="since">Since: <a class="link" href="ix10.html#api-index-1.6">1.6</a></p> </div> <hr> <div class="refsect2"> <a name="cally-actor-remove-action"></a><h3>cally_actor_remove_action ()</h3> <pre class="programlisting"><span class="returnvalue">gboolean</span> cally_actor_remove_action (<em class="parameter"><code><a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a> *cally_actor</code></em>, <em class="parameter"><code><span class="type">gint</span> action_id</code></em>);</pre> <p>Removes a action, using the <em class="parameter"><code>action_id</code></em> returned by <a class="link" href="CallyActor.html#cally-actor-add-action" title="cally_actor_add_action ()"><code class="function">cally_actor_add_action()</code></a></p> <div class="refsect3"> <a name="cally-actor-remove-action.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" 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>cally_actor</p></td> <td class="parameter_description"><p>a <a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>action_id</p></td> <td class="parameter_description"><p>the action id</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="cally-actor-remove-action.returns"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the operation was succesful, <code class="literal">FALSE</code> otherwise</p> </div> <p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p> </div> <hr> <div class="refsect2"> <a name="cally-actor-remove-action-by-name"></a><h3>cally_actor_remove_action_by_name ()</h3> <pre class="programlisting"><span class="returnvalue">gboolean</span> cally_actor_remove_action_by_name (<em class="parameter"><code><a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a> *cally_actor</code></em>, <em class="parameter"><code>const <span class="type">gchar</span> *action_name</code></em>);</pre> <p>Removes an action, using the <em class="parameter"><code>action_name</code></em> used when the action was added with <a class="link" href="CallyActor.html#cally-actor-add-action" title="cally_actor_add_action ()"><code class="function">cally_actor_add_action()</code></a></p> <div class="refsect3"> <a name="cally-actor-remove-action-by-name.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" 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>cally_actor</p></td> <td class="parameter_description"><p>a <a class="link" href="CallyActor.html" title="CallyActor"><span class="type">CallyActor</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>action_name</p></td> <td class="parameter_description"><p>the name of the action to remove</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="cally-actor-remove-action-by-name.returns"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the operation was succesful, <code class="literal">FALSE</code> otherwise</p> </div> <p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p> </div> </div> <div class="refsect1"> <a name="CallyActor.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> <a name="CallyActor-struct"></a><h3>struct CallyActor</h3> <pre class="programlisting">struct CallyActor;</pre> <p>The <span class="structname">CallyActor</span> structure contains only private data and should be accessed using the provided API</p> <p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p> </div> <hr> <div class="refsect2"> <a name="CallyActorClass"></a><h3>struct CallyActorClass</h3> <pre class="programlisting">struct CallyActorClass { void (*notify_clutter) (GObject *object, GParamSpec *pspec); gboolean (*focus_clutter) (ClutterActor *actor, gpointer data); gint (*add_actor) (ClutterActor *container, ClutterActor *actor, gpointer data); gint (*remove_actor) (ClutterActor *container, ClutterActor *actor, gpointer data); }; </pre> <p>The <span class="structname">CallyActorClass</span> structure contains only private data</p> <div class="refsect3"> <a name="CallyActorClass.members"></a><h4>Members</h4> <div class="informaltable"><table class="informaltable" 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><em class="structfield"><code><a name="CallyActorClass.notify-clutter"></a>notify_clutter</code></em> ()</p></td> <td class="struct_member_description"><p>Signal handler for notify signal on Clutter actor</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="CallyActorClass.focus-clutter"></a>focus_clutter</code></em> ()</p></td> <td class="struct_member_description"><p>Signal handler for key-focus-in and key-focus-out signal on Clutter actor. This virtual functions is deprecated.</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="CallyActorClass.add-actor"></a>add_actor</code></em> ()</p></td> <td class="struct_member_description"><p>Signal handler for actor-added signal on ClutterContainer interface</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="CallyActorClass.remove-actor"></a>remove_actor</code></em> ()</p></td> <td class="struct_member_description"><p>Signal handler for actor-added signal on ClutterContainer interface</p></td> <td class="struct_member_annotations"> </td> </tr> </tbody> </table></div> </div> <p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p> </div> </div> <div class="refsect1"> <a name="CallyActor.see-also"></a><h2>See Also</h2> <p><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a></p> </div> </div> <div class="footer"> <hr>Generated by GTK-Doc V1.25.1</div> </body> </html>