← Back to branch summary

~ubuntu-branches/ubuntu/precise/evince/precise-updates

« back to all changes in this revision

Viewing changes to help/reference/libdocument/html/libevdocument-ev-transition-effect.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2009-02-10 15:24:04 UTC
  • mto: (1.6.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 72.
  • Revision ID: james.westby@ubuntu.com-20090210152404-9el29bkm4unsnj6n
Tags: upstream-2.25.90
Import upstream version 2.25.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
help/reference/libdocument/html/libevdocument-ev-transition-effect.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>ev-transition-effect</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
7
<link rel="home" href="index.html" title="libevdocument Reference Manual">
 
8
<link rel="up" href="data.html" title="Part II. Document data">
 
9
<link rel="prev" href="EvPage.html" title="EvPage">
 
10
<link rel="next" href="helper.html" title="Part III. Helper functions">
 
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="part" href="interfaces.html" title="Part I. Document Interfaces">
 
14
<link rel="part" href="data.html" title="Part II. Document data">
 
15
<link rel="part" href="helper.html" title="Part III. Helper functions">
 
16
</head>
 
17
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
18
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
19
<tr valign="middle">
 
20
<td><a accesskey="p" href="EvPage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
21
<td><a accesskey="u" href="data.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
23
<th width="100%" align="center">libevdocument Reference Manual</th>
 
24
<td><a accesskey="n" href="helper.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
25
</tr>
 
26
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libevdocument-ev-transition-effect.synopsis" class="shortcut">Top</a>
 
27
                   | 
 
28
                  <a href="#libevdocument-ev-transition-effect.description" class="shortcut">Description</a>
 
29
                   | 
 
30
                  <a href="#libevdocument-ev-transition-effect.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
31
                   | 
 
32
                  <a href="#libevdocument-ev-transition-effect.properties" class="shortcut">Properties</a></nobr></td></tr>
 
33
</table>
 
34
<div class="refentry" lang="en">
 
35
<a name="libevdocument-ev-transition-effect"></a><div class="titlepage"></div>
 
36
<div class="refnamediv"><table width="100%"><tr>
 
37
<td valign="top">
 
38
<h2><span class="refentrytitle"><a name="libevdocument-ev-transition-effect.top_of_page"></a>ev-transition-effect</span></h2>
 
39
<p>ev-transition-effect</p>
 
40
</td>
 
41
<td valign="top" align="right"></td>
 
42
</tr></table></div>
 
43
<div class="refsynopsisdiv">
 
44
<a name="libevdocument-ev-transition-effect.synopsis"></a><h2>Synopsis</h2>
 
45
<a name="EvTransitionEffect"></a><pre class="synopsis">
 
46
enum                <a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffectType" title="enum EvTransitionEffectType">EvTransitionEffectType</a>;
 
47
enum                <a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffectAlignment" title="enum EvTransitionEffectAlignment">EvTransitionEffectAlignment</a>;
 
48
enum                <a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffectDirection" title="enum EvTransitionEffectDirection">EvTransitionEffectDirection</a>;
 
49
typedef             <a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffect">EvTransitionEffect</a>;
 
50
typedef             <a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffectClass" title="EvTransitionEffectClass">EvTransitionEffectClass</a>;
 
51
<a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffect">EvTransitionEffect</a>* <a class="link" href="libevdocument-ev-transition-effect.html#ev-transition-effect-new" title="ev_transition_effect_new ()">ev_transition_effect_new</a>            (<a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffectType" title="enum EvTransitionEffectType">EvTransitionEffectType</a> type,
 
52
                                                         const <a
 
53
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
54
>gchar</a> *first_property_name,
 
55
                                                         ...);
 
56
</pre>
 
57
</div>
 
58
<div class="refsect1" lang="en">
 
59
<a name="libevdocument-ev-transition-effect.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
60
<pre class="synopsis">
 
61
  <a
 
62
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
63
>GObject</a>
 
64
   +----EvTransitionEffect
 
65
</pre>
 
66
</div>
 
67
<div class="refsect1" lang="en">
 
68
<a name="libevdocument-ev-transition-effect.properties"></a><h2>Properties</h2>
 
69
<pre class="synopsis">
 
70
  "<a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffect--alignment" title='The "alignment" property'>alignment</a>"                <a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffectAlignment" title="enum EvTransitionEffectAlignment">EvTransitionEffectAlignment</a>  : Read / Write
 
71
  "<a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffect--angle" title='The "angle" property'>angle</a>"                    <a
 
72
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
73
>gint</a>                  : Read / Write
 
74
  "<a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffect--direction" title='The "direction" property'>direction</a>"                <a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffectDirection" title="enum EvTransitionEffectDirection">EvTransitionEffectDirection</a>  : Read / Write
 
75
  "<a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffect--duration" title='The "duration" property'>duration</a>"                 <a
 
76
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
77
>gint</a>                  : Read / Write
 
78
  "<a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffect--rectangular" title='The "rectangular" property'>rectangular</a>"              <a
 
79
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
80
>gboolean</a>              : Read / Write
 
81
  "<a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffect--scale" title='The "scale" property'>scale</a>"                    <a
 
82
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
 
83
>gdouble</a>               : Read / Write
 
84
  "<a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffect--type" title='The "type" property'>type</a>"                     <a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffectType" title="enum EvTransitionEffectType">EvTransitionEffectType</a>  : Read / Write
 
85
</pre>
 
86
</div>
 
87
<div class="refsect1" lang="en">
 
88
<a name="libevdocument-ev-transition-effect.description"></a><h2>Description</h2>
 
89
<p>
 
90
 
 
91
</p>
 
92
</div>
 
93
<div class="refsect1" lang="en">
 
94
<a name="libevdocument-ev-transition-effect.details"></a><h2>Details</h2>
 
95
<div class="refsect2" lang="en">
 
96
<a name="EvTransitionEffectType"></a><h3>enum EvTransitionEffectType</h3>
 
97
<pre class="programlisting">typedef enum {
 
98
        EV_TRANSITION_EFFECT_REPLACE,
 
99
        EV_TRANSITION_EFFECT_SPLIT,
 
100
        EV_TRANSITION_EFFECT_BLINDS,
 
101
        EV_TRANSITION_EFFECT_BOX,
 
102
        EV_TRANSITION_EFFECT_WIPE,
 
103
        EV_TRANSITION_EFFECT_DISSOLVE,
 
104
        EV_TRANSITION_EFFECT_GLITTER,
 
105
        EV_TRANSITION_EFFECT_FLY,
 
106
        EV_TRANSITION_EFFECT_PUSH,
 
107
        EV_TRANSITION_EFFECT_COVER,
 
108
        EV_TRANSITION_EFFECT_UNCOVER,
 
109
        EV_TRANSITION_EFFECT_FADE
 
110
} EvTransitionEffectType;
 
111
</pre>
 
112
<p>
 
113
 
 
114
</p>
 
115
</div>
 
116
<hr>
 
117
<div class="refsect2" lang="en">
 
118
<a name="EvTransitionEffectAlignment"></a><h3>enum EvTransitionEffectAlignment</h3>
 
119
<pre class="programlisting">typedef enum {
 
120
        EV_TRANSITION_ALIGNMENT_HORIZONTAL,
 
121
        EV_TRANSITION_ALIGNMENT_VERTICAL
 
122
} EvTransitionEffectAlignment;
 
123
</pre>
 
124
<p>
 
125
 
 
126
</p>
 
127
</div>
 
128
<hr>
 
129
<div class="refsect2" lang="en">
 
130
<a name="EvTransitionEffectDirection"></a><h3>enum EvTransitionEffectDirection</h3>
 
131
<pre class="programlisting">typedef enum {
 
132
        EV_TRANSITION_DIRECTION_INWARD,
 
133
        EV_TRANSITION_DIRECTION_OUTWARD
 
134
} EvTransitionEffectDirection;
 
135
</pre>
 
136
<p>
 
137
 
 
138
</p>
 
139
</div>
 
140
<hr>
 
141
<div class="refsect2" lang="en">
 
142
<a name="EvTransitionEffect"></a><h3>EvTransitionEffect</h3>
 
143
<pre class="programlisting">typedef struct EvTransitionEffect      EvTransitionEffect;
 
144
</pre>
 
145
<p>
 
146
 
 
147
</p>
 
148
</div>
 
149
<hr>
 
150
<div class="refsect2" lang="en">
 
151
<a name="EvTransitionEffectClass"></a><h3>EvTransitionEffectClass</h3>
 
152
<pre class="programlisting">typedef struct EvTransitionEffectClass EvTransitionEffectClass;
 
153
</pre>
 
154
<p>
 
155
 
 
156
</p>
 
157
</div>
 
158
<hr>
 
159
<div class="refsect2" lang="en">
 
160
<a name="ev-transition-effect-new"></a><h3>ev_transition_effect_new ()</h3>
 
161
<pre class="programlisting"><a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffect">EvTransitionEffect</a>* ev_transition_effect_new            (<a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffectType" title="enum EvTransitionEffectType">EvTransitionEffectType</a> type,
 
162
                                                         const <a
 
163
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
164
>gchar</a> *first_property_name,
 
165
                                                         ...);</pre>
 
166
<p>
 
167
 
 
168
</p>
 
169
<div class="variablelist"><table border="0">
 
170
<col align="left" valign="top">
 
171
<tbody>
 
172
<tr>
 
173
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 
174
<td>
 
175
</td>
 
176
</tr>
 
177
<tr>
 
178
<td><p><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></p></td>
 
179
<td>
 
180
</td>
 
181
</tr>
 
182
<tr>
 
183
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 
184
<td>
 
185
</td>
 
186
</tr>
 
187
<tr>
 
188
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
189
<td>
 
190
 
 
191
 
 
192
</td>
 
193
</tr>
 
194
</tbody>
 
195
</table></div>
 
196
</div>
 
197
</div>
 
198
<div class="refsect1" lang="en">
 
199
<a name="libevdocument-ev-transition-effect.property-details"></a><h2>Property Details</h2>
 
200
<div class="refsect2" lang="en">
 
201
<a name="EvTransitionEffect--alignment"></a><h3>The <code class="literal">"alignment"</code> property</h3>
 
202
<pre class="programlisting">  "alignment"                <a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffectAlignment" title="enum EvTransitionEffectAlignment">EvTransitionEffectAlignment</a>  : Read / Write</pre>
 
203
<p>Alignment for the effect.</p>
 
204
<p>Default value: EV_TRANSITION_ALIGNMENT_HORIZONTAL</p>
 
205
</div>
 
206
<hr>
 
207
<div class="refsect2" lang="en">
 
208
<a name="EvTransitionEffect--angle"></a><h3>The <code class="literal">"angle"</code> property</h3>
 
209
<pre class="programlisting">  "angle"                    <a
 
210
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
211
>gint</a>                  : Read / Write</pre>
 
212
<p>Effect angle in degrees, counted counterclockwise from left to right.</p>
 
213
<p>Allowed values: [0,360]</p>
 
214
<p>Default value: 0</p>
 
215
</div>
 
216
<hr>
 
217
<div class="refsect2" lang="en">
 
218
<a name="EvTransitionEffect--direction"></a><h3>The <code class="literal">"direction"</code> property</h3>
 
219
<pre class="programlisting">  "direction"                <a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffectDirection" title="enum EvTransitionEffectDirection">EvTransitionEffectDirection</a>  : Read / Write</pre>
 
220
<p>Direction for the effect.</p>
 
221
<p>Default value: EV_TRANSITION_DIRECTION_INWARD</p>
 
222
</div>
 
223
<hr>
 
224
<div class="refsect2" lang="en">
 
225
<a name="EvTransitionEffect--duration"></a><h3>The <code class="literal">"duration"</code> property</h3>
 
226
<pre class="programlisting">  "duration"                 <a
 
227
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
228
>gint</a>                  : Read / Write</pre>
 
229
<p>Effect duration in seconds.</p>
 
230
<p>Allowed values: &gt;= 0</p>
 
231
<p>Default value: 0</p>
 
232
</div>
 
233
<hr>
 
234
<div class="refsect2" lang="en">
 
235
<a name="EvTransitionEffect--rectangular"></a><h3>The <code class="literal">"rectangular"</code> property</h3>
 
236
<pre class="programlisting">  "rectangular"              <a
 
237
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
238
>gboolean</a>              : Read / Write</pre>
 
239
<p>Whether the covered area is rectangular.</p>
 
240
<p>Default value: FALSE</p>
 
241
</div>
 
242
<hr>
 
243
<div class="refsect2" lang="en">
 
244
<a name="EvTransitionEffect--scale"></a><h3>The <code class="literal">"scale"</code> property</h3>
 
245
<pre class="programlisting">  "scale"                    <a
 
246
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
 
247
>gdouble</a>               : Read / Write</pre>
 
248
<p>Scale at which the effect is applied.</p>
 
249
<p>Allowed values: [0,1]</p>
 
250
<p>Default value: 1</p>
 
251
</div>
 
252
<hr>
 
253
<div class="refsect2" lang="en">
 
254
<a name="EvTransitionEffect--type"></a><h3>The <code class="literal">"type"</code> property</h3>
 
255
<pre class="programlisting">  "type"                     <a class="link" href="libevdocument-ev-transition-effect.html#EvTransitionEffectType" title="enum EvTransitionEffectType">EvTransitionEffectType</a>  : Read / Write</pre>
 
256
<p>Page transition effect type.</p>
 
257
<p>Default value: EV_TRANSITION_EFFECT_REPLACE</p>
 
258
</div>
 
259
</div>
 
260
</div>
 
261
<div class="footer">
 
262
<hr>
 
263
          Generated by GTK-Doc V1.10</div>
 
264
</body>
 
265
</html>