← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/xml/SwfdecSystem.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/SwfdecSystem.xml
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="SwfdecSystem">
5
5
<refmeta>
6
 
<refentrytitle role="top_of_page">SwfdecSystem</refentrytitle>
 
6
<refentrytitle role="top_of_page" id="SwfdecSystem.top_of_page">SwfdecSystem</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="SwfdecSystem.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="SwfdecSystem-struct">SwfdecSystem</link>;
26
25
<link linkend="SwfdecSystem">SwfdecSystem</link>*       <link linkend="swfdec-system-new">swfdec_system_new</link>                   (void);
27
 
 
28
26
</synopsis>
29
27
</refsynopsisdiv>
30
28
 
31
 
<refsect1 role="object_hierarchy">
 
29
<refsect1 id="SwfdecSystem.object-hierarchy" role="object_hierarchy">
32
30
<title role="object_hierarchy.title">Object Hierarchy</title>
33
31
<synopsis>
34
 
 
35
32
  <link linkend="GObject">GObject</link>
36
33
   +----SwfdecSystem
37
34
</synopsis>
42
39
 
43
40
 
44
41
 
45
 
<refsect1 role="properties">
 
42
<refsect1 id="SwfdecSystem.properties" role="properties">
46
43
<title role="properties.title">Properties</title>
47
44
<synopsis>
48
 
 
49
 
  &quot;<link linkend="SwfdecSystem--color-mode">color-mode</link>&quot;               <link linkend="gchararray">gchararray</link>            : Read / Write / Construct
 
45
  &quot;<link linkend="SwfdecSystem--color-mode">color-mode</link>&quot;               <link linkend="gchar">gchar</link>*                : Read / Write / Construct
50
46
  &quot;<link linkend="SwfdecSystem--debugger">debugger</link>&quot;                 <link linkend="gboolean">gboolean</link>              : Read / Write / Construct
51
47
  &quot;<link linkend="SwfdecSystem--dpi">dpi</link>&quot;                      <link linkend="guint">guint</link>                 : Read / Write / Construct
52
 
  &quot;<link linkend="SwfdecSystem--language">language</link>&quot;                 <link linkend="gchararray">gchararray</link>            : Read / Write / Construct
53
 
  &quot;<link linkend="SwfdecSystem--manufacturer">manufacturer</link>&quot;             <link linkend="gchararray">gchararray</link>            : Read / Write / Construct
54
 
  &quot;<link linkend="SwfdecSystem--os">os</link>&quot;                       <link linkend="gchararray">gchararray</link>            : Read / Write / Construct
55
 
  &quot;<link linkend="SwfdecSystem--os-type">os-type</link>&quot;                  <link linkend="gchararray">gchararray</link>            : Read / Write / Construct
 
48
  &quot;<link linkend="SwfdecSystem--language">language</link>&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write / Construct
 
49
  &quot;<link linkend="SwfdecSystem--manufacturer">manufacturer</link>&quot;             <link linkend="gchar">gchar</link>*                : Read / Write / Construct
 
50
  &quot;<link linkend="SwfdecSystem--os">os</link>&quot;                       <link linkend="gchar">gchar</link>*                : Read / Write / Construct
 
51
  &quot;<link linkend="SwfdecSystem--os-type">os-type</link>&quot;                  <link linkend="gchar">gchar</link>*                : Read / Write / Construct
56
52
  &quot;<link linkend="SwfdecSystem--pixel-aspect-ratio">pixel-aspect-ratio</link>&quot;       <link linkend="gdouble">gdouble</link>               : Read / Write / Construct
57
 
  &quot;<link linkend="SwfdecSystem--player-type">player-type</link>&quot;              <link linkend="gchararray">gchararray</link>            : Read / Write / Construct
 
53
  &quot;<link linkend="SwfdecSystem--player-type">player-type</link>&quot;              <link linkend="gchar">gchar</link>*                : Read / Write / Construct
58
54
  &quot;<link linkend="SwfdecSystem--screen-height">screen-height</link>&quot;            <link linkend="guint">guint</link>                 : Read / Write / Construct
59
55
  &quot;<link linkend="SwfdecSystem--screen-width">screen-width</link>&quot;             <link linkend="guint">guint</link>                 : Read / Write / Construct
60
 
  &quot;<link linkend="SwfdecSystem--server-manufacturer">server-manufacturer</link>&quot;      <link linkend="gchararray">gchararray</link>            : Read / Write / Construct
 
56
  &quot;<link linkend="SwfdecSystem--server-manufacturer">server-manufacturer</link>&quot;      <link linkend="gchar">gchar</link>*                : Read / Write / Construct
61
57
  &quot;<link linkend="SwfdecSystem--utc-offset">utc-offset</link>&quot;               <link linkend="gint">gint</link>                  : Read / Write / Construct
62
 
  &quot;<link linkend="SwfdecSystem--version">version</link>&quot;                  <link linkend="gchararray">gchararray</link>            : Read / Write / Construct
 
58
  &quot;<link linkend="SwfdecSystem--version">version</link>&quot;                  <link linkend="gchar">gchar</link>*                : Read / Write / Construct
63
59
</synopsis>
64
60
</refsect1>
65
61
 
66
62
 
67
63
 
68
 
<refsect1 role="desc">
 
64
<refsect1 id="SwfdecSystem.description" role="desc">
69
65
<title role="desc.title">Description</title>
70
66
<para>
71
67
This object is used to provide information about the system Swfdec currently 
93
89
</para>
94
90
</refsect1>
95
91
 
96
 
<refsect1 role="details">
 
92
<refsect1 id="SwfdecSystem.details" role="details">
97
93
<title role="details.title">Details</title>
98
 
<refsect2>
99
 
<title><anchor id="SwfdecSystem-struct" role="struct"/>SwfdecSystem</title>
100
 
<indexterm><primary>SwfdecSystem</primary></indexterm><programlisting>typedef struct _SwfdecSystem SwfdecSystem;</programlisting>
 
94
<refsect2 id="SwfdecSystem-struct" role="struct">
 
95
<title>SwfdecSystem</title>
 
96
<indexterm zone="SwfdecSystem-struct"><primary>SwfdecSystem</primary></indexterm><programlisting>typedef struct _SwfdecSystem SwfdecSystem;</programlisting>
101
97
<para>
102
98
This is the object used for holding information about the current system. See
103
99
the introduction for details.</para>
104
100
<para>
105
101
 
106
102
</para></refsect2>
107
 
<refsect2>
108
 
<title><anchor id="swfdec-system-new" role="function"/>swfdec_system_new ()</title>
109
 
<indexterm><primary>swfdec_system_new</primary></indexterm><programlisting><link linkend="SwfdecSystem">SwfdecSystem</link>*       swfdec_system_new                   (void);</programlisting>
 
103
<refsect2 id="swfdec-system-new" role="function">
 
104
<title>swfdec_system_new ()</title>
 
105
<indexterm zone="swfdec-system-new"><primary>swfdec_system_new</primary></indexterm><programlisting><link linkend="SwfdecSystem">SwfdecSystem</link>*       swfdec_system_new                   (void);</programlisting>
110
106
<para>
111
107
Creates a new <link linkend="SwfdecSystem"><type>SwfdecSystem</type></link> object using default settings. These settings are 
112
108
mirroring the most common settings used by a Flash player. Currently this is
119
115
</variablelist></refsect2>
120
116
 
121
117
</refsect1>
122
 
<refsect1 role="property_details">
 
118
<refsect1 id="SwfdecSystem.property-details" role="property_details">
123
119
<title role="property_details.title">Property Details</title>
124
 
<refsect2><title><anchor id="SwfdecSystem--color-mode"/>The <literal>&quot;color-mode&quot;</literal> property</title>
125
 
<indexterm><primary>SwfdecSystem:color-mode</primary></indexterm><programlisting>  &quot;color-mode&quot;               <link linkend="gchararray">gchararray</link>            : Read / Write / Construct</programlisting>
 
120
<refsect2 id="SwfdecSystem--color-mode"><title>The <literal>&quot;color-mode&quot;</literal> property</title>
 
121
<indexterm zone="SwfdecSystem--color-mode"><primary>SwfdecSystem:color-mode</primary></indexterm><programlisting>  &quot;color-mode&quot;               <link linkend="gchar">gchar</link>*                : Read / Write / Construct</programlisting>
126
122
<para>"color", "gray" or "bw".</para><para>Default value: "color"</para>
127
123
</refsect2>
128
 
<refsect2><title><anchor id="SwfdecSystem--debugger"/>The <literal>&quot;debugger&quot;</literal> property</title>
129
 
<indexterm><primary>SwfdecSystem:debugger</primary></indexterm><programlisting>  &quot;debugger&quot;                 <link linkend="gboolean">gboolean</link>              : Read / Write / Construct</programlisting>
 
124
<refsect2 id="SwfdecSystem--debugger"><title>The <literal>&quot;debugger&quot;</literal> property</title>
 
125
<indexterm zone="SwfdecSystem--debugger"><primary>SwfdecSystem:debugger</primary></indexterm><programlisting>  &quot;debugger&quot;                 <link linkend="gboolean">gboolean</link>              : Read / Write / Construct</programlisting>
130
126
<para>TRUE if this player is supposed to be a debugger.</para><para>Default value: FALSE</para>
131
127
</refsect2>
132
 
<refsect2><title><anchor id="SwfdecSystem--dpi"/>The <literal>&quot;dpi&quot;</literal> property</title>
133
 
<indexterm><primary>SwfdecSystem:dpi</primary></indexterm><programlisting>  &quot;dpi&quot;                      <link linkend="guint">guint</link>                 : Read / Write / Construct</programlisting>
 
128
<refsect2 id="SwfdecSystem--dpi"><title>The <literal>&quot;dpi&quot;</literal> property</title>
 
129
<indexterm zone="SwfdecSystem--dpi"><primary>SwfdecSystem:dpi</primary></indexterm><programlisting>  &quot;dpi&quot;                      <link linkend="guint">guint</link>                 : Read / Write / Construct</programlisting>
134
130
<para>DPI setting of screen.</para><para>Default value: 96</para>
135
131
</refsect2>
136
 
<refsect2><title><anchor id="SwfdecSystem--language"/>The <literal>&quot;language&quot;</literal> property</title>
137
 
<indexterm><primary>SwfdecSystem:language</primary></indexterm><programlisting>  &quot;language&quot;                 <link linkend="gchararray">gchararray</link>            : Read / Write / Construct</programlisting>
 
132
<refsect2 id="SwfdecSystem--language"><title>The <literal>&quot;language&quot;</literal> property</title>
 
133
<indexterm zone="SwfdecSystem--language"><primary>SwfdecSystem:language</primary></indexterm><programlisting>  &quot;language&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write / Construct</programlisting>
138
134
<para>ISO 639-1 language code.</para><para>Default value: "en"</para>
139
135
</refsect2>
140
 
<refsect2><title><anchor id="SwfdecSystem--manufacturer"/>The <literal>&quot;manufacturer&quot;</literal> property</title>
141
 
<indexterm><primary>SwfdecSystem:manufacturer</primary></indexterm><programlisting>  &quot;manufacturer&quot;             <link linkend="gchararray">gchararray</link>            : Read / Write / Construct</programlisting>
 
136
<refsect2 id="SwfdecSystem--manufacturer"><title>The <literal>&quot;manufacturer&quot;</literal> property</title>
 
137
<indexterm zone="SwfdecSystem--manufacturer"><primary>SwfdecSystem:manufacturer</primary></indexterm><programlisting>  &quot;manufacturer&quot;             <link linkend="gchar">gchar</link>*                : Read / Write / Construct</programlisting>
142
138
<para>string describing the manufacturer of this system.</para><para>Default value: "Macromedia Windows"</para>
143
139
</refsect2>
144
 
<refsect2><title><anchor id="SwfdecSystem--os"/>The <literal>&quot;os&quot;</literal> property</title>
145
 
<indexterm><primary>SwfdecSystem:os</primary></indexterm><programlisting>  &quot;os&quot;                       <link linkend="gchararray">gchararray</link>            : Read / Write / Construct</programlisting>
 
140
<refsect2 id="SwfdecSystem--os"><title>The <literal>&quot;os&quot;</literal> property</title>
 
141
<indexterm zone="SwfdecSystem--os"><primary>SwfdecSystem:os</primary></indexterm><programlisting>  &quot;os&quot;                       <link linkend="gchar">gchar</link>*                : Read / Write / Construct</programlisting>
146
142
<para>description of the operating system.</para><para>Default value: "Windows XP"</para>
147
143
</refsect2>
148
 
<refsect2><title><anchor id="SwfdecSystem--os-type"/>The <literal>&quot;os-type&quot;</literal> property</title>
149
 
<indexterm><primary>SwfdecSystem:os-type</primary></indexterm><programlisting>  &quot;os-type&quot;                  <link linkend="gchararray">gchararray</link>            : Read / Write / Construct</programlisting>
 
144
<refsect2 id="SwfdecSystem--os-type"><title>The <literal>&quot;os-type&quot;</literal> property</title>
 
145
<indexterm zone="SwfdecSystem--os-type"><primary>SwfdecSystem:os-type</primary></indexterm><programlisting>  &quot;os-type&quot;                  <link linkend="gchar">gchar</link>*                : Read / Write / Construct</programlisting>
150
146
<para>the operating system type: WIN, LIN or MAC.</para><para>Default value: "WIN"</para>
151
147
</refsect2>
152
 
<refsect2><title><anchor id="SwfdecSystem--pixel-aspect-ratio"/>The <literal>&quot;pixel-aspect-ratio&quot;</literal> property</title>
153
 
<indexterm><primary>SwfdecSystem:pixel-aspect-ratio</primary></indexterm><programlisting>  &quot;pixel-aspect-ratio&quot;       <link linkend="gdouble">gdouble</link>               : Read / Write / Construct</programlisting>
 
148
<refsect2 id="SwfdecSystem--pixel-aspect-ratio"><title>The <literal>&quot;pixel-aspect-ratio&quot;</literal> property</title>
 
149
<indexterm zone="SwfdecSystem--pixel-aspect-ratio"><primary>SwfdecSystem:pixel-aspect-ratio</primary></indexterm><programlisting>  &quot;pixel-aspect-ratio&quot;       <link linkend="gdouble">gdouble</link>               : Read / Write / Construct</programlisting>
154
150
<para>the screen's pixel aspect ratio.</para><para>Allowed values: &gt;= G_MINDOUBLE</para>
155
151
<para>Default value: 1</para>
156
152
</refsect2>
157
 
<refsect2><title><anchor id="SwfdecSystem--player-type"/>The <literal>&quot;player-type&quot;</literal> property</title>
158
 
<indexterm><primary>SwfdecSystem:player-type</primary></indexterm><programlisting>  &quot;player-type&quot;              <link linkend="gchararray">gchararray</link>            : Read / Write / Construct</programlisting>
 
153
<refsect2 id="SwfdecSystem--player-type"><title>The <literal>&quot;player-type&quot;</literal> property</title>
 
154
<indexterm zone="SwfdecSystem--player-type"><primary>SwfdecSystem:player-type</primary></indexterm><programlisting>  &quot;player-type&quot;              <link linkend="gchar">gchar</link>*                : Read / Write / Construct</programlisting>
159
155
<para>"StandAlone", "External", "PlugIn" or "ActiveX".</para><para>Default value: "StandAlone"</para>
160
156
</refsect2>
161
 
<refsect2><title><anchor id="SwfdecSystem--screen-height"/>The <literal>&quot;screen-height&quot;</literal> property</title>
162
 
<indexterm><primary>SwfdecSystem:screen-height</primary></indexterm><programlisting>  &quot;screen-height&quot;            <link linkend="guint">guint</link>                 : Read / Write / Construct</programlisting>
 
157
<refsect2 id="SwfdecSystem--screen-height"><title>The <literal>&quot;screen-height&quot;</literal> property</title>
 
158
<indexterm zone="SwfdecSystem--screen-height"><primary>SwfdecSystem:screen-height</primary></indexterm><programlisting>  &quot;screen-height&quot;            <link linkend="guint">guint</link>                 : Read / Write / Construct</programlisting>
163
159
<para>height of the screen in pixels.</para><para>Default value: 768</para>
164
160
</refsect2>
165
 
<refsect2><title><anchor id="SwfdecSystem--screen-width"/>The <literal>&quot;screen-width&quot;</literal> property</title>
166
 
<indexterm><primary>SwfdecSystem:screen-width</primary></indexterm><programlisting>  &quot;screen-width&quot;             <link linkend="guint">guint</link>                 : Read / Write / Construct</programlisting>
 
161
<refsect2 id="SwfdecSystem--screen-width"><title>The <literal>&quot;screen-width&quot;</literal> property</title>
 
162
<indexterm zone="SwfdecSystem--screen-width"><primary>SwfdecSystem:screen-width</primary></indexterm><programlisting>  &quot;screen-width&quot;             <link linkend="guint">guint</link>                 : Read / Write / Construct</programlisting>
167
163
<para>width of the screen in pixels.</para><para>Default value: 1024</para>
168
164
</refsect2>
169
 
<refsect2><title><anchor id="SwfdecSystem--server-manufacturer"/>The <literal>&quot;server-manufacturer&quot;</literal> property</title>
170
 
<indexterm><primary>SwfdecSystem:server-manufacturer</primary></indexterm><programlisting>  &quot;server-manufacturer&quot;      <link linkend="gchararray">gchararray</link>            : Read / Write / Construct</programlisting>
 
165
<refsect2 id="SwfdecSystem--server-manufacturer"><title>The <literal>&quot;server-manufacturer&quot;</literal> property</title>
 
166
<indexterm zone="SwfdecSystem--server-manufacturer"><primary>SwfdecSystem:server-manufacturer</primary></indexterm><programlisting>  &quot;server-manufacturer&quot;      <link linkend="gchar">gchar</link>*                : Read / Write / Construct</programlisting>
171
167
<para>manufacturer of this system as used in serverString.</para><para>Default value: "Adobe Windows"</para>
172
168
</refsect2>
173
 
<refsect2><title><anchor id="SwfdecSystem--utc-offset"/>The <literal>&quot;utc-offset&quot;</literal> property</title>
174
 
<indexterm><primary>SwfdecSystem:utc-offset</primary></indexterm><programlisting>  &quot;utc-offset&quot;               <link linkend="gint">gint</link>                  : Read / Write / Construct</programlisting>
 
169
<refsect2 id="SwfdecSystem--utc-offset"><title>The <literal>&quot;utc-offset&quot;</literal> property</title>
 
170
<indexterm zone="SwfdecSystem--utc-offset"><primary>SwfdecSystem:utc-offset</primary></indexterm><programlisting>  &quot;utc-offset&quot;               <link linkend="gint">gint</link>                  : Read / Write / Construct</programlisting>
175
171
<para>Difference between UTC and local timezone in minutes.</para><para>Allowed values: [-720,720]</para>
176
172
<para>Default value: 0</para>
177
173
</refsect2>
178
 
<refsect2><title><anchor id="SwfdecSystem--version"/>The <literal>&quot;version&quot;</literal> property</title>
179
 
<indexterm><primary>SwfdecSystem:version</primary></indexterm><programlisting>  &quot;version&quot;                  <link linkend="gchararray">gchararray</link>            : Read / Write / Construct</programlisting>
 
174
<refsect2 id="SwfdecSystem--version"><title>The <literal>&quot;version&quot;</literal> property</title>
 
175
<indexterm zone="SwfdecSystem--version"><primary>SwfdecSystem:version</primary></indexterm><programlisting>  &quot;version&quot;                  <link linkend="gchar">gchar</link>*                : Read / Write / Construct</programlisting>
180
176
<para>version string.</para><para>Default value: "WIN 9,0,100,0"</para>
181
177
</refsect2>
182
178
 
184
180
 
185
181
 
186
182
 
187
 
<refsect1>
 
183
<refsect1 id="SwfdecSystem.see-also">
188
184
<title>See Also</title>
189
185
SwfdecPlayer
190
186
</refsect1>
191
187
 
192
 
 
193
 
<refsect1><refsect2 /><refsect2 /></refsect1>
194
188
</refentry>