Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterPropertyTransition: 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="ch09.html" title="Base classes">
<link rel="prev" href="ClutterTransition.html" title="ClutterTransition">
<link rel="next" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition">
<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="#ClutterPropertyTransition.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#ClutterPropertyTransition.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#ClutterPropertyTransition.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#ClutterPropertyTransition.properties" class="shortcut">Properties</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="ch09.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterTransition.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterKeyframeTransition.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterPropertyTransition"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterPropertyTransition.top_of_page"></a>ClutterPropertyTransition</span></h2>
<p>ClutterPropertyTransition — Property transitions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterPropertyTransition.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">
<a class="link" href="ClutterTransition.html" title="ClutterTransition"><span class="returnvalue">ClutterTransition</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterPropertyTransition.html#clutter-property-transition-new" title="clutter_property_transition_new ()">clutter_property_transition_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterPropertyTransition.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterPropertyTransition.html#ClutterPropertyTransition--property-name" title="The “property-name” property">property-name</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterPropertyTransition.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"> </td>
<td class="function_name"><a class="link" href="ClutterPropertyTransition.html#ClutterPropertyTransition-struct" title="ClutterPropertyTransition">ClutterPropertyTransition</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterPropertyTransition.html#ClutterPropertyTransitionClass" title="struct ClutterPropertyTransitionClass">ClutterPropertyTransitionClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterPropertyTransition.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="ClutterTimeline.html" title="ClutterTimeline">ClutterTimeline</a>
        <span class="lineart">╰──</span> <a class="link" href="ClutterTransition.html" title="ClutterTransition">ClutterTransition</a>
            <span class="lineart">╰──</span> ClutterPropertyTransition
                <span class="lineart">╰──</span> <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition">ClutterKeyframeTransition</a>
</pre>
</div>
<div class="refsect1">
<a name="ClutterPropertyTransition.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterPropertyTransition implements
 <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
</div>
<div class="refsect1">
<a name="ClutterPropertyTransition.description"></a><h2>Description</h2>
<p><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
can be used to tween a property of a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> instance.</p>
<p><a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a> is available since Clutter 1.10</p>
</div>
<div class="refsect1">
<a name="ClutterPropertyTransition.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-property-transition-new"></a><h3>clutter_property_transition_new ()</h3>
<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>
<p>Creates a new <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a>.</p>
<div class="refsect3">
<a name="clutter-property-transition-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>property_name</p></td>
<td class="parameter_description"><p> a property of <em class="parameter"><code>animatable</code></em>
, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-property-transition-new.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a>.
Use <code class="function">g_object_unref()</code> when done. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-property-transition-set-property-name"></a><h3>clutter_property_transition_set_property_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_property_transition_set_property_name
                               (<em class="parameter"><code><a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a> *transition</code></em>,
                                <em class="parameter"><code>const <span class="type">char</span> *property_name</code></em>);</pre>
<p>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>
.</p>
<div class="refsect3">
<a name="clutter-property-transition-set-property-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>transition</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property_name</p></td>
<td class="parameter_description"><p> a property name. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-property-transition-get-property-name"></a><h3>clutter_property_transition_get_property_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
clutter_property_transition_get_property_name
                               (<em class="parameter"><code><a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a> *transition</code></em>);</pre>
<p>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>
property.</p>
<div class="refsect3">
<a name="clutter-property-transition-get-property-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>transition</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-property-transition-get-property-name.returns"></a><h4>Returns</h4>
<p> the name of the property being animated, or <code class="literal">NULL</code> if
none is set. The returned string is owned by the <em class="parameter"><code>transition</code></em>
and
it should not be freed.</p>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterPropertyTransition.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterPropertyTransition-struct"></a><h3>ClutterPropertyTransition</h3>
<pre class="programlisting">typedef struct _ClutterPropertyTransition ClutterPropertyTransition;</pre>
<p>The <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition"><span class="type">ClutterPropertyTransition</span></a> structure contains
private data and should only be accessed using the provided API.</p>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterPropertyTransitionClass"></a><h3>struct ClutterPropertyTransitionClass</h3>
<pre class="programlisting">struct ClutterPropertyTransitionClass {
};
</pre>
<p>The <a class="link" href="ClutterPropertyTransition.html#ClutterPropertyTransitionClass" title="struct ClutterPropertyTransitionClass"><span class="type">ClutterPropertyTransitionClass</span></a> structure
contains private data.</p>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterPropertyTransition.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterPropertyTransition--property-name"></a><h3>The <code class="literal">“property-name”</code> property</h3>
<pre class="programlisting">  “property-name”            <span class="type">gchar</span> *</pre>
<p>The name of the property of a <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable"><span class="type">ClutterAnimatable</span></a> to animate.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>