← Back to branch summary

~ubuntu-branches/debian/experimental/gupnp/experimental

« back to all changes in this revision

Viewing changes to doc/xml/gupnp-root-device.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ross Burton
  • Date: 2008-06-30 09:32:18 UTC
  • mfrom: (1.2.1 upstream) (2.1.5 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080630093218-vmb4elru8cn18579
Tags: 0.12.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/gupnp-root-device.xml
1
1
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY version SYSTEM "version.xml">               
5
 
]>
6
 
<refentry id="gupnp-GUPnPRootDevice">
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
3
<refentry id="GUPnPRootDevice">
7
4
<refmeta>
8
 
<refentrytitle role="top_of_page">GUPnPRootDevice</refentrytitle>
 
5
<refentrytitle role="top_of_page" id="GUPnPRootDevice.top_of_page">GUPnPRootDevice</refentrytitle>
9
6
<manvolnum>3</manvolnum>
10
7
<refmiscinfo>GUPNP Library</refmiscinfo>
11
8
</refmeta>
16
13
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
14
</refnamediv>
18
15
 
19
 
<refsynopsisdiv role="synopsis">
 
16
<refsynopsisdiv id="GUPnPRootDevice.synopsis" role="synopsis">
20
17
<title role="synopsis.title">Synopsis</title>
21
18
 
22
19
<synopsis>
23
 
 
24
 
 
25
 
 
26
 
                    <link linkend="GUPnPRootDevice">GUPnPRootDevice</link>;
 
20
                    <link linkend="GUPnPRootDevice-struct">GUPnPRootDevice</link>;
27
21
<link linkend="GUPnPRootDevice">GUPnPRootDevice</link>*    <link linkend="gupnp-root-device-new">gupnp_root_device_new</link>               (<link linkend="GUPnPContext">GUPnPContext</link> *context,
 
22
                                                         const <link linkend="char">char</link> *relative_location);
 
23
<link linkend="GUPnPRootDevice">GUPnPRootDevice</link>*    <link linkend="gupnp-root-device-new-full">gupnp_root_device_new_full</link>          (<link linkend="GUPnPContext">GUPnPContext</link> *context,
 
24
                                                         <link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link> *factory,
28
25
                                                         <link linkend="xmlDoc">xmlDoc</link> *description_doc,
29
26
                                                         const <link linkend="char">char</link> *relative_location);
30
27
<link linkend="void">void</link>                <link linkend="gupnp-root-device-set-available">gupnp_root_device_set_available</link>     (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device,
32
29
<link linkend="gboolean">gboolean</link>            <link linkend="gupnp-root-device-get-available">gupnp_root_device_get_available</link>     (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device);
33
30
const <link linkend="char">char</link>*         <link linkend="gupnp-root-device-get-relative-location">gupnp_root_device_get_relative_location</link>
34
31
                                                        (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device);
35
 
 
36
 
 
37
32
</synopsis>
38
33
</refsynopsisdiv>
39
34
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
 
<refsect1 role="desc">
 
35
<refsect1 id="GUPnPRootDevice.object-hierarchy" role="object_hierarchy">
 
36
<title role="object_hierarchy.title">Object Hierarchy</title>
 
37
<synopsis>
 
38
  <link linkend="GObject">GObject</link>
 
39
   +----<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link>
 
40
         +----<link linkend="GUPnPDevice">GUPnPDevice</link>
 
41
               +----GUPnPRootDevice
 
42
</synopsis>
 
43
 
 
44
</refsect1>
 
45
 
 
46
 
 
47
 
 
48
 
 
49
 
 
50
<refsect1 id="GUPnPRootDevice.properties" role="properties">
 
51
<title role="properties.title">Properties</title>
 
52
<synopsis>
 
53
  &quot;<link linkend="GUPnPRootDevice--available">available</link>&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write
 
54
  &quot;<link linkend="GUPnPRootDevice--description-doc">description-doc</link>&quot;          <link linkend="gpointer">gpointer</link>              : Write / Construct Only
 
55
  &quot;<link linkend="GUPnPRootDevice--relative-location">relative-location</link>&quot;        <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
 
56
</synopsis>
 
57
</refsect1>
 
58
 
 
59
 
 
60
 
 
61
<refsect1 id="GUPnPRootDevice.description" role="desc">
49
62
<title role="desc.title">Description</title>
50
63
<para>
51
64
<link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link> allows for implementing root devices.</para>
54
67
</para>
55
68
</refsect1>
56
69
 
57
 
<refsect1 role="details">
 
70
<refsect1 id="GUPnPRootDevice.details" role="details">
58
71
<title role="details.title">Details</title>
59
 
<refsect2>
60
 
<title><anchor id="GUPnPRootDevice" role="struct"/>GUPnPRootDevice</title>
61
 
<indexterm><primary>GUPnPRootDevice</primary></indexterm><programlisting>typedef struct {
62
 
        GUPnPDevice parent;
63
 
 
64
 
        GUPnPRootDevicePrivate *priv;
65
 
} GUPnPRootDevice;
66
 
</programlisting>
 
72
<refsect2 id="GUPnPRootDevice-struct" role="struct">
 
73
<title>GUPnPRootDevice</title>
 
74
<indexterm zone="GUPnPRootDevice-struct"><primary>GUPnPRootDevice</primary></indexterm><programlisting>typedef struct _GUPnPRootDevice GUPnPRootDevice;</programlisting>
 
75
<para>
 
76
This struct contains private data only, and should be accessed using the
 
77
functions below.</para>
67
78
<para>
68
79
 
69
80
</para></refsect2>
70
 
<refsect2>
71
 
<title><anchor id="gupnp-root-device-new" role="function"/>gupnp_root_device_new ()</title>
72
 
<indexterm><primary>gupnp_root_device_new</primary></indexterm><programlisting><link linkend="GUPnPRootDevice">GUPnPRootDevice</link>*    gupnp_root_device_new               (<link linkend="GUPnPContext">GUPnPContext</link> *context,
73
 
                                                         <link linkend="xmlDoc">xmlDoc</link> *description_doc,
 
81
<refsect2 id="gupnp-root-device-new" role="function">
 
82
<title>gupnp_root_device_new ()</title>
 
83
<indexterm zone="gupnp-root-device-new"><primary>gupnp_root_device_new</primary></indexterm><programlisting><link linkend="GUPnPRootDevice">GUPnPRootDevice</link>*    gupnp_root_device_new               (<link linkend="GUPnPContext">GUPnPContext</link> *context,
74
84
                                                         const <link linkend="char">char</link> *relative_location);</programlisting>
75
85
<para>
76
 
Create a new <link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link> object.</para>
 
86
Create a new <link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link> object, automatically downloading and
 
87
parsing <parameter>relative_location</parameter>.</para>
77
88
<para>
78
89
 
79
90
</para><variablelist role="params">
80
91
<varlistentry><term><parameter>context</parameter>&nbsp;:</term>
81
92
<listitem><simpara> The <link linkend="GUPnPContext"><type>GUPnPContext</type></link>
82
93
</simpara></listitem></varlistentry>
 
94
<varlistentry><term><parameter>relative_location</parameter>&nbsp;:</term>
 
95
<listitem><simpara> Location of the description file for this device,
 
96
relative to the HTTP root
 
97
</simpara></listitem></varlistentry>
 
98
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <parameter>GUPnPRootDevice</parameter> object.
 
99
</simpara></listitem></varlistentry>
 
100
</variablelist></refsect2>
 
101
<refsect2 id="gupnp-root-device-new-full" role="function">
 
102
<title>gupnp_root_device_new_full ()</title>
 
103
<indexterm zone="gupnp-root-device-new-full"><primary>gupnp_root_device_new_full</primary></indexterm><programlisting><link linkend="GUPnPRootDevice">GUPnPRootDevice</link>*    gupnp_root_device_new_full          (<link linkend="GUPnPContext">GUPnPContext</link> *context,
 
104
                                                         <link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link> *factory,
 
105
                                                         <link linkend="xmlDoc">xmlDoc</link> *description_doc,
 
106
                                                         const <link linkend="char">char</link> *relative_location);</programlisting>
 
107
<para>
 
108
Create a new <link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link>, automatically downloading and parsing
 
109
<parameter>relative_location</parameter> if <parameter>description_doc</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
 
110
<para>
 
111
 
 
112
</para><variablelist role="params">
 
113
<varlistentry><term><parameter>context</parameter>&nbsp;:</term>
 
114
<listitem><simpara> A <link linkend="GUPnPContext"><type>GUPnPContext</type></link>
 
115
</simpara></listitem></varlistentry>
 
116
<varlistentry><term><parameter>factory</parameter>&nbsp;:</term>
 
117
<listitem><simpara> A <link linkend="GUPnPResourceFactory"><type>GUPnPResourceFactory</type></link>
 
118
</simpara></listitem></varlistentry>
83
119
<varlistentry><term><parameter>description_doc</parameter>&nbsp;:</term>
84
 
<listitem><simpara> Pointer to the device description document
 
120
<listitem><simpara> Pointer to the device description document, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
85
121
</simpara></listitem></varlistentry>
86
122
<varlistentry><term><parameter>relative_location</parameter>&nbsp;:</term>
87
 
<listitem><simpara> Location to use for this device, relative to the
88
 
HTTP root
 
123
<listitem><simpara> Location of the description file for this device,
 
124
relative to the HTTP root
89
125
</simpara></listitem></varlistentry>
90
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <parameter>GUPnPRootDevice</parameter> object.
 
126
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link> object.
91
127
</simpara></listitem></varlistentry>
92
128
</variablelist></refsect2>
93
 
<refsect2>
94
 
<title><anchor id="gupnp-root-device-set-available" role="function"/>gupnp_root_device_set_available ()</title>
95
 
<indexterm><primary>gupnp_root_device_set_available</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_root_device_set_available     (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device,
 
129
<refsect2 id="gupnp-root-device-set-available" role="function">
 
130
<title>gupnp_root_device_set_available ()</title>
 
131
<indexterm zone="gupnp-root-device-set-available"><primary>gupnp_root_device_set_available</primary></indexterm><programlisting><link linkend="void">void</link>                gupnp_root_device_set_available     (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device,
96
132
                                                         <link linkend="gboolean">gboolean</link> available);</programlisting>
97
133
<para>
98
134
Controls whether or not <parameter>root_device</parameter> is available (announcing
104
140
<listitem><simpara> A <link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link>
105
141
</simpara></listitem></varlistentry>
106
142
<varlistentry><term><parameter>available</parameter>&nbsp;:</term>
107
 
<listitem><simpara> TRUE if <parameter>root_device</parameter> should be available
 
143
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>root_device</parameter> should be available
108
144
</simpara></listitem></varlistentry>
109
145
</variablelist></refsect2>
110
 
<refsect2>
111
 
<title><anchor id="gupnp-root-device-get-available" role="function"/>gupnp_root_device_get_available ()</title>
112
 
<indexterm><primary>gupnp_root_device_get_available</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gupnp_root_device_get_available     (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device);</programlisting>
 
146
<refsect2 id="gupnp-root-device-get-available" role="function">
 
147
<title>gupnp_root_device_get_available ()</title>
 
148
<indexterm zone="gupnp-root-device-get-available"><primary>gupnp_root_device_get_available</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gupnp_root_device_get_available     (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device);</programlisting>
113
149
<para>
114
 
</para>
 
150
Get whether or not <parameter>root_device</parameter> is available (announcing its presence).</para>
115
151
<para>
116
152
 
117
153
</para><variablelist role="params">
118
154
<varlistentry><term><parameter>root_device</parameter>&nbsp;:</term>
119
155
<listitem><simpara> A <link linkend="GUPnPRootDevice"><type>GUPnPRootDevice</type></link>
120
156
</simpara></listitem></varlistentry>
121
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if <parameter>root_device</parameter> is available.
 
157
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>root_device</parameter> is available, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
122
158
</simpara></listitem></varlistentry>
123
159
</variablelist></refsect2>
124
 
<refsect2>
125
 
<title><anchor id="gupnp-root-device-get-relative-location" role="function"/>gupnp_root_device_get_relative_location ()</title>
126
 
<indexterm><primary>gupnp_root_device_get_relative_location</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_root_device_get_relative_location
 
160
<refsect2 id="gupnp-root-device-get-relative-location" role="function">
 
161
<title>gupnp_root_device_get_relative_location ()</title>
 
162
<indexterm zone="gupnp-root-device-get-relative-location"><primary>gupnp_root_device_get_relative_location</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_root_device_get_relative_location
127
163
                                                        (<link linkend="GUPnPRootDevice">GUPnPRootDevice</link> *root_device);</programlisting>
128
164
<para>
129
 
</para>
 
165
Get the relative location of <parameter>root_device</parameter>.</para>
130
166
<para>
131
167
 
132
168
</para><variablelist role="params">
138
174
</variablelist></refsect2>
139
175
 
140
176
</refsect1>
 
177
<refsect1 id="GUPnPRootDevice.property-details" role="property_details">
 
178
<title role="property_details.title">Property Details</title>
 
179
<refsect2 id="GUPnPRootDevice--available"><title>The <literal>&quot;available&quot;</literal> property</title>
 
180
<indexterm zone="GUPnPRootDevice--available"><primary>GUPnPRootDevice:available</primary></indexterm><programlisting>  &quot;available&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
181
<para>
 
182
TRUE if this device is available.</para>
 
183
<para>
 
184
 
 
185
</para><para>Default value: FALSE</para>
 
186
</refsect2>
 
187
<refsect2 id="GUPnPRootDevice--description-doc"><title>The <literal>&quot;description-doc&quot;</literal> property</title>
 
188
<indexterm zone="GUPnPRootDevice--description-doc"><primary>GUPnPRootDevice:description-doc</primary></indexterm><programlisting>  &quot;description-doc&quot;          <link linkend="gpointer">gpointer</link>              : Write / Construct Only</programlisting>
 
189
<para>
 
190
Pointer to description document. Constructor property.</para>
 
191
<para>
 
192
 
 
193
</para></refsect2>
 
194
<refsect2 id="GUPnPRootDevice--relative-location"><title>The <literal>&quot;relative-location&quot;</literal> property</title>
 
195
<indexterm zone="GUPnPRootDevice--relative-location"><primary>GUPnPRootDevice:relative-location</primary></indexterm><programlisting>  &quot;relative-location&quot;        <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
 
196
<para>
 
197
Relative location.</para>
 
198
<para>
 
199
 
 
200
</para><para>Default value: NULL</para>
 
201
</refsect2>
 
202
 
 
203
</refsect1>
141
204
 
142
205
 
143
206