← Back to branch summary

~ubuntu-branches/debian/wheezy/brasero/wheezy

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Henriksson
  • Date: 2009-12-14 22:35:03 UTC
  • mfrom: (1.2.17 upstream)
  • Revision ID: james.westby@ubuntu.com-20091214223503-aa2l0jrjl85ar2ue
Tags: 2.28.3-1
New upstream bugfix release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libbrasero-media/xml/brasero-medium-selection.xml
1
 
<refentry id="libbrasero-media-BraseroMediumSelection">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="libbrasero-media-BraseroMediumSelection.top_of_page">BraseroMediumSelection</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>LIBBRASERO-MEDIA Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>BraseroMediumSelection</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="libbrasero-media-BraseroMediumSelection.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
                    <link linkend="BraseroMediumSelection">BraseroMediumSelection</link>;
18
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="brasero-medium-selection-new">brasero_medium_selection_new</link>        (void);
19
 
<link linkend="BraseroMedium">BraseroMedium</link> *     <link linkend="brasero-medium-selection-get-active">brasero_medium_selection_get_active</link> (<link linkend="BraseroMediumSelection">BraseroMediumSelection</link> *selector);
20
 
<link linkend="gboolean">gboolean</link>            <link linkend="brasero-medium-selection-set-active">brasero_medium_selection_set_active</link> (<link linkend="BraseroMediumSelection">BraseroMediumSelection</link> *selector,
21
 
                                                         <link linkend="BraseroMedium">BraseroMedium</link> *medium);
22
 
<link linkend="void">void</link>                <link linkend="brasero-medium-selection-show-media-type">brasero_medium_selection_show_media_type</link>
23
 
                                                        (<link linkend="BraseroMediumSelection">BraseroMediumSelection</link> *selector,
24
 
                                                         <link linkend="BraseroMediaType">BraseroMediaType</link> type);
25
 
</synopsis>
26
 
</refsynopsisdiv>
27
 
 
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
<refsect1 id="libbrasero-media-BraseroMediumSelection.description" role="desc">
37
 
<title role="desc.title">Description</title>
38
 
<para>
39
 
</para>
40
 
</refsect1>
41
 
 
42
 
<refsect1 id="libbrasero-media-BraseroMediumSelection.details" role="details">
43
 
<title role="details.title">Details</title>
44
 
<refsect2 id="BraseroMediumSelection" role="struct">
45
 
<title>BraseroMediumSelection</title>
46
 
<indexterm zone="BraseroMediumSelection"><primary sortas="BraseroMediumSelection">BraseroMediumSelection</primary></indexterm><programlisting>typedef struct {
47
 
        GtkComboBox parent_instance;
48
 
} BraseroMediumSelection;
49
 
</programlisting>
50
 
<para>
51
 
</para></refsect2>
52
 
<refsect2 id="brasero-medium-selection-new" role="function">
53
 
<title>brasero_medium_selection_new ()</title>
54
 
<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>
55
 
<para>
56
 
Creates a new <link linkend="BraseroMediumSelection"><type>BraseroMediumSelection</type></link> object</para>
57
 
<para>
58
 
</para><variablelist role="params">
59
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>. Unref when it is not needed anymore.
60
 
</simpara></listitem></varlistentry>
61
 
</variablelist></refsect2>
62
 
<refsect2 id="brasero-medium-selection-get-active" role="function">
63
 
<title>brasero_medium_selection_get_active ()</title>
64
 
<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>
65
 
<para>
66
 
Gets the active medium.</para>
67
 
<para>
68
 
</para><variablelist role="params">
69
 
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
70
 
<listitem><simpara> a <link linkend="BraseroMediumSelection"><type>BraseroMediumSelection</type></link>
71
 
</simpara></listitem></varlistentry>
72
 
<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.
73
 
</simpara></listitem></varlistentry>
74
 
</variablelist></refsect2>
75
 
<refsect2 id="brasero-medium-selection-set-active" role="function">
76
 
<title>brasero_medium_selection_set_active ()</title>
77
 
<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,
78
 
                                                         <link linkend="BraseroMedium">BraseroMedium</link> *medium);</programlisting>
79
 
<para>
80
 
Sets the active medium. Emits the ::medium-changed signal.</para>
81
 
<para>
82
 
</para><variablelist role="params">
83
 
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
84
 
<listitem><simpara> a <link linkend="BraseroMediumSelection"><type>BraseroMediumSelection</type></link>
85
 
</simpara></listitem></varlistentry>
86
 
<varlistentry><term><parameter>medium</parameter>&#160;:</term>
87
 
<listitem><simpara> a <link linkend="BraseroMedium"><type>BraseroMedium</type></link> to set as the active one in the selector
88
 
</simpara></listitem></varlistentry>
89
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link>. TRUE if it succeeded, FALSE otherwise.
90
 
</simpara></listitem></varlistentry>
91
 
</variablelist></refsect2>
92
 
<refsect2 id="brasero-medium-selection-show-media-type" role="function">
93
 
<title>brasero_medium_selection_show_media_type ()</title>
94
 
<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
95
 
                                                        (<link linkend="BraseroMediumSelection">BraseroMediumSelection</link> *selector,
96
 
                                                         <link linkend="BraseroMediaType">BraseroMediaType</link> type);</programlisting>
97
 
<para>
98
 
Filters and displays media corresponding to <parameter>type</parameter>.</para>
99
 
<para>
100
 
</para><variablelist role="params">
101
 
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
102
 
<listitem><simpara> a <link linkend="BraseroMediumSelection"><type>BraseroMediumSelection</type></link>
103
 
</simpara></listitem></varlistentry>
104
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
105
 
<listitem><simpara> a <link linkend="BraseroMediaType"><type>BraseroMediaType</type></link>
106
 
</simpara></listitem></varlistentry>
107
 
</variablelist></refsect2>
108
 
 
109
 
</refsect1>
110
 
 
111
 
 
112
 
 
113
 
 
114
 
</refentry>