← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/swfdec0.6/intrepid

« back to all changes in this revision

Viewing changes to doc/xml/SwfdecGtkWidget.xml

  • Committer: Bazaar Package Importer
  • Author(s): Santiago Garcia Mantinan
  • Date: 2008-07-29 23:30:05 UTC
  • mfrom: (1.1.3 upstream) (3.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080729233005-k05tu7pnfyb8vcog
Tags: 0.6.8-1
* New upstream version. Fixes several crashes.
* Setting urgency as high to try to get all these fixes to lenny.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/SwfdecGtkWidget.xml
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="SwfdecGtkWidget">
5
5
<refmeta>
6
 
<refentrytitle role="top_of_page">SwfdecGtkWidget</refentrytitle>
 
6
<refentrytitle role="top_of_page" id="SwfdecGtkWidget.top_of_page">SwfdecGtkWidget</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>SWFDEC Library</refmiscinfo>
9
9
</refmeta>
14
14
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15
15
</refnamediv>
16
16
 
17
 
<refsynopsisdiv role="synopsis">
 
17
<refsynopsisdiv id="SwfdecGtkWidget.synopsis" role="synopsis">
18
18
<title role="synopsis.title">Synopsis</title>
19
19
 
20
20
<synopsis>
21
21
 
22
22
#include &lt;swfdec/swfdec-gtk.h&gt;
23
23
 
24
 
 
25
24
                    <link linkend="SwfdecGtkWidget-struct">SwfdecGtkWidget</link>;
26
25
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="swfdec-gtk-widget-new">swfdec_gtk_widget_new</link>               (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);
27
26
<link linkend="SwfdecPlayer">SwfdecPlayer</link>*       <link linkend="swfdec-gtk-widget-get-player">swfdec_gtk_widget_get_player</link>        (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);
37
36
<link linkend="void">void</link>                <link linkend="swfdec-gtk-widget-unset-renderer">swfdec_gtk_widget_unset_renderer</link>    (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);
38
37
<link linkend="guint">guint</link>               <link linkend="swfdec-gtk-keycode-from-hardware-keycode">swfdec_gtk_keycode_from_hardware_keycode</link>
39
38
                                                        (<link linkend="guint">guint</link> hardware_keycode);
40
 
 
41
39
</synopsis>
42
40
</refsynopsisdiv>
43
41
 
44
 
<refsect1 role="object_hierarchy">
 
42
<refsect1 id="SwfdecGtkWidget.object-hierarchy" role="object_hierarchy">
45
43
<title role="object_hierarchy.title">Object Hierarchy</title>
46
44
<synopsis>
47
 
 
48
45
  <link linkend="GObject">GObject</link>
49
46
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
50
47
         +----<link linkend="GtkObject">GtkObject</link>
56
53
 
57
54
 
58
55
 
59
 
<refsect1 role="impl_interfaces">
 
56
<refsect1 id="SwfdecGtkWidget.implemented-interfaces" role="impl_interfaces">
60
57
<title role="impl_interfaces.title">Implemented Interfaces</title>
61
58
<para>
62
59
SwfdecGtkWidget implements
65
62
</refsect1>
66
63
 
67
64
 
68
 
<refsect1 role="properties">
 
65
<refsect1 id="SwfdecGtkWidget.properties" role="properties">
69
66
<title role="properties.title">Properties</title>
70
67
<synopsis>
71
 
 
72
68
  &quot;<link linkend="SwfdecGtkWidget--interactive">interactive</link>&quot;              <link linkend="gboolean">gboolean</link>              : Read / Write
73
 
  &quot;<link linkend="SwfdecGtkWidget--player">player</link>&quot;                   <link linkend="SwfdecPlayer">SwfdecPlayer</link>          : Read / Write / Construct
 
69
  &quot;<link linkend="SwfdecGtkWidget--player">player</link>&quot;                   <link linkend="SwfdecPlayer">SwfdecPlayer</link>*         : Read / Write / Construct
74
70
  &quot;<link linkend="SwfdecGtkWidget--renderer">renderer</link>&quot;                 <link linkend="guint">guint</link>                 : Read / Write
75
71
  &quot;<link linkend="SwfdecGtkWidget--renderer-set">renderer-set</link>&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write
76
72
</synopsis>
78
74
 
79
75
 
80
76
 
81
 
<refsect1 role="desc">
 
77
<refsect1 id="SwfdecGtkWidget.description" role="desc">
82
78
<title role="desc.title">Description</title>
83
79
<para>
84
80
This is a widget for playing Flash movies rendered with Swfdec in a Gtk 
94
90
</para>
95
91
</refsect1>
96
92
 
97
 
<refsect1 role="details">
 
93
<refsect1 id="SwfdecGtkWidget.details" role="details">
98
94
<title role="details.title">Details</title>
99
 
<refsect2>
100
 
<title><anchor id="SwfdecGtkWidget-struct" role="struct"/>SwfdecGtkWidget</title>
101
 
<indexterm><primary>SwfdecGtkWidget</primary></indexterm><programlisting>typedef struct _SwfdecGtkWidget SwfdecGtkWidget;</programlisting>
 
95
<refsect2 id="SwfdecGtkWidget-struct" role="struct">
 
96
<title>SwfdecGtkWidget</title>
 
97
<indexterm zone="SwfdecGtkWidget-struct"><primary>SwfdecGtkWidget</primary></indexterm><programlisting>typedef struct _SwfdecGtkWidget SwfdecGtkWidget;</programlisting>
102
98
<para>
103
99
The structure for the Swfdec Gtk widget contains no public fields.</para>
104
100
<para>
105
101
 
106
102
</para></refsect2>
107
 
<refsect2>
108
 
<title><anchor id="swfdec-gtk-widget-new" role="function"/>swfdec_gtk_widget_new ()</title>
109
 
<indexterm><primary>swfdec_gtk_widget_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          swfdec_gtk_widget_new               (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);</programlisting>
 
103
<refsect2 id="swfdec-gtk-widget-new" role="function">
 
104
<title>swfdec_gtk_widget_new ()</title>
 
105
<indexterm zone="swfdec-gtk-widget-new"><primary>swfdec_gtk_widget_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          swfdec_gtk_widget_new               (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);</programlisting>
110
106
<para>
111
107
Creates a new <link linkend="SwfdecGtkWidget"><type>SwfdecGtkWidget</type></link> to display <parameter>player</parameter>.</para>
112
108
<para>
118
114
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new widget that displays <parameter>player</parameter>
119
115
</simpara></listitem></varlistentry>
120
116
</variablelist></refsect2>
121
 
<refsect2>
122
 
<title><anchor id="swfdec-gtk-widget-get-player" role="function"/>swfdec_gtk_widget_get_player ()</title>
123
 
<indexterm><primary>swfdec_gtk_widget_get_player</primary></indexterm><programlisting><link linkend="SwfdecPlayer">SwfdecPlayer</link>*       swfdec_gtk_widget_get_player        (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
 
117
<refsect2 id="swfdec-gtk-widget-get-player" role="function">
 
118
<title>swfdec_gtk_widget_get_player ()</title>
 
119
<indexterm zone="swfdec-gtk-widget-get-player"><primary>swfdec_gtk_widget_get_player</primary></indexterm><programlisting><link linkend="SwfdecPlayer">SwfdecPlayer</link>*       swfdec_gtk_widget_get_player        (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
124
120
<para>
125
121
Gets the player that is currently played back in this <parameter>widget</parameter>.</para>
126
122
<para>
132
128
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none
133
129
</simpara></listitem></varlistentry>
134
130
</variablelist></refsect2>
135
 
<refsect2>
136
 
<title><anchor id="swfdec-gtk-widget-set-player" role="function"/>swfdec_gtk_widget_set_player ()</title>
137
 
<indexterm><primary>swfdec_gtk_widget_set_player</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_widget_set_player        (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget,
 
131
<refsect2 id="swfdec-gtk-widget-set-player" role="function">
 
132
<title>swfdec_gtk_widget_set_player ()</title>
 
133
<indexterm zone="swfdec-gtk-widget-set-player"><primary>swfdec_gtk_widget_set_player</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_widget_set_player        (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget,
138
134
                                                         <link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);</programlisting>
139
135
<para>
140
136
Sets the new player to display in <parameter>widget</parameter>.</para>
148
144
<listitem><simpara> the <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> to display or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for none
149
145
</simpara></listitem></varlistentry>
150
146
</variablelist></refsect2>
151
 
<refsect2>
152
 
<title><anchor id="swfdec-gtk-widget-get-interactive" role="function"/>swfdec_gtk_widget_get_interactive ()</title>
153
 
<indexterm><primary>swfdec_gtk_widget_get_interactive</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_gtk_widget_get_interactive   (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
 
147
<refsect2 id="swfdec-gtk-widget-get-interactive" role="function">
 
148
<title>swfdec_gtk_widget_get_interactive ()</title>
 
149
<indexterm zone="swfdec-gtk-widget-get-interactive"><primary>swfdec_gtk_widget_get_interactive</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_gtk_widget_get_interactive   (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
154
150
<para>
155
151
Queries if the <parameter>widget</parameter> is currently interactive. See 
156
152
<link linkend="swfdec-gtk-widget-set-interactive"><function>swfdec_gtk_widget_set_interactive()</function></link> for details.</para>
163
159
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the widget is interactive, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
164
160
</simpara></listitem></varlistentry>
165
161
</variablelist></refsect2>
166
 
<refsect2>
167
 
<title><anchor id="swfdec-gtk-widget-set-interactive" role="function"/>swfdec_gtk_widget_set_interactive ()</title>
168
 
<indexterm><primary>swfdec_gtk_widget_set_interactive</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_widget_set_interactive   (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget,
 
162
<refsect2 id="swfdec-gtk-widget-set-interactive" role="function">
 
163
<title>swfdec_gtk_widget_set_interactive ()</title>
 
164
<indexterm zone="swfdec-gtk-widget-set-interactive"><primary>swfdec_gtk_widget_set_interactive</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_widget_set_interactive   (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget,
169
165
                                                         <link linkend="gboolean">gboolean</link> interactive);</programlisting>
170
166
<para>
171
167
Sets the widget to be interactive or not. An interactive widget processes 
181
177
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to make the widget interactive
182
178
</simpara></listitem></varlistentry>
183
179
</variablelist></refsect2>
184
 
<refsect2>
185
 
<title><anchor id="swfdec-gtk-widget-get-renderer" role="function"/>swfdec_gtk_widget_get_renderer ()</title>
186
 
<indexterm><primary>swfdec_gtk_widget_get_renderer</primary></indexterm><programlisting><link linkend="cairo-surface-type-t">cairo_surface_type_t</link> swfdec_gtk_widget_get_renderer     (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
 
180
<refsect2 id="swfdec-gtk-widget-get-renderer" role="function">
 
181
<title>swfdec_gtk_widget_get_renderer ()</title>
 
182
<indexterm zone="swfdec-gtk-widget-get-renderer"><primary>swfdec_gtk_widget_get_renderer</primary></indexterm><programlisting><link linkend="cairo-surface-type-t">cairo_surface_type_t</link> swfdec_gtk_widget_get_renderer     (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
187
183
<para>
188
184
Gets the intermediate renderer that is or would be in use by <parameter>widget</parameter>. Use
189
185
<link linkend="swfdec-gtk-widget-uses-renderer"><function>swfdec_gtk_widget_uses_renderer()</function></link> to check if an intermediate renderer is in
197
193
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the type of the intermediate renderer
198
194
</simpara></listitem></varlistentry>
199
195
</variablelist></refsect2>
200
 
<refsect2>
201
 
<title><anchor id="swfdec-gtk-widget-uses-renderer" role="function"/>swfdec_gtk_widget_uses_renderer ()</title>
202
 
<indexterm><primary>swfdec_gtk_widget_uses_renderer</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_gtk_widget_uses_renderer     (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
 
196
<refsect2 id="swfdec-gtk-widget-uses-renderer" role="function">
 
197
<title>swfdec_gtk_widget_uses_renderer ()</title>
 
198
<indexterm zone="swfdec-gtk-widget-uses-renderer"><primary>swfdec_gtk_widget_uses_renderer</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_gtk_widget_uses_renderer     (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
203
199
<para>
204
200
Queries if an intermediate renderer set via <link linkend="swfdec-gtk-widget-set-renderer"><function>swfdec_gtk_widget_set_renderer()</function></link>
205
201
is currently in use.</para>
212
208
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if an intermediate renderer is used.
213
209
</simpara></listitem></varlistentry>
214
210
</variablelist></refsect2>
215
 
<refsect2>
216
 
<title><anchor id="swfdec-gtk-widget-set-renderer" role="function"/>swfdec_gtk_widget_set_renderer ()</title>
217
 
<indexterm><primary>swfdec_gtk_widget_set_renderer</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_widget_set_renderer      (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget,
 
211
<refsect2 id="swfdec-gtk-widget-set-renderer" role="function">
 
212
<title>swfdec_gtk_widget_set_renderer ()</title>
 
213
<indexterm zone="swfdec-gtk-widget-set-renderer"><primary>swfdec_gtk_widget_set_renderer</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_widget_set_renderer      (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget,
218
214
                                                         <link linkend="cairo-surface-type-t">cairo_surface_type_t</link> renderer);</programlisting>
219
215
<para>
220
216
Tells <parameter>widget</parameter> to use an intermediate surface for rendering. This is
230
226
<listitem><simpara> a <link linkend="cairo-surface-type-t"><type>cairo_surface_type_t</type></link> for the intermediate renderer
231
227
</simpara></listitem></varlistentry>
232
228
</variablelist></refsect2>
233
 
<refsect2>
234
 
<title><anchor id="swfdec-gtk-widget-unset-renderer" role="function"/>swfdec_gtk_widget_unset_renderer ()</title>
235
 
<indexterm><primary>swfdec_gtk_widget_unset_renderer</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_widget_unset_renderer    (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
 
229
<refsect2 id="swfdec-gtk-widget-unset-renderer" role="function">
 
230
<title>swfdec_gtk_widget_unset_renderer ()</title>
 
231
<indexterm zone="swfdec-gtk-widget-unset-renderer"><primary>swfdec_gtk_widget_unset_renderer</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_widget_unset_renderer    (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
236
232
<para>
237
233
Unsets the use of an intermediate rendering surface. See 
238
234
<link linkend="swfdec-gtk-widget-set-renderer"><function>swfdec_gtk_widget_set_renderer()</function></link> for details.</para>
243
239
<listitem><simpara> a <link linkend="SwfdecGtkWidget"><type>SwfdecGtkWidget</type></link>
244
240
</simpara></listitem></varlistentry>
245
241
</variablelist></refsect2>
246
 
<refsect2>
247
 
<title><anchor id="swfdec-gtk-keycode-from-hardware-keycode" role="function"/>swfdec_gtk_keycode_from_hardware_keycode ()</title>
248
 
<indexterm><primary>swfdec_gtk_keycode_from_hardware_keycode</primary></indexterm><programlisting><link linkend="guint">guint</link>               swfdec_gtk_keycode_from_hardware_keycode
 
242
<refsect2 id="swfdec-gtk-keycode-from-hardware-keycode" role="function">
 
243
<title>swfdec_gtk_keycode_from_hardware_keycode ()</title>
 
244
<indexterm zone="swfdec-gtk-keycode-from-hardware-keycode"><primary>swfdec_gtk_keycode_from_hardware_keycode</primary></indexterm><programlisting><link linkend="guint">guint</link>               swfdec_gtk_keycode_from_hardware_keycode
249
245
                                                        (<link linkend="guint">guint</link> hardware_keycode);</programlisting>
250
246
<para>
251
247
Tries to transform an X hardware keycode to the corresponding <link linkend="SwfdecKey"><type>SwfdecKey</type></link>.
262
258
</variablelist></refsect2>
263
259
 
264
260
</refsect1>
265
 
<refsect1 role="property_details">
 
261
<refsect1 id="SwfdecGtkWidget.property-details" role="property_details">
266
262
<title role="property_details.title">Property Details</title>
267
 
<refsect2><title><anchor id="SwfdecGtkWidget--interactive"/>The <literal>&quot;interactive&quot;</literal> property</title>
268
 
<indexterm><primary>SwfdecGtkWidget:interactive</primary></indexterm><programlisting>  &quot;interactive&quot;              <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
263
<refsect2 id="SwfdecGtkWidget--interactive"><title>The <literal>&quot;interactive&quot;</literal> property</title>
 
264
<indexterm zone="SwfdecGtkWidget--interactive"><primary>SwfdecGtkWidget:interactive</primary></indexterm><programlisting>  &quot;interactive&quot;              <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
269
265
<para>if mouse events are processed.</para><para>Default value: TRUE</para>
270
266
</refsect2>
271
 
<refsect2><title><anchor id="SwfdecGtkWidget--player"/>The <literal>&quot;player&quot;</literal> property</title>
272
 
<indexterm><primary>SwfdecGtkWidget:player</primary></indexterm><programlisting>  &quot;player&quot;                   <link linkend="SwfdecPlayer">SwfdecPlayer</link>          : Read / Write / Construct</programlisting>
 
267
<refsect2 id="SwfdecGtkWidget--player"><title>The <literal>&quot;player&quot;</literal> property</title>
 
268
<indexterm zone="SwfdecGtkWidget--player"><primary>SwfdecGtkWidget:player</primary></indexterm><programlisting>  &quot;player&quot;                   <link linkend="SwfdecPlayer">SwfdecPlayer</link>*         : Read / Write / Construct</programlisting>
273
269
<para>player that is displayed.</para></refsect2>
274
 
<refsect2><title><anchor id="SwfdecGtkWidget--renderer"/>The <literal>&quot;renderer&quot;</literal> property</title>
275
 
<indexterm><primary>SwfdecGtkWidget:renderer</primary></indexterm><programlisting>  &quot;renderer&quot;                 <link linkend="guint">guint</link>                 : Read / Write</programlisting>
 
270
<refsect2 id="SwfdecGtkWidget--renderer"><title>The <literal>&quot;renderer&quot;</literal> property</title>
 
271
<indexterm zone="SwfdecGtkWidget--renderer"><primary>SwfdecGtkWidget:renderer</primary></indexterm><programlisting>  &quot;renderer&quot;                 <link linkend="guint">guint</link>                 : Read / Write</programlisting>
276
272
<para>cairo_surface_type_t of intermediate renderer to use.</para><para>Default value: 0</para>
277
273
</refsect2>
278
 
<refsect2><title><anchor id="SwfdecGtkWidget--renderer-set"/>The <literal>&quot;renderer-set&quot;</literal> property</title>
279
 
<indexterm><primary>SwfdecGtkWidget:renderer-set</primary></indexterm><programlisting>  &quot;renderer-set&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
274
<refsect2 id="SwfdecGtkWidget--renderer-set"><title>The <literal>&quot;renderer-set&quot;</literal> property</title>
 
275
<indexterm zone="SwfdecGtkWidget--renderer-set"><primary>SwfdecGtkWidget:renderer-set</primary></indexterm><programlisting>  &quot;renderer-set&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
280
276
<para>if an intermediate renderer should be used.</para><para>Default value: TRUE</para>
281
277
</refsect2>
282
278
 
285
281
 
286
282
 
287
283
 
288
 
 
289
 
<refsect1><refsect2 /><refsect2 /></refsect1>
290
284
</refentry>