← Back to branch summary

~mfisch/brasero/update-to-3.8.0

« back to all changes in this revision

Viewing changes to docs/reference/xml/brasero-medium-selection.xml

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Moog
  • Date: 2009-07-28 01:12:27 UTC
  • mto: (1.4.1 experimental)
  • mto: This revision was merged to the branch mainline in revision 46.
  • Revision ID: james.westby@ubuntu.com-20090728011227-tiva9yorc5d1r5hs
Tags: upstream-2.27.5
Import upstream version 2.27.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/brasero-medium-selection.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
 
3
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
 
4
[
 
5
  <!ENTITY version SYSTEM "version.xml">
 
6
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
 
7
]>
 
8
 
 
9
<refentry id="BraseroMediumSelection">
 
10
<refmeta>
 
11
<refentrytitle role="top_of_page" id="BraseroMediumSelection.top_of_page">BraseroMediumSelection</refentrytitle>
 
12
<manvolnum>3</manvolnum>
 
13
<refmiscinfo>BRASERO Library</refmiscinfo>
 
14
</refmeta>
 
15
 
 
16
<refnamediv>
 
17
<refname>BraseroMediumSelection</refname>
 
18
<refpurpose></refpurpose>
 
19
</refnamediv>
 
20
 
 
21
<refsynopsisdiv id="BraseroMediumSelection.synopsis" role="synopsis">
 
22
<title role="synopsis.title">Synopsis</title>
 
23
 
 
24
<synopsis>
 
25
                    <link linkend="BraseroMediumSelection-struct">BraseroMediumSelection</link>;
 
26
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="brasero-medium-selection-new">brasero_medium_selection_new</link>        (void);
 
27
<link linkend="BraseroMedium">BraseroMedium</link> *     <link linkend="brasero-medium-selection-get-active">brasero_medium_selection_get_active</link> (<link linkend="BraseroMediumSelection">BraseroMediumSelection</link> *selector);
 
28
<link linkend="gboolean">gboolean</link>            <link linkend="brasero-medium-selection-set-active">brasero_medium_selection_set_active</link> (<link linkend="BraseroMediumSelection">BraseroMediumSelection</link> *selector,
 
29
                                                         <link linkend="BraseroMedium">BraseroMedium</link> *medium);
 
30
<link linkend="void">void</link>                <link linkend="brasero-medium-selection-show-media-type">brasero_medium_selection_show_media_type</link>
 
31
                                                        (<link linkend="BraseroMediumSelection">BraseroMediumSelection</link> *selector,
 
32
                                                         <link linkend="BraseroMediaType">BraseroMediaType</link> type);
 
33
</synopsis>
 
34
</refsynopsisdiv>
 
35
 
 
36
<refsect1 id="BraseroMediumSelection.object-hierarchy" role="object_hierarchy">
 
37
<title role="object_hierarchy.title">Object Hierarchy</title>
 
38
<synopsis>
 
39
  <link linkend="GObject">GObject</link>
 
40
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
41
         +----<link linkend="GtkObject">GtkObject</link>
 
42
               +----<link linkend="GtkWidget">GtkWidget</link>
 
43
                     +----<link linkend="GtkContainer">GtkContainer</link>
 
44
                           +----<link linkend="GtkBin">GtkBin</link>
 
45
                                 +----<link linkend="GtkComboBox">GtkComboBox</link>
 
46
                                       +----BraseroMediumSelection
 
47
</synopsis>
 
48
</refsect1>
 
49
 
 
50
 
 
51
 
 
52
<refsect1 id="BraseroMediumSelection.implemented-interfaces" role="impl_interfaces">
 
53
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
54
<para>
 
55
BraseroMediumSelection implements
 
56
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="GtkCellLayout">GtkCellLayout</link> and  <link linkend="GtkCellEditable">GtkCellEditable</link>.</para>
 
57
</refsect1>
 
58
 
 
59
 
 
60
<refsect1 id="BraseroMediumSelection.properties" role="properties">
 
61
<title role="properties.title">Properties</title>
 
62
<synopsis>
 
63
  &quot;<link linkend="BraseroMediumSelection--media-type">media-type</link>&quot;               <link linkend="guint">guint</link>                 : Read / Write
 
64
  &quot;<link linkend="BraseroMediumSelection--medium">medium</link>&quot;                   <link linkend="BraseroMedium">BraseroMedium</link>*        : Read / Write
 
65
</synopsis>
 
66
</refsect1>
 
67
 
 
68
<refsect1 id="BraseroMediumSelection.signals" role="signal_proto">
 
69
<title role="signal_proto.title">Signals</title>
 
70
<synopsis>
 
71
  &quot;<link linkend="BraseroMediumSelection-medium-changed">medium-changed</link>&quot;                                 : Run First / No Recursion / Action
 
72
</synopsis>
 
73
</refsect1>
 
74
 
 
75
 
 
76
<refsect1 id="BraseroMediumSelection.description" role="desc">
 
77
<title role="desc.title">Description</title>
 
78
<para>
 
79
</para>
 
80
</refsect1>
 
81
 
 
82
<refsect1 id="BraseroMediumSelection.details" role="details">
 
83
<title role="details.title">Details</title>
 
84
<refsect2 id="BraseroMediumSelection-struct" role="struct">
 
85
<title>BraseroMediumSelection</title>
 
86
<indexterm zone="BraseroMediumSelection-struct"><primary sortas="BraseroMediumSelection">BraseroMediumSelection</primary></indexterm><programlisting>typedef struct _BraseroMediumSelection BraseroMediumSelection;</programlisting>
 
87
<para>
 
88
</para></refsect2>
 
89
<refsect2 id="brasero-medium-selection-new" role="function">
 
90
<title>brasero_medium_selection_new ()</title>
 
91
<indexterm zone="brasero-medium-selection-new"><primary sortas="brasero_medium_selection_new">brasero_medium_selection_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          brasero_medium_selection_new        (void);</programlisting>
 
92
<para>
 
93
Creates a new <link linkend="BraseroMediumSelection"><type>BraseroMediumSelection</type></link> object</para>
 
94
<para>
 
95
</para><variablelist role="params">
 
96
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>. Unref when it is not needed anymore.
 
97
</simpara></listitem></varlistentry>
 
98
</variablelist></refsect2>
 
99
<refsect2 id="brasero-medium-selection-get-active" role="function">
 
100
<title>brasero_medium_selection_get_active ()</title>
 
101
<indexterm zone="brasero-medium-selection-get-active"><primary sortas="brasero_medium_selection_get_active">brasero_medium_selection_get_active</primary></indexterm><programlisting><link linkend="BraseroMedium">BraseroMedium</link> *     brasero_medium_selection_get_active (<link linkend="BraseroMediumSelection">BraseroMediumSelection</link> *selector);</programlisting>
 
102
<para>
 
103
Gets the active medium.</para>
 
104
<para>
 
105
</para><variablelist role="params">
 
106
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
 
107
<listitem><simpara> a <link linkend="BraseroMediumSelection"><type>BraseroMediumSelection</type></link>
 
108
</simpara></listitem></varlistentry>
 
109
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroMedium"><type>BraseroMedium</type></link> or NULL. Unref when it is not needed anymore.
 
110
</simpara></listitem></varlistentry>
 
111
</variablelist></refsect2>
 
112
<refsect2 id="brasero-medium-selection-set-active" role="function">
 
113
<title>brasero_medium_selection_set_active ()</title>
 
114
<indexterm zone="brasero-medium-selection-set-active"><primary sortas="brasero_medium_selection_set_active">brasero_medium_selection_set_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            brasero_medium_selection_set_active (<link linkend="BraseroMediumSelection">BraseroMediumSelection</link> *selector,
 
115
                                                         <link linkend="BraseroMedium">BraseroMedium</link> *medium);</programlisting>
 
116
<para>
 
117
Sets the active medium. Emits the ::medium-changed signal.</para>
 
118
<para>
 
119
</para><variablelist role="params">
 
120
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
 
121
<listitem><simpara> a <link linkend="BraseroMediumSelection"><type>BraseroMediumSelection</type></link>
 
122
</simpara></listitem></varlistentry>
 
123
<varlistentry><term><parameter>medium</parameter>&#160;:</term>
 
124
<listitem><simpara> a <link linkend="BraseroMedium"><type>BraseroMedium</type></link> to set as the active one in the selector
 
125
</simpara></listitem></varlistentry>
 
126
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link>. TRUE if it succeeded, FALSE otherwise.
 
127
</simpara></listitem></varlistentry>
 
128
</variablelist></refsect2>
 
129
<refsect2 id="brasero-medium-selection-show-media-type" role="function">
 
130
<title>brasero_medium_selection_show_media_type ()</title>
 
131
<indexterm zone="brasero-medium-selection-show-media-type"><primary sortas="brasero_medium_selection_show_media_type">brasero_medium_selection_show_media_type</primary></indexterm><programlisting><link linkend="void">void</link>                brasero_medium_selection_show_media_type
 
132
                                                        (<link linkend="BraseroMediumSelection">BraseroMediumSelection</link> *selector,
 
133
                                                         <link linkend="BraseroMediaType">BraseroMediaType</link> type);</programlisting>
 
134
<para>
 
135
Filters and displays media corresponding to <parameter>type</parameter>.</para>
 
136
<para>
 
137
</para><variablelist role="params">
 
138
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
 
139
<listitem><simpara> a <link linkend="BraseroMediumSelection"><type>BraseroMediumSelection</type></link>
 
140
</simpara></listitem></varlistentry>
 
141
<varlistentry><term><parameter>type</parameter>&#160;:</term>
 
142
<listitem><simpara> a <link linkend="BraseroMediaType"><type>BraseroMediaType</type></link>
 
143
</simpara></listitem></varlistentry>
 
144
</variablelist></refsect2>
 
145
 
 
146
</refsect1>
 
147
<refsect1 id="BraseroMediumSelection.property-details" role="property_details">
 
148
<title role="property_details.title">Property Details</title>
 
149
<refsect2 id="BraseroMediumSelection--media-type" role="property"><title>The <literal>&quot;media-type&quot;</literal> property</title>
 
150
<indexterm zone="BraseroMediumSelection--media-type"><primary sortas="BraseroMediumSelection:media-type">BraseroMediumSelection:media-type</primary></indexterm><programlisting>  &quot;media-type&quot;               <link linkend="guint">guint</link>                 : Read / Write</programlisting>
 
151
<para>The type of media displayed.</para><para>Allowed values: &lt;= 255</para>
 
152
<para>Default value: 0</para>
 
153
</refsect2>
 
154
<refsect2 id="BraseroMediumSelection--medium" role="property"><title>The <literal>&quot;medium&quot;</literal> property</title>
 
155
<indexterm zone="BraseroMediumSelection--medium"><primary sortas="BraseroMediumSelection:medium">BraseroMediumSelection:medium</primary></indexterm><programlisting>  &quot;medium&quot;                   <link linkend="BraseroMedium">BraseroMedium</link>*        : Read / Write</programlisting>
 
156
<para>The currently selected medium.</para></refsect2>
 
157
</refsect1>
 
158
 
 
159
<refsect1 id="BraseroMediumSelection.signal-details" role="signals">
 
160
<title role="signals.title">Signal Details</title>
 
161
<refsect2 id="BraseroMediumSelection-medium-changed" role="signal"><title>The <literal>&quot;medium-changed&quot;</literal> signal</title>
 
162
<indexterm zone="BraseroMediumSelection-medium-changed"><primary sortas="BraseroMediumSelection::medium-changed">BraseroMediumSelection::medium-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="BraseroMediumSelection">BraseroMediumSelection</link> *monitor,
 
163
                                                        <link linkend="BraseroMedium">BraseroMedium</link>          *medium,
 
164
                                                        <link linkend="gpointer">gpointer</link>                user_data)      : Run First / No Recursion / Action</programlisting>
 
165
<para>
 
166
This signal gets emitted when the selected medium has changed.</para>
 
167
<para>
 
168
</para><variablelist role="params">
 
169
<varlistentry><term><parameter>monitor</parameter>&#160;:</term>
 
170
<listitem><simpara> the object which received the signal
 
171
</simpara></listitem></varlistentry>
 
172
<varlistentry><term><parameter>medium</parameter>&#160;:</term>
 
173
<listitem><simpara> the new selected medium
 
174
</simpara></listitem></varlistentry>
 
175
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
176
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
177
</variablelist></refsect2>
 
178
</refsect1>
 
179
 
 
180
 
 
181
 
 
182
</refentry>