~ubuntu-branches/ubuntu/utopic/rhythmbox/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/reference/xml/disclosure-widget.xml

Tags: upstream-0.9.2
ImportĀ upstreamĀ versionĀ 0.9.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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
<refentry id="rhythmbox-CDDBDisclosure">
 
5
<refmeta>
 
6
<refentrytitle>CDDBDisclosure</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>CDDBDisclosure</refname><refpurpose></refpurpose>
 
13
</refnamediv>
 
14
 
 
15
<refsynopsisdiv><title>Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
#define     <link linkend="CDDB-DISCLOSURE-TYPE:CAPS">CDDB_DISCLOSURE_TYPE</link>
 
22
#define     <link linkend="CDDB-DISCLOSURE:CAPS">CDDB_DISCLOSURE</link>                 (obj)
 
23
#define     <link linkend="CDDB-DISCLOSURE-CLASS:CAPS">CDDB_DISCLOSURE_CLASS</link>           (klass)
 
24
#define     <link linkend="IS-CDDB-DISCLOSURE:CAPS">IS_CDDB_DISCLOSURE</link>              (obj)
 
25
#define     <link linkend="IS-CDDB-DISCLOSURE-CLASS:CAPS">IS_CDDB_DISCLOSURE_CLASS</link>        (klass)
 
26
typedef     <link linkend="CDDBDisclosurePrivate">CDDBDisclosurePrivate</link>;
 
27
<link linkend="GType">GType</link>       <link linkend="cddb-disclosure-get-type">cddb_disclosure_get_type</link>        (void);
 
28
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="cddb-disclosure-new">cddb_disclosure_new</link>             (const <link linkend="char">char</link> *shown,
 
29
                                             const <link linkend="char">char</link> *hidden);
 
30
<link linkend="void">void</link>        <link linkend="cddb-disclosure-set-container">cddb_disclosure_set_container</link>   (<link linkend="CDDBDisclosure">CDDBDisclosure</link> *cddb,
 
31
                                             <link linkend="GtkWidget">GtkWidget</link> *widget);
 
32
<link linkend="void">void</link>        <link linkend="cddb-disclosure-set-labels">cddb_disclosure_set_labels</link>      (<link linkend="CDDBDisclosure">CDDBDisclosure</link> *cddb,
 
33
                                             const <link linkend="char">char</link> *label_when_shown,
 
34
                                             const <link linkend="char">char</link> *label_when_hidden);
 
35
</synopsis>
 
36
</refsynopsisdiv>
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
<refsect1>
 
47
<title>Description</title>
 
48
<para>
 
49
 
 
50
</para>
 
51
</refsect1>
 
52
 
 
53
<refsect1>
 
54
<title>Details</title>
 
55
<refsect2>
 
56
<title><anchor id="CDDB-DISCLOSURE-TYPE:CAPS"/>CDDB_DISCLOSURE_TYPE</title>
 
57
<indexterm><primary>CDDB_DISCLOSURE_TYPE</primary></indexterm><programlisting>#define CDDB_DISCLOSURE_TYPE (cddb_disclosure_get_type ())
 
58
</programlisting>
 
59
<para>
 
60
 
 
61
</para></refsect2>
 
62
<refsect2>
 
63
<title><anchor id="CDDB-DISCLOSURE:CAPS"/>CDDB_DISCLOSURE()</title>
 
64
<indexterm><primary>CDDB_DISCLOSURE</primary></indexterm><programlisting>#define CDDB_DISCLOSURE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CDDB_DISCLOSURE_TYPE, CDDBDisclosure))
 
65
</programlisting>
 
66
<para>
 
67
 
 
68
</para><variablelist role="params">
 
69
<varlistentry><term><parameter>obj</parameter>&nbsp;:</term>
 
70
<listitem><simpara>
 
71
 
 
72
 
 
73
</simpara></listitem></varlistentry>
 
74
</variablelist></refsect2>
 
75
<refsect2>
 
76
<title><anchor id="CDDB-DISCLOSURE-CLASS:CAPS"/>CDDB_DISCLOSURE_CLASS()</title>
 
77
<indexterm><primary>CDDB_DISCLOSURE_CLASS</primary></indexterm><programlisting>#define CDDB_DISCLOSURE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CDDB_DISCLOSURE_TYPE, CDDBDisclosureClass))
 
78
</programlisting>
 
79
<para>
 
80
 
 
81
</para><variablelist role="params">
 
82
<varlistentry><term><parameter>klass</parameter>&nbsp;:</term>
 
83
<listitem><simpara>
 
84
 
 
85
 
 
86
</simpara></listitem></varlistentry>
 
87
</variablelist></refsect2>
 
88
<refsect2>
 
89
<title><anchor id="IS-CDDB-DISCLOSURE:CAPS"/>IS_CDDB_DISCLOSURE()</title>
 
90
<indexterm><primary>IS_CDDB_DISCLOSURE</primary></indexterm><programlisting>#define IS_CDDB_DISCLOSURE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CDDB_DISCLOSURE_TYPE))
 
91
</programlisting>
 
92
<para>
 
93
 
 
94
</para><variablelist role="params">
 
95
<varlistentry><term><parameter>obj</parameter>&nbsp;:</term>
 
96
<listitem><simpara>
 
97
 
 
98
 
 
99
</simpara></listitem></varlistentry>
 
100
</variablelist></refsect2>
 
101
<refsect2>
 
102
<title><anchor id="IS-CDDB-DISCLOSURE-CLASS:CAPS"/>IS_CDDB_DISCLOSURE_CLASS()</title>
 
103
<indexterm><primary>IS_CDDB_DISCLOSURE_CLASS</primary></indexterm><programlisting>#define IS_CDDB_DISCLOSURE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CDDB_DISCLOSURE_TYPE))
 
104
</programlisting>
 
105
<para>
 
106
 
 
107
</para><variablelist role="params">
 
108
<varlistentry><term><parameter>klass</parameter>&nbsp;:</term>
 
109
<listitem><simpara>
 
110
 
 
111
 
 
112
</simpara></listitem></varlistentry>
 
113
</variablelist></refsect2>
 
114
<refsect2>
 
115
<title><anchor id="CDDBDisclosurePrivate"/>CDDBDisclosurePrivate</title>
 
116
<indexterm><primary>CDDBDisclosurePrivate</primary></indexterm><programlisting>typedef struct CDDBDisclosurePrivate CDDBDisclosurePrivate;
 
117
</programlisting>
 
118
<para>
 
119
 
 
120
</para></refsect2>
 
121
<refsect2>
 
122
<title><anchor id="cddb-disclosure-get-type"/>cddb_disclosure_get_type ()</title>
 
123
<indexterm><primary>cddb_disclosure_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>       cddb_disclosure_get_type        (void);</programlisting>
 
124
<para>
 
125
 
 
126
</para><variablelist role="params">
 
127
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
128
 
 
129
 
 
130
</simpara></listitem></varlistentry>
 
131
</variablelist></refsect2>
 
132
<refsect2>
 
133
<title><anchor id="cddb-disclosure-new"/>cddb_disclosure_new ()</title>
 
134
<indexterm><primary>cddb_disclosure_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  cddb_disclosure_new             (const <link linkend="char">char</link> *shown,
 
135
                                             const <link linkend="char">char</link> *hidden);</programlisting>
 
136
<para>
 
137
 
 
138
</para><variablelist role="params">
 
139
<varlistentry><term><parameter>shown</parameter>&nbsp;:</term>
 
140
<listitem><simpara>
 
141
</simpara></listitem></varlistentry>
 
142
<varlistentry><term><parameter>hidden</parameter>&nbsp;:</term>
 
143
<listitem><simpara>
 
144
</simpara></listitem></varlistentry>
 
145
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
146
 
 
147
 
 
148
</simpara></listitem></varlistentry>
 
149
</variablelist></refsect2>
 
150
<refsect2>
 
151
<title><anchor id="cddb-disclosure-set-container"/>cddb_disclosure_set_container ()</title>
 
152
<indexterm><primary>cddb_disclosure_set_container</primary></indexterm><programlisting><link linkend="void">void</link>        cddb_disclosure_set_container   (<link linkend="CDDBDisclosure">CDDBDisclosure</link> *cddb,
 
153
                                             <link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
 
154
<para>
 
155
 
 
156
</para><variablelist role="params">
 
157
<varlistentry><term><parameter>cddb</parameter>&nbsp;:</term>
 
158
<listitem><simpara>
 
159
</simpara></listitem></varlistentry>
 
160
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
161
<listitem><simpara>
 
162
 
 
163
 
 
164
</simpara></listitem></varlistentry>
 
165
</variablelist></refsect2>
 
166
<refsect2>
 
167
<title><anchor id="cddb-disclosure-set-labels"/>cddb_disclosure_set_labels ()</title>
 
168
<indexterm><primary>cddb_disclosure_set_labels</primary></indexterm><programlisting><link linkend="void">void</link>        cddb_disclosure_set_labels      (<link linkend="CDDBDisclosure">CDDBDisclosure</link> *cddb,
 
169
                                             const <link linkend="char">char</link> *label_when_shown,
 
170
                                             const <link linkend="char">char</link> *label_when_hidden);</programlisting>
 
171
<para>
 
172
 
 
173
</para><variablelist role="params">
 
174
<varlistentry><term><parameter>cddb</parameter>&nbsp;:</term>
 
175
<listitem><simpara>
 
176
</simpara></listitem></varlistentry>
 
177
<varlistentry><term><parameter>label_when_shown</parameter>&nbsp;:</term>
 
178
<listitem><simpara>
 
179
</simpara></listitem></varlistentry>
 
180
<varlistentry><term><parameter>label_when_hidden</parameter>&nbsp;:</term>
 
181
<listitem><simpara>
 
182
 
 
183
 
 
184
</simpara></listitem></varlistentry>
 
185
</variablelist></refsect2>
 
186
 
 
187
</refsect1>
 
188
 
 
189
 
 
190
 
 
191
 
 
192
</refentry>