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

« back to all changes in this revision

Viewing changes to doc/xml/SwfdecAsContext.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:
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="SwfdecAsContext">
5
5
<refmeta>
6
 
<refentrytitle role="top_of_page">SwfdecAsContext</refentrytitle>
 
6
<refentrytitle role="top_of_page" id="SwfdecAsContext.top_of_page">SwfdecAsContext</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="SwfdecAsContext.synopsis" role="synopsis">
18
18
<title role="synopsis.title">Synopsis</title>
19
19
 
20
20
<synopsis>
21
21
 
22
22
#include &lt;swfdec/swfdec.h&gt;
23
23
 
24
 
 
25
24
                    <link linkend="SwfdecAsContext-struct">SwfdecAsContext</link>;
26
25
<link linkend="void">void</link>                <link linkend="swfdec-as-context-startup">swfdec_as_context_startup</link>           (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);
27
26
<link linkend="void">void</link>                <link linkend="swfdec-as-context-abort">swfdec_as_context_abort</link>             (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
56
55
                                                         <link linkend="GTimeVal">GTimeVal</link> *tv);
57
56
<link linkend="SwfdecAsFrame">SwfdecAsFrame</link>*      <link linkend="swfdec-as-context-get-frame">swfdec_as_context_get_frame</link>         (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);
58
57
<link linkend="gboolean">gboolean</link>            <link linkend="swfdec-as-context-is-constructing">swfdec_as_context_is_constructing</link>   (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);
59
 
 
60
58
</synopsis>
61
59
</refsynopsisdiv>
62
60
 
63
 
<refsect1 role="object_hierarchy">
 
61
<refsect1 id="SwfdecAsContext.object-hierarchy" role="object_hierarchy">
64
62
<title role="object_hierarchy.title">Object Hierarchy</title>
65
63
<synopsis>
66
 
 
67
64
  <link linkend="GObject">GObject</link>
68
65
   +----SwfdecAsContext
69
66
         +----<link linkend="SwfdecPlayer">SwfdecPlayer</link>
75
72
 
76
73
 
77
74
 
78
 
<refsect1 role="properties">
 
75
<refsect1 id="SwfdecAsContext.properties" role="properties">
79
76
<title role="properties.title">Properties</title>
80
77
<synopsis>
81
 
 
82
78
  &quot;<link linkend="SwfdecAsContext--aborted">aborted</link>&quot;                  <link linkend="gboolean">gboolean</link>              : Read
83
 
  &quot;<link linkend="SwfdecAsContext--debugger">debugger</link>&quot;                 <link linkend="SwfdecAsDebugger">SwfdecAsDebugger</link>      : Read / Write / Construct Only
 
79
  &quot;<link linkend="SwfdecAsContext--debugger">debugger</link>&quot;                 <link linkend="SwfdecAsDebugger">SwfdecAsDebugger</link>*     : Read / Write / Construct Only
84
80
  &quot;<link linkend="SwfdecAsContext--memory-until-gc">memory-until-gc</link>&quot;          <link linkend="gulong">gulong</link>                : Read / Write / Construct
85
81
  &quot;<link linkend="SwfdecAsContext--random-seed">random-seed</link>&quot;              <link linkend="guint">guint</link>                 : Write
86
82
</synopsis>
87
83
</refsect1>
88
84
 
89
 
<refsect1 role="signal_proto">
 
85
<refsect1 id="SwfdecAsContext.signals" role="signal_proto">
90
86
<title role="signal_proto.title">Signals</title>
91
87
<synopsis>
92
 
 
93
88
  &quot;<link linkend="SwfdecAsContext-trace">trace</link>&quot;                                          : Run Last
94
89
</synopsis>
95
90
</refsect1>
96
91
 
97
92
 
98
 
<refsect1 role="desc">
 
93
<refsect1 id="SwfdecAsContext.description" role="desc">
99
94
<title role="desc.title">Description</title>
100
95
<para>
101
96
A <link linkend="SwfdecAsContext"><type>SwfdecAsContext</type></link> provides the main execution environment for Actionscript
112
107
</para>
113
108
</refsect1>
114
109
 
115
 
<refsect1 role="details">
 
110
<refsect1 id="SwfdecAsContext.details" role="details">
116
111
<title role="details.title">Details</title>
117
 
<refsect2>
118
 
<title><anchor id="SwfdecAsContext-struct" role="struct"/>SwfdecAsContext</title>
119
 
<indexterm><primary>SwfdecAsContext</primary></indexterm><programlisting>typedef struct _SwfdecAsContext SwfdecAsContext;</programlisting>
 
112
<refsect2 id="SwfdecAsContext-struct" role="struct">
 
113
<title>SwfdecAsContext</title>
 
114
<indexterm zone="SwfdecAsContext-struct"><primary>SwfdecAsContext</primary></indexterm><programlisting>typedef struct _SwfdecAsContext SwfdecAsContext;</programlisting>
120
115
<para>
121
116
This is the main object ued to hold the state of a script engine. All members 
122
117
are private and should not be accessed.
127
122
<para>
128
123
 
129
124
</para></refsect2>
130
 
<refsect2>
131
 
<title><anchor id="swfdec-as-context-startup" role="function"/>swfdec_as_context_startup ()</title>
132
 
<indexterm><primary>swfdec_as_context_startup</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_startup           (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
 
125
<refsect2 id="swfdec-as-context-startup" role="function">
 
126
<title>swfdec_as_context_startup ()</title>
 
127
<indexterm zone="swfdec-as-context-startup"><primary>swfdec_as_context_startup</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_startup           (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
133
128
<para>
134
129
Starts up the context. This function must be called before any Actionscript
135
130
is called on <parameter>context</parameter>.</para>
140
135
<listitem><simpara> a <link linkend="SwfdecAsContext"><type>SwfdecAsContext</type></link>
141
136
</simpara></listitem></varlistentry>
142
137
</variablelist></refsect2>
143
 
<refsect2>
144
 
<title><anchor id="swfdec-as-context-abort" role="function"/>swfdec_as_context_abort ()</title>
145
 
<indexterm><primary>swfdec_as_context_abort</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_abort             (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
 
138
<refsect2 id="swfdec-as-context-abort" role="function">
 
139
<title>swfdec_as_context_abort ()</title>
 
140
<indexterm zone="swfdec-as-context-abort"><primary>swfdec_as_context_abort</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_abort             (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
146
141
                                                         const <link linkend="char">char</link> *reason);</programlisting>
147
142
<para>
148
143
Aborts script execution in <parameter>context</parameter>. Call this functon if the script engine 
158
153
<listitem><simpara> a string describing why execution was aborted
159
154
</simpara></listitem></varlistentry>
160
155
</variablelist></refsect2>
161
 
<refsect2>
162
 
<title><anchor id="swfdec-as-context-is-aborted" role="function"/>swfdec_as_context_is_aborted ()</title>
163
 
<indexterm><primary>swfdec_as_context_is_aborted</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_as_context_is_aborted        (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
 
156
<refsect2 id="swfdec-as-context-is-aborted" role="function">
 
157
<title>swfdec_as_context_is_aborted ()</title>
 
158
<indexterm zone="swfdec-as-context-is-aborted"><primary>swfdec_as_context_is_aborted</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_as_context_is_aborted        (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
164
159
<para>
165
160
Determines if the given context is aborted. An aborted context is not able
166
161
to execute any scripts. Aborting can happen if the script engine detects bad 
175
170
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the player is aborted, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if it runs normally.
176
171
</simpara></listitem></varlistentry>
177
172
</variablelist></refsect2>
178
 
<refsect2>
179
 
<title><anchor id="swfdec-as-context-get-string" role="function"/>swfdec_as_context_get_string ()</title>
180
 
<indexterm><primary>swfdec_as_context_get_string</primary></indexterm><programlisting>const <link linkend="char">char</link>*         swfdec_as_context_get_string        (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
 
173
<refsect2 id="swfdec-as-context-get-string" role="function">
 
174
<title>swfdec_as_context_get_string ()</title>
 
175
<indexterm zone="swfdec-as-context-get-string"><primary>swfdec_as_context_get_string</primary></indexterm><programlisting>const <link linkend="char">char</link>*         swfdec_as_context_get_string        (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
181
176
                                                         const <link linkend="char">char</link> *string);</programlisting>
182
177
<para>
183
178
Gets the garbage-collected version of <parameter>string</parameter>. You need to call this function
195
190
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the garbage-collected version of <parameter>string</parameter>
196
191
</simpara></listitem></varlistentry>
197
192
</variablelist></refsect2>
198
 
<refsect2>
199
 
<title><anchor id="swfdec-as-context-give-string" role="function"/>swfdec_as_context_give_string ()</title>
200
 
<indexterm><primary>swfdec_as_context_give_string</primary></indexterm><programlisting>const <link linkend="char">char</link>*         swfdec_as_context_give_string       (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
 
193
<refsect2 id="swfdec-as-context-give-string" role="function">
 
194
<title>swfdec_as_context_give_string ()</title>
 
195
<indexterm zone="swfdec-as-context-give-string"><primary>swfdec_as_context_give_string</primary></indexterm><programlisting>const <link linkend="char">char</link>*         swfdec_as_context_give_string       (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
201
196
                                                         <link linkend="char">char</link> *string);</programlisting>
202
197
<para>
203
198
Takes ownership of <parameter>string</parameter> and returns a refcounted version of the same 
215
210
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A refcounted string
216
211
</simpara></listitem></varlistentry>
217
212
</variablelist></refsect2>
218
 
<refsect2>
219
 
<title><anchor id="swfdec-as-context-use-mem" role="function"/>swfdec_as_context_use_mem ()</title>
220
 
<indexterm><primary>swfdec_as_context_use_mem</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_as_context_use_mem           (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
 
213
<refsect2 id="swfdec-as-context-use-mem" role="function">
 
214
<title>swfdec_as_context_use_mem ()</title>
 
215
<indexterm zone="swfdec-as-context-use-mem"><primary>swfdec_as_context_use_mem</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_as_context_use_mem           (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
221
216
                                                         <link linkend="gsize">gsize</link> bytes);</programlisting>
222
217
<para>
223
218
Registers <parameter>bytes</parameter> additional bytes as in use by the <parameter>context</parameter>. This function
236
231
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the memory could be allocated. <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> on OOM.
237
232
</simpara></listitem></varlistentry>
238
233
</variablelist></refsect2>
239
 
<refsect2>
240
 
<title><anchor id="swfdec-as-context-try-use-mem" role="function"/>swfdec_as_context_try_use_mem ()</title>
241
 
<indexterm><primary>swfdec_as_context_try_use_mem</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_as_context_try_use_mem       (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
 
234
<refsect2 id="swfdec-as-context-try-use-mem" role="function">
 
235
<title>swfdec_as_context_try_use_mem ()</title>
 
236
<indexterm zone="swfdec-as-context-try-use-mem"><primary>swfdec_as_context_try_use_mem</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_as_context_try_use_mem       (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
242
237
                                                         <link linkend="gsize">gsize</link> bytes);</programlisting>
243
238
<para>
244
239
Tries to register <parameter>bytes</parameter> additional bytes as in use by the <parameter>context</parameter>. This
256
251
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the memory could be allocated. <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> on OOM.
257
252
</simpara></listitem></varlistentry>
258
253
</variablelist></refsect2>
259
 
<refsect2>
260
 
<title><anchor id="swfdec-as-context-unuse-mem" role="function"/>swfdec_as_context_unuse_mem ()</title>
261
 
<indexterm><primary>swfdec_as_context_unuse_mem</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_unuse_mem         (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
 
254
<refsect2 id="swfdec-as-context-unuse-mem" role="function">
 
255
<title>swfdec_as_context_unuse_mem ()</title>
 
256
<indexterm zone="swfdec-as-context-unuse-mem"><primary>swfdec_as_context_unuse_mem</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_unuse_mem         (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
262
257
                                                         <link linkend="gsize">gsize</link> bytes);</programlisting>
263
258
<para>
264
259
Releases a number of bytes previously allocated using 
273
268
<listitem><simpara> number of bytes to release
274
269
</simpara></listitem></varlistentry>
275
270
</variablelist></refsect2>
276
 
<refsect2>
277
 
<title><anchor id="swfdec-as-context-gc" role="function"/>swfdec_as_context_gc ()</title>
278
 
<indexterm><primary>swfdec_as_context_gc</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_gc                (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
 
271
<refsect2 id="swfdec-as-context-gc" role="function">
 
272
<title>swfdec_as_context_gc ()</title>
 
273
<indexterm zone="swfdec-as-context-gc"><primary>swfdec_as_context_gc</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_gc                (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
279
274
<para>
280
275
Calls the Swfdec Gargbage collector and reclaims any unused memory. You 
281
276
should call this function or <link linkend="swfdec-as-context-maybe-gc"><function>swfdec_as_context_maybe_gc()</function></link> regularly.
288
283
<listitem><simpara> a <link linkend="SwfdecAsContext"><type>SwfdecAsContext</type></link>
289
284
</simpara></listitem></varlistentry>
290
285
</variablelist></refsect2>
291
 
<refsect2>
292
 
<title><anchor id="swfdec-as-context-maybe-gc" role="function"/>swfdec_as_context_maybe_gc ()</title>
293
 
<indexterm><primary>swfdec_as_context_maybe_gc</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_maybe_gc          (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
 
286
<refsect2 id="swfdec-as-context-maybe-gc" role="function">
 
287
<title>swfdec_as_context_maybe_gc ()</title>
 
288
<indexterm zone="swfdec-as-context-maybe-gc"><primary>swfdec_as_context_maybe_gc</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_maybe_gc          (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
294
289
<para>
295
290
Calls the garbage collector if necessary. It's a good idea to call this
296
291
function regularly instead of <link linkend="swfdec-as-context-gc"><function>swfdec_as_context_gc()</function></link> as it only does collect
303
298
<listitem><simpara> a <link linkend="SwfdecAsContext"><type>SwfdecAsContext</type></link>
304
299
</simpara></listitem></varlistentry>
305
300
</variablelist></refsect2>
306
 
<refsect2>
307
 
<title><anchor id="swfdec-as-context-run" role="function"/>swfdec_as_context_run ()</title>
308
 
<indexterm><primary>swfdec_as_context_run</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_run               (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
 
301
<refsect2 id="swfdec-as-context-run" role="function">
 
302
<title>swfdec_as_context_run ()</title>
 
303
<indexterm zone="swfdec-as-context-run"><primary>swfdec_as_context_run</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_run               (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
309
304
<para>
310
305
Continues running the script engine. Executing code in this engine works
311
306
in 2 steps: First, you push the frame to be executed onto the stack, then
321
316
<listitem><simpara> a <link linkend="SwfdecAsContext"><type>SwfdecAsContext</type></link>
322
317
</simpara></listitem></varlistentry>
323
318
</variablelist></refsect2>
324
 
<refsect2>
325
 
<title><anchor id="swfdec-as-context-throw" role="function"/>swfdec_as_context_throw ()</title>
326
 
<indexterm><primary>swfdec_as_context_throw</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_throw             (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
 
319
<refsect2 id="swfdec-as-context-throw" role="function">
 
320
<title>swfdec_as_context_throw ()</title>
 
321
<indexterm zone="swfdec-as-context-throw"><primary>swfdec_as_context_throw</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_throw             (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
327
322
                                                         const <link linkend="SwfdecAsValue">SwfdecAsValue</link> *value);</programlisting>
328
323
<para>
329
324
Throws a new exception in the <parameter>context</parameter> using the given <parameter>value</parameter>. This function
338
333
<listitem><simpara> a <link linkend="SwfdecAsValue"><type>SwfdecAsValue</type></link> to be thrown
339
334
</simpara></listitem></varlistentry>
340
335
</variablelist></refsect2>
341
 
<refsect2>
342
 
<title><anchor id="swfdec-as-context-catch" role="function"/>swfdec_as_context_catch ()</title>
343
 
<indexterm><primary>swfdec_as_context_catch</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_as_context_catch             (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
 
336
<refsect2 id="swfdec-as-context-catch" role="function">
 
337
<title>swfdec_as_context_catch ()</title>
 
338
<indexterm zone="swfdec-as-context-catch"><primary>swfdec_as_context_catch</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_as_context_catch             (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
344
339
                                                         <link linkend="SwfdecAsValue">SwfdecAsValue</link> *value);</programlisting>
345
340
<para>
346
341
Removes the currently thrown exception from <parameter>context</parameter> and sets <parameter>value</parameter> to the
357
352
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if an exception was catched, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
358
353
</simpara></listitem></varlistentry>
359
354
</variablelist></refsect2>
360
 
<refsect2>
361
 
<title><anchor id="swfdec-as-context-eval" role="function"/>swfdec_as_context_eval ()</title>
362
 
<indexterm><primary>swfdec_as_context_eval</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_eval              (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
 
355
<refsect2 id="swfdec-as-context-eval" role="function">
 
356
<title>swfdec_as_context_eval ()</title>
 
357
<indexterm zone="swfdec-as-context-eval"><primary>swfdec_as_context_eval</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_eval              (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
363
358
                                                         <link linkend="SwfdecAsObject">SwfdecAsObject</link> *obj,
364
359
                                                         const <link linkend="char">char</link> *str,
365
360
                                                         <link linkend="SwfdecAsValue">SwfdecAsValue</link> *val);</programlisting>
384
379
<listitem><simpara> location for the return value
385
380
</simpara></listitem></varlistentry>
386
381
</variablelist></refsect2>
387
 
<refsect2>
388
 
<title><anchor id="swfdec-as-context-eval-set" role="function"/>swfdec_as_context_eval_set ()</title>
389
 
<indexterm><primary>swfdec_as_context_eval_set</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_eval_set          (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
 
382
<refsect2 id="swfdec-as-context-eval-set" role="function">
 
383
<title>swfdec_as_context_eval_set ()</title>
 
384
<indexterm zone="swfdec-as-context-eval-set"><primary>swfdec_as_context_eval_set</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_eval_set          (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
390
385
                                                         <link linkend="SwfdecAsObject">SwfdecAsObject</link> *obj,
391
386
                                                         const <link linkend="char">char</link> *str,
392
387
                                                         const <link linkend="SwfdecAsValue">SwfdecAsValue</link> *val);</programlisting>
410
405
<listitem><simpara> the value to set the variable to
411
406
</simpara></listitem></varlistentry>
412
407
</variablelist></refsect2>
413
 
<refsect2>
414
 
<title><anchor id="swfdec-as-context-get-time" role="function"/>swfdec_as_context_get_time ()</title>
415
 
<indexterm><primary>swfdec_as_context_get_time</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_get_time          (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
 
408
<refsect2 id="swfdec-as-context-get-time" role="function">
 
409
<title>swfdec_as_context_get_time ()</title>
 
410
<indexterm zone="swfdec-as-context-get-time"><primary>swfdec_as_context_get_time</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_context_get_time          (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
416
411
                                                         <link linkend="GTimeVal">GTimeVal</link> *tv);</programlisting>
417
412
<para>
418
413
This function queries the time to be used inside this context. By default,
428
423
<listitem><simpara> a <link linkend="GTimeVal"><type>GTimeVal</type></link> to be set to the context's time
429
424
</simpara></listitem></varlistentry>
430
425
</variablelist></refsect2>
431
 
<refsect2>
432
 
<title><anchor id="swfdec-as-context-get-frame" role="function"/>swfdec_as_context_get_frame ()</title>
433
 
<indexterm><primary>swfdec_as_context_get_frame</primary></indexterm><programlisting><link linkend="SwfdecAsFrame">SwfdecAsFrame</link>*      swfdec_as_context_get_frame         (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
 
426
<refsect2 id="swfdec-as-context-get-frame" role="function">
 
427
<title>swfdec_as_context_get_frame ()</title>
 
428
<indexterm zone="swfdec-as-context-get-frame"><primary>swfdec_as_context_get_frame</primary></indexterm><programlisting><link linkend="SwfdecAsFrame">SwfdecAsFrame</link>*      swfdec_as_context_get_frame         (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
434
429
<para>
435
430
This is a debugging function. It gets the topmost stack frame that is 
436
431
currently executing. If no function is executing, <link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned. You can
450
445
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the currently executing frame or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none
451
446
</simpara></listitem></varlistentry>
452
447
</variablelist></refsect2>
453
 
<refsect2>
454
 
<title><anchor id="swfdec-as-context-is-constructing" role="function"/>swfdec_as_context_is_constructing ()</title>
455
 
<indexterm><primary>swfdec_as_context_is_constructing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_as_context_is_constructing   (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
 
448
<refsect2 id="swfdec-as-context-is-constructing" role="function">
 
449
<title>swfdec_as_context_is_constructing ()</title>
 
450
<indexterm zone="swfdec-as-context-is-constructing"><primary>swfdec_as_context_is_constructing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_as_context_is_constructing   (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
456
451
<para>
457
452
Determines if the contexxt is currently constructing. This information is
458
453
used by various constructors to do different things when they are 
470
465
</variablelist></refsect2>
471
466
 
472
467
</refsect1>
473
 
<refsect1 role="property_details">
 
468
<refsect1 id="SwfdecAsContext.property-details" role="property_details">
474
469
<title role="property_details.title">Property Details</title>
475
 
<refsect2><title><anchor id="SwfdecAsContext--aborted"/>The <literal>&quot;aborted&quot;</literal> property</title>
476
 
<indexterm><primary>SwfdecAsContext:aborted</primary></indexterm><programlisting>  &quot;aborted&quot;                  <link linkend="gboolean">gboolean</link>              : Read</programlisting>
 
470
<refsect2 id="SwfdecAsContext--aborted"><title>The <literal>&quot;aborted&quot;</literal> property</title>
 
471
<indexterm zone="SwfdecAsContext--aborted"><primary>SwfdecAsContext:aborted</primary></indexterm><programlisting>  &quot;aborted&quot;                  <link linkend="gboolean">gboolean</link>              : Read</programlisting>
477
472
<para>set when the script engine aborts due to an error.</para><para>Default value: FALSE</para>
478
473
</refsect2>
479
 
<refsect2><title><anchor id="SwfdecAsContext--debugger"/>The <literal>&quot;debugger&quot;</literal> property</title>
480
 
<indexterm><primary>SwfdecAsContext:debugger</primary></indexterm><programlisting>  &quot;debugger&quot;                 <link linkend="SwfdecAsDebugger">SwfdecAsDebugger</link>      : Read / Write / Construct Only</programlisting>
 
474
<refsect2 id="SwfdecAsContext--debugger"><title>The <literal>&quot;debugger&quot;</literal> property</title>
 
475
<indexterm zone="SwfdecAsContext--debugger"><primary>SwfdecAsContext:debugger</primary></indexterm><programlisting>  &quot;debugger&quot;                 <link linkend="SwfdecAsDebugger">SwfdecAsDebugger</link>*     : Read / Write / Construct Only</programlisting>
481
476
<para>debugger used in this player.</para></refsect2>
482
 
<refsect2><title><anchor id="SwfdecAsContext--memory-until-gc"/>The <literal>&quot;memory-until-gc&quot;</literal> property</title>
483
 
<indexterm><primary>SwfdecAsContext:memory-until-gc</primary></indexterm><programlisting>  &quot;memory-until-gc&quot;          <link linkend="gulong">gulong</link>                : Read / Write / Construct</programlisting>
 
477
<refsect2 id="SwfdecAsContext--memory-until-gc"><title>The <literal>&quot;memory-until-gc&quot;</literal> property</title>
 
478
<indexterm zone="SwfdecAsContext--memory-until-gc"><primary>SwfdecAsContext:memory-until-gc</primary></indexterm><programlisting>  &quot;memory-until-gc&quot;          <link linkend="gulong">gulong</link>                : Read / Write / Construct</programlisting>
484
479
<para>amount of bytes that need to be allocated before garbage collection triggers.</para></refsect2>
485
 
<refsect2><title><anchor id="SwfdecAsContext--random-seed"/>The <literal>&quot;random-seed&quot;</literal> property</title>
486
 
<indexterm><primary>SwfdecAsContext:random-seed</primary></indexterm><programlisting>  &quot;random-seed&quot;              <link linkend="guint">guint</link>                 : Write</programlisting>
 
480
<refsect2 id="SwfdecAsContext--random-seed"><title>The <literal>&quot;random-seed&quot;</literal> property</title>
 
481
<indexterm zone="SwfdecAsContext--random-seed"><primary>SwfdecAsContext:random-seed</primary></indexterm><programlisting>  &quot;random-seed&quot;              <link linkend="guint">guint</link>                 : Write</programlisting>
487
482
<para>seed used for calculating random numbers.</para><para>Default value: 0</para>
488
483
</refsect2>
489
484
 
490
485
</refsect1>
491
486
 
492
 
<refsect1 role="signals">
 
487
<refsect1 id="SwfdecAsContext.signal-details" role="signals">
493
488
<title role="signals.title">Signal Details</title>
494
 
<refsect2><title><anchor id="SwfdecAsContext-trace"/>The <literal>&quot;trace&quot;</literal> signal</title>
495
 
<indexterm><primary>SwfdecAsContext::trace</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
 
489
<refsect2 id="SwfdecAsContext-trace"><title>The <literal>&quot;trace&quot;</literal> signal</title>
 
490
<indexterm zone="SwfdecAsContext-trace"><primary>SwfdecAsContext::trace</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
496
491
                                                        <link linkend="gchar">gchar</link>           *text,
497
492
                                                        <link linkend="gpointer">gpointer</link>         user_data)      : Run Last</programlisting>
498
493
<para>
513
508
</refsect1>
514
509
 
515
510
 
516
 
<refsect1>
 
511
<refsect1 id="SwfdecAsContext.see-also">
517
512
<title>See Also</title>
518
513
SwfdecPlayer
519
514
</refsect1>
520
515
 
521
 
 
522
 
<refsect1><refsect2 /><refsect2 /></refsect1>
523
516
</refentry>