source-git / clutter

Clone
Source Code
GIT

Files

  1.   bf98b9a5819c4cb2367a5f461cd42129062beafd
  2.   doc
  3.   reference
  4.   html
  5.   ClutterScrollActor.html
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>ClutterScrollActor: 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="ch02.html" title="Base actors">
<link rel="prev" href="ClutterText.html" title="ClutterText">
<link rel="next" href="ch03.html" title="Layout managers">
<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="#ClutterScrollActor.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#ClutterScrollActor.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#ClutterScrollActor.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#ClutterScrollActor.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterText.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch03.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterScrollActor"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterScrollActor.top_of_page"></a>ClutterScrollActor</span></h2>
<p>ClutterScrollActor — An actor for displaying a portion of its children</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterScrollActor.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="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterScrollActor.html#clutter-scroll-actor-new" title="clutter_scroll_actor_new ()">clutter_scroll_actor_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="ClutterScrollActor.html#clutter-scroll-actor-set-scroll-mode" title="clutter_scroll_actor_set_scroll_mode ()">clutter_scroll_actor_set_scroll_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode"><span class="returnvalue">ClutterScrollMode</span></a>
</td>
<td class="function_name">
<a class="link" href="ClutterScrollActor.html#clutter-scroll-actor-get-scroll-mode" title="clutter_scroll_actor_get_scroll_mode ()">clutter_scroll_actor_get_scroll_mode</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="ClutterScrollActor.html#clutter-scroll-actor-scroll-to-point" title="clutter_scroll_actor_scroll_to_point ()">clutter_scroll_actor_scroll_to_point</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="ClutterScrollActor.html#clutter-scroll-actor-scroll-to-rect" title="clutter_scroll_actor_scroll_to_rect ()">clutter_scroll_actor_scroll_to_rect</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterScrollActor.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"><a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode"><span class="type">ClutterScrollMode</span></a></td>
<td class="property_name"><a class="link" href="ClutterScrollActor.html#ClutterScrollActor--scroll-mode" title="The “scroll-mode” property">scroll-mode</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterScrollActor.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="ClutterScrollActor.html#ClutterScrollActor-struct" title="ClutterScrollActor">ClutterScrollActor</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterScrollActor.html#ClutterScrollActorClass" title="struct ClutterScrollActorClass">ClutterScrollActorClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode">ClutterScrollMode</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterScrollActor.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
            <span class="lineart">╰──</span> ClutterScrollActor
</pre>
</div>
<div class="refsect1">
<a name="ClutterScrollActor.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterScrollActor implements
 <a class="link" href="ClutterContainer.html" title="ClutterContainer">ClutterContainer</a>,  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>,  <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable">ClutterAnimatable</a> and  AtkImplementorIface.</p>
</div>
<div class="refsect1">
<a name="ClutterScrollActor.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> is an actor that can be used to display a portion
of the contents of its children.</p>
<p>The extent of the area of a <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> is defined by the size
of its children; the visible region of the children of a <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a>
is set by using <a class="link" href="ClutterScrollActor.html#clutter-scroll-actor-scroll-to-point" title="clutter_scroll_actor_scroll_to_point ()"><code class="function">clutter_scroll_actor_scroll_to_point()</code></a> or by using
<a class="link" href="ClutterScrollActor.html#clutter-scroll-actor-scroll-to-rect" title="clutter_scroll_actor_scroll_to_rect ()"><code class="function">clutter_scroll_actor_scroll_to_rect()</code></a> to define a point or a rectangle
acting as the origin, respectively.</p>
<p><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> does not provide pointer or keyboard event handling,
nor does it provide visible scroll handles.</p>
<p>See <a class="ulink" href="https://git.gnome.org/browse/clutter/tree/examples/scroll-actor.c?h=clutter-1.18" target="_top">scroll-actor.c</a>
for an example of how to use <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a>.</p>
<p><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> is available since Clutter 1.12.</p>
</div>
<div class="refsect1">
<a name="ClutterScrollActor.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-scroll-actor-new"></a><h3>clutter_scroll_actor_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_scroll_actor_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a>.</p>
<div class="refsect3">
<a name="clutter-scroll-actor-new.returns"></a><h4>Returns</h4>
<p> The newly created <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a>
instance.</p>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-scroll-actor-set-scroll-mode"></a><h3>clutter_scroll_actor_set_scroll_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_scroll_actor_set_scroll_mode (<em class="parameter"><code><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> *actor</code></em>,
                                      <em class="parameter"><code><a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode"><span class="type">ClutterScrollMode</span></a> mode</code></em>);</pre>
<p>Sets the <a class="link" href="ClutterScrollActor.html#ClutterScrollActor--scroll-mode" title="The “scroll-mode” property"><span class="type">“scroll-mode”</span></a> property.</p>
<div class="refsect3">
<a name="clutter-scroll-actor-set-scroll-mode.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="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode"><span class="type">ClutterScrollMode</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-scroll-actor-get-scroll-mode"></a><h3>clutter_scroll_actor_get_scroll_mode ()</h3>
<pre class="programlisting"><a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode"><span class="returnvalue">ClutterScrollMode</span></a>
clutter_scroll_actor_get_scroll_mode (<em class="parameter"><code><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> *actor</code></em>);</pre>
<p>Retrieves the <a class="link" href="ClutterScrollActor.html#ClutterScrollActor--scroll-mode" title="The “scroll-mode” property"><span class="type">“scroll-mode”</span></a> property</p>
<div class="refsect3">
<a name="clutter-scroll-actor-get-scroll-mode.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="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-scroll-actor-get-scroll-mode.returns"></a><h4>Returns</h4>
<p> the scrolling mode</p>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-scroll-actor-scroll-to-point"></a><h3>clutter_scroll_actor_scroll_to_point ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_scroll_actor_scroll_to_point (<em class="parameter"><code><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> *actor</code></em>,
                                      <em class="parameter"><code>const <a class="link" href="clutter-Base-geometric-types.html#ClutterPoint"><span class="type">ClutterPoint</span></a> *point</code></em>);</pre>
<p>Scrolls the contents of <em class="parameter"><code>actor</code></em>
 so that <em class="parameter"><code>point</code></em>
 is the new origin
of the visible area.</p>
<p>The coordinates of <em class="parameter"><code>point</code></em>
 must be relative to the <em class="parameter"><code>actor</code></em>
.</p>
<p>This function will use the currently set easing state of the <em class="parameter"><code>actor</code></em>

to transition from the current scroll origin to the new one.</p>
<div class="refsect3">
<a name="clutter-scroll-actor-scroll-to-point.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="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>point</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-Base-geometric-types.html#ClutterPoint"><span class="type">ClutterPoint</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-scroll-actor-scroll-to-rect"></a><h3>clutter_scroll_actor_scroll_to_rect ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_scroll_actor_scroll_to_rect (<em class="parameter"><code><a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> *actor</code></em>,
                                     <em class="parameter"><code>const <a class="link" href="clutter-Base-geometric-types.html#ClutterRect"><span class="type">ClutterRect</span></a> *rect</code></em>);</pre>
<p>Scrolls <em class="parameter"><code>actor</code></em>
 so that <em class="parameter"><code>rect</code></em>
 is in the visible portion.</p>
<div class="refsect3">
<a name="clutter-scroll-actor-scroll-to-rect.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="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rect</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-Base-geometric-types.html#ClutterRect"><span class="type">ClutterRect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterScrollActor.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterScrollActor-struct"></a><h3>ClutterScrollActor</h3>
<pre class="programlisting">typedef struct _ClutterScrollActor ClutterScrollActor;</pre>
<p>The <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> structure contains only
private data, and should be accessed using the provided API.</p>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterScrollActorClass"></a><h3>struct ClutterScrollActorClass</h3>
<pre class="programlisting">struct ClutterScrollActorClass {
};
</pre>
<p>The <a class="link" href="ClutterScrollActor.html" title="ClutterScrollActor"><span class="type">ClutterScrollActor</span></a> structure contains only
private data.</p>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterScrollMode"></a><h3>enum ClutterScrollMode</h3>
<p>Scroll modes.</p>
<div class="refsect3">
<a name="ClutterScrollMode.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-SCROLL-NONE:CAPS"></a>CLUTTER_SCROLL_NONE</p></td>
<td class="enum_member_description">
<p>Ignore scrolling</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-SCROLL-HORIZONTALLY:CAPS"></a>CLUTTER_SCROLL_HORIZONTALLY</p></td>
<td class="enum_member_description">
<p>Scroll only horizontally</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-SCROLL-VERTICALLY:CAPS"></a>CLUTTER_SCROLL_VERTICALLY</p></td>
<td class="enum_member_description">
<p>Scroll only vertically</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-SCROLL-BOTH:CAPS"></a>CLUTTER_SCROLL_BOTH</p></td>
<td class="enum_member_description">
<p>Scroll in both directions</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterScrollActor.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterScrollActor--scroll-mode"></a><h3>The <code class="literal">“scroll-mode”</code> property</h3>
<pre class="programlisting">  “scroll-mode”              <a class="link" href="ClutterScrollActor.html#ClutterScrollMode" title="enum ClutterScrollMode"><span class="type">ClutterScrollMode</span></a></pre>
<p>The scrollin direction.</p>
<p>Flags: Read / Write</p>
<p>Default value: CLUTTER_SCROLL_HORIZONTALLY | CLUTTER_SCROLL_VERTICALLY</p>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>

Powered by Pagure 5.13.3

SSH Hostkey/Fingerprint | Documentation