← Back to branch summary

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

« back to all changes in this revision

Viewing changes to help/reference/libdocument/xml/ev-async-renderer.xml

  • 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/xml/ev-async-renderer.xml
 
1
<refentry id="libevdocument-ev-async-renderer">
 
2
<refmeta>
 
3
<refentrytitle role="top_of_page" id="libevdocument-ev-async-renderer.top_of_page">ev-async-renderer</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>LIBEVDOCUMENT Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>ev-async-renderer</refname>
 
10
<refpurpose></refpurpose>
 
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
12
</refnamediv>
 
13
 
 
14
<refsynopsisdiv id="libevdocument-ev-async-renderer.synopsis" role="synopsis">
 
15
<title role="synopsis.title">Synopsis</title>
 
16
<anchor id="EvAsyncRenderer"/>
 
17
<synopsis>
 
18
#define             <link linkend="EV-ASYNC-RENDERER-IFACE:CAPS">EV_ASYNC_RENDERER_IFACE</link>             (k)
 
19
#define             <link linkend="EV-IS-ASYNC-RENDERER-IFACE:CAPS">EV_IS_ASYNC_RENDERER_IFACE</link>          (k)
 
20
                    <link linkend="EvAsyncRenderer-struct">EvAsyncRenderer</link>;
 
21
                    <link linkend="EvAsyncRendererIface">EvAsyncRendererIface</link>;
 
22
<link linkend="void">void</link>                <link linkend="ev-async-renderer-render-pixbuf">ev_async_renderer_render_pixbuf</link>     (<link linkend="EvAsyncRenderer">EvAsyncRenderer</link> *renderer,
 
23
                                                         <link linkend="int">int</link> page,
 
24
                                                         <link linkend="double">double</link> scale,
 
25
                                                         <link linkend="int">int</link> rotation);
 
26
</synopsis>
 
27
</refsynopsisdiv>
 
28
 
 
29
<refsect1 id="libevdocument-ev-async-renderer.object-hierarchy" role="object_hierarchy">
 
30
<title role="object_hierarchy.title">Object Hierarchy</title>
 
31
<synopsis>
 
32
  <link linkend="GInterface">GInterface</link>
 
33
   +----EvAsyncRenderer
 
34
</synopsis>
 
35
 
 
36
</refsect1>
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
<refsect1 id="libevdocument-ev-async-renderer.signals" role="signal_proto">
 
44
<title role="signal_proto.title">Signals</title>
 
45
<synopsis>
 
46
  &quot;<link linkend="EvAsyncRenderer-render-finished">render-finished</link>&quot;                                : Run Last
 
47
</synopsis>
 
48
</refsect1>
 
49
 
 
50
 
 
51
<refsect1 id="libevdocument-ev-async-renderer.description" role="desc">
 
52
<title role="desc.title">Description</title>
 
53
<para>
 
54
 
 
55
</para>
 
56
</refsect1>
 
57
 
 
58
<refsect1 id="libevdocument-ev-async-renderer.details" role="details">
 
59
<title role="details.title">Details</title>
 
60
<refsect2 id="EV-ASYNC-RENDERER-IFACE:CAPS" role="macro">
 
61
<title>EV_ASYNC_RENDERER_IFACE()</title>
 
62
<indexterm zone="EV-ASYNC-RENDERER-IFACE:CAPS"><primary>EV_ASYNC_RENDERER_IFACE</primary></indexterm><programlisting>#define EV_ASYNC_RENDERER_IFACE(k)   (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_ASYNC_RENDERER, EvAsyncRendererIface))
 
63
</programlisting>
 
64
<para>
 
65
 
 
66
</para><variablelist role="params">
 
67
<varlistentry><term><parameter>k</parameter>&nbsp;:</term>
 
68
<listitem><simpara>
 
69
 
 
70
 
 
71
</simpara></listitem></varlistentry>
 
72
</variablelist></refsect2>
 
73
<refsect2 id="EV-IS-ASYNC-RENDERER-IFACE:CAPS" role="macro">
 
74
<title>EV_IS_ASYNC_RENDERER_IFACE()</title>
 
75
<indexterm zone="EV-IS-ASYNC-RENDERER-IFACE:CAPS"><primary>EV_IS_ASYNC_RENDERER_IFACE</primary></indexterm><programlisting>#define EV_IS_ASYNC_RENDERER_IFACE(k)          (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_ASYNC_RENDERER))
 
76
</programlisting>
 
77
<para>
 
78
 
 
79
</para><variablelist role="params">
 
80
<varlistentry><term><parameter>k</parameter>&nbsp;:</term>
 
81
<listitem><simpara>
 
82
 
 
83
 
 
84
</simpara></listitem></varlistentry>
 
85
</variablelist></refsect2>
 
86
<refsect2 id="EvAsyncRenderer-struct" role="struct">
 
87
<title>EvAsyncRenderer</title>
 
88
<indexterm zone="EvAsyncRenderer-struct"><primary>EvAsyncRenderer</primary></indexterm><programlisting>typedef struct _EvAsyncRenderer EvAsyncRenderer;</programlisting>
 
89
<para>
 
90
 
 
91
</para></refsect2>
 
92
<refsect2 id="EvAsyncRendererIface" role="struct">
 
93
<title>EvAsyncRendererIface</title>
 
94
<indexterm zone="EvAsyncRendererIface"><primary>EvAsyncRendererIface</primary></indexterm><programlisting>typedef struct {
 
95
        GTypeInterface base_iface;
 
96
 
 
97
        void        (* render_finished) (EvAsyncRenderer *renderer,
 
98
                                         GdkPixbuf       *pixbuf);
 
99
 
 
100
        void        (* render_pixbuf)   (EvAsyncRenderer *renderer,
 
101
                                         int              page,
 
102
                                         double           scale,
 
103
                                         int              rotation);
 
104
} EvAsyncRendererIface;
 
105
</programlisting>
 
106
<para>
 
107
 
 
108
</para></refsect2>
 
109
<refsect2 id="ev-async-renderer-render-pixbuf" role="function">
 
110
<title>ev_async_renderer_render_pixbuf ()</title>
 
111
<indexterm zone="ev-async-renderer-render-pixbuf"><primary>ev_async_renderer_render_pixbuf</primary></indexterm><programlisting><link linkend="void">void</link>                ev_async_renderer_render_pixbuf     (<link linkend="EvAsyncRenderer">EvAsyncRenderer</link> *renderer,
 
112
                                                         <link linkend="int">int</link> page,
 
113
                                                         <link linkend="double">double</link> scale,
 
114
                                                         <link linkend="int">int</link> rotation);</programlisting>
 
115
<para>
 
116
 
 
117
</para><variablelist role="params">
 
118
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
 
119
<listitem><simpara>
 
120
</simpara></listitem></varlistentry>
 
121
<varlistentry><term><parameter>page</parameter>&nbsp;:</term>
 
122
<listitem><simpara>
 
123
</simpara></listitem></varlistentry>
 
124
<varlistentry><term><parameter>scale</parameter>&nbsp;:</term>
 
125
<listitem><simpara>
 
126
</simpara></listitem></varlistentry>
 
127
<varlistentry><term><parameter>rotation</parameter>&nbsp;:</term>
 
128
<listitem><simpara>
 
129
 
 
130
 
 
131
</simpara></listitem></varlistentry>
 
132
</variablelist></refsect2>
 
133
 
 
134
</refsect1>
 
135
 
 
136
<refsect1 id="libevdocument-ev-async-renderer.signal-details" role="signals">
 
137
<title role="signals.title">Signal Details</title>
 
138
<refsect2 id="EvAsyncRenderer-render-finished"><title>The <literal>&quot;render-finished&quot;</literal> signal</title>
 
139
<indexterm zone="EvAsyncRenderer-render-finished"><primary>EvAsyncRenderer::render-finished</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EvAsyncRenderer">EvAsyncRenderer</link> *evasyncrenderer,
 
140
                                                        <link linkend="GdkPixbuf">GdkPixbuf</link>       *arg1,
 
141
                                                        <link linkend="gpointer">gpointer</link>         user_data)            : Run Last</programlisting>
 
142
<para>
 
143
 
 
144
</para><variablelist role="params">
 
145
<varlistentry><term><parameter>evasyncrenderer</parameter>&nbsp;:</term>
 
146
<listitem><simpara>the object which received the signal.
 
147
</simpara></listitem></varlistentry>
 
148
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
 
149
<listitem><simpara>
 
150
 
 
151
</simpara></listitem></varlistentry>
 
152
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
153
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
154
</variablelist></refsect2>
 
155
</refsect1>
 
156
 
 
157
 
 
158
 
 
159
</refentry>