← Back to branch summary

~ubuntu-branches/ubuntu/karmic/gnome-disk-utility/karmic

« back to all changes in this revision

Viewing changes to doc/xml/gdu-drive.xml

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2009-03-02 23:33:14 UTC
  • Revision ID: james.westby@ubuntu.com-20090302233314-6t4zbyzvpqxs2v96
Tags: upstream-0.3
Import upstream version 0.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/gdu-drive.xml
 
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="GduDrive">
 
7
<refmeta>
 
8
<refentrytitle role="top_of_page" id="GduDrive.top_of_page">GduDrive</refentrytitle>
 
9
<manvolnum>3</manvolnum>
 
10
<refmiscinfo>GNOME-DISK-UTILITY Library</refmiscinfo>
 
11
</refmeta>
 
12
 
 
13
<refnamediv>
 
14
<refname>GduDrive</refname>
 
15
<refpurpose>Drives</refpurpose>
 
16
</refnamediv>
 
17
 
 
18
<refsynopsisdiv id="GduDrive.synopsis" role="synopsis">
 
19
<title role="synopsis.title">Synopsis</title>
 
20
 
 
21
<synopsis>
 
22
                    <link linkend="GduDrivePrivate">GduDrivePrivate</link>;
 
23
                    <link linkend="GduDrive-struct">GduDrive</link>;
 
24
<link linkend="gboolean">gboolean</link>            <link linkend="gdu-drive-is-active">gdu_drive_is_active</link>                 (<link linkend="GduDrive">GduDrive</link> *drive);
 
25
<link linkend="gboolean">gboolean</link>            <link linkend="gdu-drive-is-activatable">gdu_drive_is_activatable</link>            (<link linkend="GduDrive">GduDrive</link> *drive);
 
26
<link linkend="gboolean">gboolean</link>            <link linkend="gdu-drive-can-deactivate">gdu_drive_can_deactivate</link>            (<link linkend="GduDrive">GduDrive</link> *drive);
 
27
<link linkend="gboolean">gboolean</link>            <link linkend="gdu-drive-can-activate">gdu_drive_can_activate</link>              (<link linkend="GduDrive">GduDrive</link> *drive,
 
28
                                                         <link linkend="gboolean">gboolean</link> *out_degraded);
 
29
<link linkend="void">void</link>                <link linkend="gdu-drive-activate">gdu_drive_activate</link>                  (<link linkend="GduDrive">GduDrive</link> *drive,
 
30
                                                         <link linkend="GduDriveActivateFunc">GduDriveActivateFunc</link> callback,
 
31
                                                         <link linkend="gpointer">gpointer</link> user_data);
 
32
<link linkend="void">void</link>                <link linkend="gdu-drive-deactivate">gdu_drive_deactivate</link>                (<link linkend="GduDrive">GduDrive</link> *drive,
 
33
                                                         <link linkend="GduDriveDeactivateFunc">GduDriveDeactivateFunc</link> callback,
 
34
                                                         <link linkend="gpointer">gpointer</link> user_data);
 
35
</synopsis>
 
36
</refsynopsisdiv>
 
37
 
 
38
<refsect1 id="GduDrive.object-hierarchy" role="object_hierarchy">
 
39
<title role="object_hierarchy.title">Object Hierarchy</title>
 
40
<synopsis>
 
41
  <link linkend="GObject">GObject</link>
 
42
   +----GduDrive
 
43
         +----<link linkend="GduLinuxMdDrive">GduLinuxMdDrive</link>
 
44
</synopsis>
 
45
</refsect1>
 
46
 
 
47
 
 
48
 
 
49
<refsect1 id="GduDrive.implemented-interfaces" role="impl_interfaces">
 
50
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
51
<para>
 
52
GduDrive implements
 
53
 <link linkend="GduPresentable">GduPresentable</link>.</para>
 
54
</refsect1>
 
55
 
 
56
 
 
57
 
 
58
 
 
59
 
 
60
<refsect1 id="GduDrive.description" role="desc">
 
61
<title role="desc.title">Description</title>
 
62
<para>
 
63
The <link linkend="GduDrive"><type>GduDrive</type></link> class represents drives attached to the
 
64
system. Normally, objects of this class corresponds 1:1 to physical
 
65
drives (hard disks, optical drives, card readers etc.) attached to
 
66
the system. However, it can also relate to software abstractions
 
67
such as a Linux md Software RAID array and similar things.
 
68
</para>
 
69
<para>
 
70
See the documentation for <link linkend="GduPresentable"><type>GduPresentable</type></link> for the big picture.</para>
 
71
<para>
 
72
</para>
 
73
</refsect1>
 
74
 
 
75
<refsect1 id="GduDrive.details" role="details">
 
76
<title role="details.title">Details</title>
 
77
<refsect2 id="GduDrivePrivate" role="struct">
 
78
<title>GduDrivePrivate</title>
 
79
<indexterm zone="GduDrivePrivate"><primary sortas="GduDrivePrivate">GduDrivePrivate</primary></indexterm><programlisting>typedef struct _GduDrivePrivate GduDrivePrivate;</programlisting>
 
80
<para>
 
81
</para></refsect2>
 
82
<refsect2 id="GduDrive-struct" role="struct">
 
83
<title>GduDrive</title>
 
84
<indexterm zone="GduDrive-struct"><primary sortas="GduDrive">GduDrive</primary></indexterm><programlisting>typedef struct _GduDrive GduDrive;</programlisting>
 
85
<para>
 
86
</para></refsect2>
 
87
<refsect2 id="gdu-drive-is-active" role="function">
 
88
<title>gdu_drive_is_active ()</title>
 
89
<indexterm zone="gdu-drive-is-active"><primary sortas="gdu_drive_is_active">gdu_drive_is_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gdu_drive_is_active                 (<link linkend="GduDrive">GduDrive</link> *drive);</programlisting>
 
90
<para>
 
91
</para><variablelist role="params">
 
92
<varlistentry><term><parameter>drive</parameter>&#160;:</term>
 
93
<listitem><simpara>
 
94
</simpara></listitem></varlistentry>
 
95
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
96
</simpara></listitem></varlistentry>
 
97
</variablelist></refsect2>
 
98
<refsect2 id="gdu-drive-is-activatable" role="function">
 
99
<title>gdu_drive_is_activatable ()</title>
 
100
<indexterm zone="gdu-drive-is-activatable"><primary sortas="gdu_drive_is_activatable">gdu_drive_is_activatable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gdu_drive_is_activatable            (<link linkend="GduDrive">GduDrive</link> *drive);</programlisting>
 
101
<para>
 
102
</para><variablelist role="params">
 
103
<varlistentry><term><parameter>drive</parameter>&#160;:</term>
 
104
<listitem><simpara>
 
105
</simpara></listitem></varlistentry>
 
106
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
107
</simpara></listitem></varlistentry>
 
108
</variablelist></refsect2>
 
109
<refsect2 id="gdu-drive-can-deactivate" role="function">
 
110
<title>gdu_drive_can_deactivate ()</title>
 
111
<indexterm zone="gdu-drive-can-deactivate"><primary sortas="gdu_drive_can_deactivate">gdu_drive_can_deactivate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gdu_drive_can_deactivate            (<link linkend="GduDrive">GduDrive</link> *drive);</programlisting>
 
112
<para>
 
113
</para><variablelist role="params">
 
114
<varlistentry><term><parameter>drive</parameter>&#160;:</term>
 
115
<listitem><simpara>
 
116
</simpara></listitem></varlistentry>
 
117
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
118
</simpara></listitem></varlistentry>
 
119
</variablelist></refsect2>
 
120
<refsect2 id="gdu-drive-can-activate" role="function">
 
121
<title>gdu_drive_can_activate ()</title>
 
122
<indexterm zone="gdu-drive-can-activate"><primary sortas="gdu_drive_can_activate">gdu_drive_can_activate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gdu_drive_can_activate              (<link linkend="GduDrive">GduDrive</link> *drive,
 
123
                                                         <link linkend="gboolean">gboolean</link> *out_degraded);</programlisting>
 
124
<para>
 
125
Checks if <parameter>drive</parameter> can be activated. If this function returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>,
 
126
<parameter>out_degraded</parameter> will be set to whether the drive will be started in
 
127
degraded mode (e.g. starting a mirror RAID array with only one
 
128
component available).</para>
 
129
<para>
 
130
</para><variablelist role="params">
 
131
<varlistentry><term><parameter>drive</parameter>&#160;:</term>
 
132
<listitem><simpara> A <link linkend="GduDrive"><type>GduDrive</type></link>.
 
133
</simpara></listitem></varlistentry>
 
134
<varlistentry><term><parameter>out_degraded</parameter>&#160;:</term>
 
135
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> or return location for whether the drive will be degraded if activated.
 
136
</simpara></listitem></varlistentry>
 
137
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>drive</parameter> can be activated (and <parameter>out_degraded</parameter> will be set), <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
 
138
</simpara></listitem></varlistentry>
 
139
</variablelist></refsect2>
 
140
<refsect2 id="gdu-drive-activate" role="function">
 
141
<title>gdu_drive_activate ()</title>
 
142
<indexterm zone="gdu-drive-activate"><primary sortas="gdu_drive_activate">gdu_drive_activate</primary></indexterm><programlisting><link linkend="void">void</link>                gdu_drive_activate                  (<link linkend="GduDrive">GduDrive</link> *drive,
 
143
                                                         <link linkend="GduDriveActivateFunc">GduDriveActivateFunc</link> callback,
 
144
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
145
<para>
 
146
</para><variablelist role="params">
 
147
<varlistentry><term><parameter>drive</parameter>&#160;:</term>
 
148
<listitem><simpara>
 
149
</simpara></listitem></varlistentry>
 
150
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
 
151
<listitem><simpara>
 
152
</simpara></listitem></varlistentry>
 
153
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
154
<listitem><simpara>
 
155
</simpara></listitem></varlistentry>
 
156
</variablelist></refsect2>
 
157
<refsect2 id="gdu-drive-deactivate" role="function">
 
158
<title>gdu_drive_deactivate ()</title>
 
159
<indexterm zone="gdu-drive-deactivate"><primary sortas="gdu_drive_deactivate">gdu_drive_deactivate</primary></indexterm><programlisting><link linkend="void">void</link>                gdu_drive_deactivate                (<link linkend="GduDrive">GduDrive</link> *drive,
 
160
                                                         <link linkend="GduDriveDeactivateFunc">GduDriveDeactivateFunc</link> callback,
 
161
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
162
<para>
 
163
</para><variablelist role="params">
 
164
<varlistentry><term><parameter>drive</parameter>&#160;:</term>
 
165
<listitem><simpara>
 
166
</simpara></listitem></varlistentry>
 
167
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
 
168
<listitem><simpara>
 
169
</simpara></listitem></varlistentry>
 
170
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
171
<listitem><simpara>
 
172
</simpara></listitem></varlistentry>
 
173
</variablelist></refsect2>
 
174
 
 
175
</refsect1>
 
176
 
 
177
 
 
178
 
 
179
 
 
180
</refentry>