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

« back to all changes in this revision

Viewing changes to doc/reference/xml/bacon-volume.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-BaconVolumeButton">
 
5
<refmeta>
 
6
<refentrytitle>BaconVolumeButton</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>BaconVolumeButton</refname><refpurpose></refpurpose>
 
13
</refnamediv>
 
14
 
 
15
<refsynopsisdiv><title>Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
#define     <link linkend="BACON-TYPE-VOLUME-BUTTON:CAPS">BACON_TYPE_VOLUME_BUTTON</link>
 
22
#define     <link linkend="BACON-VOLUME-BUTTON:CAPS">BACON_VOLUME_BUTTON</link>             (obj)
 
23
<link linkend="GType">GType</link>       <link linkend="bacon-volume-button-get-type">bacon_volume_button_get_type</link>    (void);
 
24
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="bacon-volume-button-new">bacon_volume_button_new</link>         (<link linkend="GtkIconSize">GtkIconSize</link> size,
 
25
                                             <link linkend="float">float</link> min,
 
26
                                             <link linkend="float">float</link> max,
 
27
                                             <link linkend="float">float</link> step);
 
28
<link linkend="float">float</link>       <link linkend="bacon-volume-button-get-value">bacon_volume_button_get_value</link>   (<link linkend="BaconVolumeButton">BaconVolumeButton</link> *button);
 
29
<link linkend="void">void</link>        <link linkend="bacon-volume-button-set-value">bacon_volume_button_set_value</link>   (<link linkend="BaconVolumeButton">BaconVolumeButton</link> *button,
 
30
                                             <link linkend="float">float</link> value);
 
31
</synopsis>
 
32
</refsynopsisdiv>
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
<refsect1>
 
43
<title>Description</title>
 
44
<para>
 
45
 
 
46
</para>
 
47
</refsect1>
 
48
 
 
49
<refsect1>
 
50
<title>Details</title>
 
51
<refsect2>
 
52
<title><anchor id="BACON-TYPE-VOLUME-BUTTON:CAPS"/>BACON_TYPE_VOLUME_BUTTON</title>
 
53
<indexterm><primary>BACON_TYPE_VOLUME_BUTTON</primary></indexterm><programlisting>#define     BACON_TYPE_VOLUME_BUTTON</programlisting>
 
54
<para>
 
55
 
 
56
</para></refsect2>
 
57
<refsect2>
 
58
<title><anchor id="BACON-VOLUME-BUTTON:CAPS"/>BACON_VOLUME_BUTTON()</title>
 
59
<indexterm><primary>BACON_VOLUME_BUTTON</primary></indexterm><programlisting>#define     BACON_VOLUME_BUTTON(obj)</programlisting>
 
60
<para>
 
61
 
 
62
</para><variablelist role="params">
 
63
<varlistentry><term><parameter>obj</parameter>&nbsp;:</term>
 
64
<listitem><simpara>
 
65
 
 
66
 
 
67
</simpara></listitem></varlistentry>
 
68
</variablelist></refsect2>
 
69
<refsect2>
 
70
<title><anchor id="bacon-volume-button-get-type"/>bacon_volume_button_get_type ()</title>
 
71
<indexterm><primary>bacon_volume_button_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>       bacon_volume_button_get_type    (void);</programlisting>
 
72
<para>
 
73
 
 
74
</para><variablelist role="params">
 
75
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
76
 
 
77
 
 
78
</simpara></listitem></varlistentry>
 
79
</variablelist></refsect2>
 
80
<refsect2>
 
81
<title><anchor id="bacon-volume-button-new"/>bacon_volume_button_new ()</title>
 
82
<indexterm><primary>bacon_volume_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  bacon_volume_button_new         (<link linkend="GtkIconSize">GtkIconSize</link> size,
 
83
                                             <link linkend="float">float</link> min,
 
84
                                             <link linkend="float">float</link> max,
 
85
                                             <link linkend="float">float</link> step);</programlisting>
 
86
<para>
 
87
 
 
88
</para><variablelist role="params">
 
89
<varlistentry><term><parameter>size</parameter>&nbsp;:</term>
 
90
<listitem><simpara>
 
91
</simpara></listitem></varlistentry>
 
92
<varlistentry><term><parameter>min</parameter>&nbsp;:</term>
 
93
<listitem><simpara>
 
94
</simpara></listitem></varlistentry>
 
95
<varlistentry><term><parameter>max</parameter>&nbsp;:</term>
 
96
<listitem><simpara>
 
97
</simpara></listitem></varlistentry>
 
98
<varlistentry><term><parameter>step</parameter>&nbsp;:</term>
 
99
<listitem><simpara>
 
100
</simpara></listitem></varlistentry>
 
101
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
102
 
 
103
 
 
104
</simpara></listitem></varlistentry>
 
105
</variablelist></refsect2>
 
106
<refsect2>
 
107
<title><anchor id="bacon-volume-button-get-value"/>bacon_volume_button_get_value ()</title>
 
108
<indexterm><primary>bacon_volume_button_get_value</primary></indexterm><programlisting><link linkend="float">float</link>       bacon_volume_button_get_value   (<link linkend="BaconVolumeButton">BaconVolumeButton</link> *button);</programlisting>
 
109
<para>
 
110
 
 
111
</para><variablelist role="params">
 
112
<varlistentry><term><parameter>button</parameter>&nbsp;:</term>
 
113
<listitem><simpara>
 
114
</simpara></listitem></varlistentry>
 
115
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
116
 
 
117
 
 
118
</simpara></listitem></varlistentry>
 
119
</variablelist></refsect2>
 
120
<refsect2>
 
121
<title><anchor id="bacon-volume-button-set-value"/>bacon_volume_button_set_value ()</title>
 
122
<indexterm><primary>bacon_volume_button_set_value</primary></indexterm><programlisting><link linkend="void">void</link>        bacon_volume_button_set_value   (<link linkend="BaconVolumeButton">BaconVolumeButton</link> *button,
 
123
                                             <link linkend="float">float</link> value);</programlisting>
 
124
<para>
 
125
 
 
126
</para><variablelist role="params">
 
127
<varlistentry><term><parameter>button</parameter>&nbsp;:</term>
 
128
<listitem><simpara>
 
129
</simpara></listitem></varlistentry>
 
130
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
131
<listitem><simpara>
 
132
 
 
133
 
 
134
</simpara></listitem></varlistentry>
 
135
</variablelist></refsect2>
 
136
 
 
137
</refsect1>
 
138
 
 
139
 
 
140
 
 
141
 
 
142
</refentry>