File: qanimationgroup.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (179 lines) | stat: -rw-r--r-- 15,995 bytes parent folder | download 
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
 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qanimationgroup.cpp -->
  <title>Qt 4.8: QAnimationGroup Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtcore.html">QtCore</a></li>
<li>QAnimationGroup</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QAnimationGroup Class Reference</h1>
<!-- $$$QAnimationGroup-brief -->
<p>The QAnimationGroup class is an abstract base class for groups of animations. <a href="#details">More...</a></p>
<!-- @@@QAnimationGroup -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QAnimationGroup&gt;</span></pre><p><b>Inherits: </b><a href="qabstractanimation.html">QAbstractAnimation</a>.</p>
<p><b>Inherited by: </b><a href="qparallelanimationgroup.html">QParallelAnimationGroup</a> and <a href="qsequentialanimationgroup.html">QSequentialAnimationGroup</a>.</p>
<p>This class was introduced in Qt 4.6.</p>
<ul>
<li><a href="qanimationgroup-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qanimationgroup.html#QAnimationGroup">QAnimationGroup</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qanimationgroup.html#dtor.QAnimationGroup">~QAnimationGroup</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qanimationgroup.html#addAnimation">addAnimation</a></b> ( QAbstractAnimation * <i>animation</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QAbstractAnimation * </td><td class="memItemRight bottomAlign"><b><a href="qanimationgroup.html#animationAt">animationAt</a></b> ( int <i>index</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qanimationgroup.html#animationCount">animationCount</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qanimationgroup.html#clear">clear</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qanimationgroup.html#indexOfAnimation">indexOfAnimation</a></b> ( QAbstractAnimation * <i>animation</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qanimationgroup.html#insertAnimation">insertAnimation</a></b> ( int <i>index</i>, QAbstractAnimation * <i>animation</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qanimationgroup.html#removeAnimation">removeAnimation</a></b> ( QAbstractAnimation * <i>animation</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QAbstractAnimation * </td><td class="memItemRight bottomAlign"><b><a href="qanimationgroup.html#takeAnimation">takeAnimation</a></b> ( int <i>index</i> )</td></tr>
</table>
<ul>
<li class="fn">11 public functions inherited from <a href="qabstractanimation.html#public-functions">QAbstractAnimation</a></li>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<a name="reimplemented-protected-functions"></a>
<h2>Reimplemented Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qanimationgroup.html#event">event</a></b> ( QEvent * <i>event</i> )</td></tr>
</table>
<ul>
<li class="fn">4 protected functions inherited from <a href="qabstractanimation.html#protected-functions">QAbstractAnimation</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">6 properties inherited from <a href="qabstractanimation.html#properties">QAbstractAnimation</a></li>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
<li class="fn">6 public slots inherited from <a href="qabstractanimation.html#public-slots">QAbstractAnimation</a></li>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
<li class="fn">4 signals inherited from <a href="qabstractanimation.html#signals">QAbstractAnimation</a></li>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li class="fn">4 protected functions inherited from <a href="qabstractanimation.html#protected-functions">QAbstractAnimation</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAnimationGroup-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QAnimationGroup class is an abstract base class for groups of animations.</p>
<p>An animation group is a container for animations (subclasses of <a href="qabstractanimation.html">QAbstractAnimation</a>). A group is usually responsible for managing the <a href="qabstractanimation.html#State-enum">state</a> of its animations, i.e&#x2e;, it decides when to start, stop, resume, and pause them. Currently, Qt provides two such groups: <a href="qparallelanimationgroup.html">QParallelAnimationGroup</a> and <a href="qsequentialanimationgroup.html">QSequentialAnimationGroup</a>. Look up their class descriptions for details.</p>
<p>Since QAnimationGroup inherits from <a href="qabstractanimation.html">QAbstractAnimation</a>, you can combine groups, and easily construct complex animation graphs. You can query <a href="qabstractanimation.html">QAbstractAnimation</a> for the group it belongs to (using the <a href="qabstractanimation.html#group">group()</a> function).</p>
<p>To start a top-level animation group, you simply use the <a href="qabstractanimation.html#start">start()</a> function from <a href="qabstractanimation.html">QAbstractAnimation</a>. By a top-level animation group, we think of a group that itself is not contained within another group. Starting sub groups directly is not supported, and may lead to unexpected behavior.</p>
<p>QAnimationGroup provides methods for adding and retrieving animations. Besides that, you can remove animations by calling remove(), and clear the animation group by calling <a href="qanimationgroup.html#clear">clear</a>(). You may keep track of changes in the group's animations by listening to <a href="qevent.html#Type-enum">QEvent::ChildAdded</a> and <a href="qevent.html#Type-enum">QEvent::ChildRemoved</a> events.</p>
<p>QAnimationGroup takes ownership of the animations it manages, and ensures that they are deleted when the animation group is deleted.</p>
</div>
<p><b>See also </b><a href="qabstractanimation.html">QAbstractAnimation</a>, <a href="qvariantanimation.html">QVariantAnimation</a>, and <a href="animation-overview.html">The Animation Framework</a>.</p>
<!-- @@@QAnimationGroup -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAnimationGroup[overload1]$$$QAnimationGroupQObject* -->
<h3 class="fn"><a name="QAnimationGroup"></a>QAnimationGroup::<span class="name">QAnimationGroup</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs a <a href="qanimationgroup.html">QAnimationGroup</a>. <i>parent</i> is passed to <a href="qobject.html">QObject</a>'s constructor.</p>
<!-- @@@QAnimationGroup -->
<!-- $$$~QAnimationGroup[overload1]$$$~QAnimationGroup -->
<h3 class="fn"><a name="dtor.QAnimationGroup"></a>QAnimationGroup::<span class="name">~QAnimationGroup</span> ()</h3>
<p>Destroys the animation group. It will also destroy all its animations.</p>
<!-- @@@~QAnimationGroup -->
<!-- $$$addAnimation[overload1]$$$addAnimationQAbstractAnimation* -->
<h3 class="fn"><a name="addAnimation"></a><span class="type">void</span> QAnimationGroup::<span class="name">addAnimation</span> ( <span class="type"><a href="qabstractanimation.html">QAbstractAnimation</a></span> * <i>animation</i> )</h3>
<p>Adds <i>animation</i> to this group. This will call insertAnimation with index equals to <a href="qanimationgroup.html#animationCount">animationCount</a>().</p>
<p><b>Note:</b> The group takes ownership of the animation.</p>
<p><b>See also </b><a href="qanimationgroup.html#removeAnimation">removeAnimation</a>().</p>
<!-- @@@addAnimation -->
<!-- $$$animationAt[overload1]$$$animationAtint -->
<h3 class="fn"><a name="animationAt"></a><span class="type"><a href="qabstractanimation.html">QAbstractAnimation</a></span> * QAnimationGroup::<span class="name">animationAt</span> ( <span class="type">int</span> <i>index</i> ) const</h3>
<p>Returns a pointer to the animation at <i>index</i> in this group. This function is useful when you need access to a particular animation. <i>index</i> is between 0 and <a href="qanimationgroup.html#animationCount">animationCount</a>() - 1.</p>
<p><b>See also </b><a href="qanimationgroup.html#animationCount">animationCount</a>() and <a href="qanimationgroup.html#indexOfAnimation">indexOfAnimation</a>().</p>
<!-- @@@animationAt -->
<!-- $$$animationCount[overload1]$$$animationCount -->
<h3 class="fn"><a name="animationCount"></a><span class="type">int</span> QAnimationGroup::<span class="name">animationCount</span> () const</h3>
<p>Returns the number of animations managed by this group.</p>
<p><b>See also </b><a href="qanimationgroup.html#indexOfAnimation">indexOfAnimation</a>(), <a href="qanimationgroup.html#addAnimation">addAnimation</a>(), and <a href="qanimationgroup.html#animationAt">animationAt</a>().</p>
<!-- @@@animationCount -->
<!-- $$$clear[overload1]$$$clear -->
<h3 class="fn"><a name="clear"></a><span class="type">void</span> QAnimationGroup::<span class="name">clear</span> ()</h3>
<p>Removes and deletes all animations in this animation group, and resets the current time to 0.</p>
<p><b>See also </b><a href="qanimationgroup.html#addAnimation">addAnimation</a>() and <a href="qanimationgroup.html#removeAnimation">removeAnimation</a>().</p>
<!-- @@@clear -->
<!-- $$$event[overload1]$$$eventQEvent* -->
<h3 class="fn"><a name="event"></a><span class="type">bool</span> QAnimationGroup::<span class="name">event</span> ( <span class="type"><a href="qevent.html">QEvent</a></span> * <i>event</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qobject.html#event">QObject::event</a>().</p>
<!-- @@@event -->
<!-- $$$indexOfAnimation[overload1]$$$indexOfAnimationQAbstractAnimation* -->
<h3 class="fn"><a name="indexOfAnimation"></a><span class="type">int</span> QAnimationGroup::<span class="name">indexOfAnimation</span> ( <span class="type"><a href="qabstractanimation.html">QAbstractAnimation</a></span> * <i>animation</i> ) const</h3>
<p>Returns the index of <i>animation</i>. The returned index can be passed to the other functions that take an index as an argument.</p>
<p><b>See also </b><a href="qanimationgroup.html#insertAnimation">insertAnimation</a>(), <a href="qanimationgroup.html#animationAt">animationAt</a>(), and <a href="qanimationgroup.html#takeAnimation">takeAnimation</a>().</p>
<!-- @@@indexOfAnimation -->
<!-- $$$insertAnimation[overload1]$$$insertAnimationintQAbstractAnimation* -->
<h3 class="fn"><a name="insertAnimation"></a><span class="type">void</span> QAnimationGroup::<span class="name">insertAnimation</span> ( <span class="type">int</span> <i>index</i>, <span class="type"><a href="qabstractanimation.html">QAbstractAnimation</a></span> * <i>animation</i> )</h3>
<p>Inserts <i>animation</i> into this animation group at <i>index</i>. If <i>index</i> is 0 the animation is inserted at the beginning. If <i>index</i> is <a href="qanimationgroup.html#animationCount">animationCount</a>(), the animation is inserted at the end.</p>
<p><b>Note:</b> The group takes ownership of the animation.</p>
<p><b>See also </b><a href="qanimationgroup.html#takeAnimation">takeAnimation</a>(), <a href="qanimationgroup.html#addAnimation">addAnimation</a>(), <a href="qanimationgroup.html#indexOfAnimation">indexOfAnimation</a>(), and <a href="qanimationgroup.html#removeAnimation">removeAnimation</a>().</p>
<!-- @@@insertAnimation -->
<!-- $$$removeAnimation[overload1]$$$removeAnimationQAbstractAnimation* -->
<h3 class="fn"><a name="removeAnimation"></a><span class="type">void</span> QAnimationGroup::<span class="name">removeAnimation</span> ( <span class="type"><a href="qabstractanimation.html">QAbstractAnimation</a></span> * <i>animation</i> )</h3>
<p>Removes <i>animation</i> from this group. The ownership of <i>animation</i> is transferred to the caller.</p>
<p><b>See also </b><a href="qanimationgroup.html#takeAnimation">takeAnimation</a>(), <a href="qanimationgroup.html#insertAnimation">insertAnimation</a>(), and <a href="qanimationgroup.html#addAnimation">addAnimation</a>().</p>
<!-- @@@removeAnimation -->
<!-- $$$takeAnimation[overload1]$$$takeAnimationint -->
<h3 class="fn"><a name="takeAnimation"></a><span class="type"><a href="qabstractanimation.html">QAbstractAnimation</a></span> * QAnimationGroup::<span class="name">takeAnimation</span> ( <span class="type">int</span> <i>index</i> )</h3>
<p>Returns the animation at <i>index</i> and removes it from the animation group.</p>
<p><b>Note:</b> The ownership of the animation is transferred to the caller.</p>
<p><b>See also </b><a href="qanimationgroup.html#removeAnimation">removeAnimation</a>(), <a href="qanimationgroup.html#addAnimation">addAnimation</a>(), <a href="qanimationgroup.html#insertAnimation">insertAnimation</a>(), and <a href="qanimationgroup.html#indexOfAnimation">indexOfAnimation</a>().</p>
<!-- @@@takeAnimation -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation and/or its
      subsidiaries. Documentation contributions included herein are the copyrights of
      their respective owners.</p>
    <br />
    <p>
      The documentation provided herein is licensed under the terms of the
      <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
      License version 1.3</a> as published by the Free Software Foundation.</p>
    <p>
      Documentation sources may be obtained from <a href="http://www.qt-project.org">
      www.qt-project.org</a>.</p>
    <br />
    <p>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      in Finland and/or other countries worldwide. All other trademarks are property
      of their respective owners. <a title="Privacy Policy"
      href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>