doc/reference/clutter/html/ClutterPropertyTransition.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>ClutterPropertyTransition</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="Clutter Reference Manual">
   8 <link rel="up" href="ch09.html" title="Base classes">
   9 <link rel="prev" href="ClutterAnimatable.html" title="ClutterAnimatable">
  10 <link rel="next" href="ch10.html" title="High Level API">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (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="ClutterAnimatable.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch09.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">Clutter Reference Manual</th>
  21 <td><a accesskey="n" href="ch10.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="#ClutterPropertyTransition.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterPropertyTransition.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterPropertyTransition.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterPropertyTransition.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#ClutterPropertyTransition.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="ClutterPropertyTransition"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="ClutterPropertyTransition.top_of_page"></a>ClutterPropertyTransition</span></h2>
  40 <p>ClutterPropertyTransition — Property transitions</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="ClutterPropertyTransition.synopsis"></a><h2>Synopsis</h2>
  46 <pre class="synopsis">                    <a class="link" href="ClutterPropertyTransition.html#ClutterPropertyTransition-struct" title="ClutterPropertyTransition">ClutterPropertyTransition</a>;
  47 struct              <a class="link" href="ClutterPropertyTransition.html#ClutterPropertyTransitionClass" title="struct ClutterPropertyTransitionClass">ClutterPropertyTransitionClass</a>;
  48 <a class="link" href="ClutterTransition.html" title="ClutterTransition"><span class="returnvalue">ClutterTransition</span></a> * <a class="link" href="ClutterPropertyTransition.html#clutter-property-transition-new" title="clutter_property_transition_new ()">clutter_property_transition_new</a>     (<em class="parameter"><code>const <span class="type">char</span> *property_name</code></em>);
  49 <span class="returnvalue">void</span>                <a class="link" href="ClutterPropertyTransition.html#clutter-property-transition-set-property-name" title="clutter_property_transition_set_property_name ()">clutter_property_transition_set_property_name</a>
  50                                                         (<em class="parameter"><code><a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a> *transition</code></em>,
  51                                                          <em class="parameter"><code>const <span class="type">char</span> *property_name</code></em>);
  52 const <span class="returnvalue">char</span> *        <a class="link" href="ClutterPropertyTransition.html#clutter-property-transition-get-property-name" title="clutter_property_transition_get_property_name ()">clutter_property_transition_get_property_name</a>
  53                                                         (<em class="parameter"><code><a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a> *transition</code></em>);
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="ClutterPropertyTransition.object-hierarchy"></a><h2>Object Hierarchy</h2>
  58 <pre class="synopsis">
  59   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  60    +----<a class="link" href="ClutterTimeline.html" title="ClutterTimeline">ClutterTimeline</a>
  61          +----<a class="link" href="ClutterTransition.html" title="ClutterTransition">ClutterTransition</a>
  62                +----ClutterPropertyTransition
  63 </pre>
  64 </div>
  65 <div class="refsect1">
  66 <a name="ClutterPropertyTransition.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  67 <p>
  68 ClutterPropertyTransition implements
  69  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
  70 </div>
  71 <div class="refsect1">
  72 <a name="ClutterPropertyTransition.properties"></a><h2>Properties</h2>
  73 <pre class="synopsis">
  74   "<a class="link" href="ClutterPropertyTransition.html#ClutterPropertyTransition--property-name" title='The "property-name" property'>property-name</a>"            <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  75 </pre>
  76 </div>
  77 <div class="refsect1">
  78 <a name="ClutterPropertyTransition.description"></a><h2>Description</h2>
  79 <p>
  80 <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a> is a specialized <a class="link" href="ClutterTransition.html" title="ClutterTransition"><span class="type">ClutterTransition</span></a> that
  81 can be used to tween a property of a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> instance.
  82 </p>
  83 <p>
  84 <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a> is available since Clutter 1.10
  85 </p>
  86 </div>
  87 <div class="refsect1">
  88 <a name="ClutterPropertyTransition.details"></a><h2>Details</h2>
  89 <div class="refsect2">
  90 <a name="ClutterPropertyTransition-struct"></a><h3>ClutterPropertyTransition</h3>
  91 <pre class="programlisting">typedef struct _ClutterPropertyTransition ClutterPropertyTransition;</pre>
  92 <p>
  93 The <span class="structname">ClutterPropertyTransition</span> structure contains
  94 private data and should only be accessed using the provided API.
  95 </p>
  96 <p class="since">Since 1.10</p>
  97 </div>
  98 <hr>
  99 <div class="refsect2">
 100 <a name="ClutterPropertyTransitionClass"></a><h3>struct ClutterPropertyTransitionClass</h3>
 101 <pre class="programlisting">struct ClutterPropertyTransitionClass {
 102 };
 103 </pre>
 104 <p>
 105 The <span class="structname">ClutterPropertyTransitionClass</span> structure
 106 contains private data.
 107 </p>
 108 <p class="since">Since 1.10</p>
 109 </div>
 110 <hr>
 111 <div class="refsect2">
 112 <a name="clutter-property-transition-new"></a><h3>clutter_property_transition_new ()</h3>
 113 <pre class="programlisting"><a class="link" href="ClutterTransition.html" title="ClutterTransition"><span class="returnvalue">ClutterTransition</span></a> * clutter_property_transition_new     (<em class="parameter"><code>const <span class="type">char</span> *property_name</code></em>);</pre>
 114 <p>
 115 Creates a new <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a>.
 116 </p>
 117 <div class="variablelist"><table border="0">
 118 <col align="left" valign="top">
 119 <tbody>
 120 <tr>
 121 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 122 <td>a property of <em class="parameter"><code>animatable</code></em>, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 123 </td>
 124 </tr>
 125 <tr>
 126 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 127 <td>the newly created <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a>.
 128 Use <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when done. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 129 </td>
 130 </tr>
 131 </tbody>
 132 </table></div>
 133 <p class="since">Since 1.10</p>
 134 </div>
 135 <hr>
 136 <div class="refsect2">
 137 <a name="clutter-property-transition-set-property-name"></a><h3>clutter_property_transition_set_property_name ()</h3>
 138 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_property_transition_set_property_name
 139                                                         (<em class="parameter"><code><a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a> *transition</code></em>,
 140                                                          <em class="parameter"><code>const <span class="type">char</span> *property_name</code></em>);</pre>
 141 <p>
 142 Sets the <a class="link" href="ClutterPropertyTransition.html#ClutterPropertyTransition--property-name" title='The "property-name" property'><span class="type">"property-name"</span></a> property of <em class="parameter"><code>transition</code></em>.
 143 </p>
 144 <div class="variablelist"><table border="0">
 145 <col align="left" valign="top">
 146 <tbody>
 147 <tr>
 148 <td><p><span class="term"><em class="parameter"><code>transition</code></em> :</span></p></td>
 149 <td>a <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a>
 150 </td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 154 <td>a property name. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 155 </td>
 156 </tr>
 157 </tbody>
 158 </table></div>
 159 <p class="since">Since 1.10</p>
 160 </div>
 161 <hr>
 162 <div class="refsect2">
 163 <a name="clutter-property-transition-get-property-name"></a><h3>clutter_property_transition_get_property_name ()</h3>
 164 <pre class="programlisting">const <span class="returnvalue">char</span> *        clutter_property_transition_get_property_name
 165                                                         (<em class="parameter"><code><a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a> *transition</code></em>);</pre>
 166 <p>
 167 Retrieves the value of the <a class="link" href="ClutterPropertyTransition.html#ClutterPropertyTransition--property-name" title='The "property-name" property'><span class="type">"property-name"</span></a>
 168 property.
 169 </p>
 170 <div class="variablelist"><table border="0">
 171 <col align="left" valign="top">
 172 <tbody>
 173 <tr>
 174 <td><p><span class="term"><em class="parameter"><code>transition</code></em> :</span></p></td>
 175 <td>a <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a>
 176 </td>
 177 </tr>
 178 <tr>
 179 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 180 <td>the name of the property being animated, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if
 181 none is set. The returned string is owned by the <em class="parameter"><code>transition</code></em> and
 182 it should not be freed.</td>
 183 </tr>
 184 </tbody>
 185 </table></div>
 186 <p class="since">Since 1.10</p>
 187 </div>
 188 </div>
 189 <div class="refsect1">
 190 <a name="ClutterPropertyTransition.property-details"></a><h2>Property Details</h2>
 191 <div class="refsect2">
 192 <a name="ClutterPropertyTransition--property-name"></a><h3>The <code class="literal">"property-name"</code> property</h3>
 193 <pre class="programlisting">  "property-name"            <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 194 <p>
 195 The name of the property of a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> to animate.
 196 </p>
 197 <p>Default value: NULL</p>
 198 <p class="since">Since 1.10</p>
 199 </div>
 200 </div>
 201 </div>
 202 <div class="footer">
 203 <hr>
 204           Generated by GTK-Doc V1.18.1</div>
 205 </body>
 206 </html>