GtkSharp/doc/en/Gnome.Vfs/Volume.xml
Mike Kestner 79231982e0 updates to latest monodocer -pretty and since tags for 2.16 API
svn path=/trunk/gtk-sharp/; revision=71155
2007-01-16 17:19:22 +00:00

302 lines
11 KiB
XML

<Type Name="Volume" FullName="Gnome.Vfs.Volume">
<TypeSignature Language="C#" Maintainer="auto" Value="public class Volume : GLib.Object" />
<AssemblyInfo>
<AssemblyName>gnome-vfs-sharp</AssemblyName>
<AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 71 EB 6C 55 75 52 9C BF 72 44 F7 A6 EA 05 62 84 F9 EA E0 3B CF F2 CC 13 2C 9C 49 0A B3 09 EA B0 B5 6B CE 44 9D F5 03 D9 C0 A8 1E 52 05 85 CD BE 70 E2 FB 90 43 4B AC 04 FA 62 22 A8 00 98 B7 A1 A7 B3 AF 99 1A 41 23 24 BB 43 25 F6 B8 65 BB 64 EB F6 D1 C2 06 D5 73 2D DF BC 70 A7 38 9E E5 3E 0C 24 6E 32 79 74 1A D0 05 03 E4 98 42 E1 9B F3 7B 19 8B 40 21 26 CB 36 89 C2 EA 64 96 A4 7C B4]</AssemblyPublicKey>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>Abstraction for a mounted file system or a network location.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Members>
<Member MemberName="Compare">
<MemberSignature Language="C#" Value="public int Compare (Gnome.Vfs.Volume b);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="b" Type="Gnome.Vfs.Volume" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="b">a <see cref="T:Gnome.Vfs.Volume" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Volume (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Volume (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<remarks>This is not typically used by C# code.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Volume ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gnome.Vfs.Volume" />.</remarks>
</Docs>
</Member>
<Member MemberName="Drive">
<MemberSignature Language="C#" Value="public Gnome.Vfs.Drive Drive { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Drive</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the <see cref="T:Gnome.Vfs.Drive" /> on which this Volume resides.</summary>
<value>a <see cref="T:Gnome.Vfs.Drive" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FilesystemType">
<MemberSignature Language="C#" Value="public string FilesystemType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The type of the file system (i.e. ext3).</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DisplayName">
<MemberSignature Language="C#" Value="public string DisplayName { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>User readable string representing this Volume (i.e. "Harddrive").</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Icon">
<MemberSignature Language="C#" Value="public string Icon { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The icon name used to represent this Volume.</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public ulong Id { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Internal Volume Id.</summary>
<value>a <see cref="T:System.UInt64" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsMounted">
<MemberSignature Language="C#" Value="public bool IsMounted { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns whether the Volume is mounted.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ActivationUri">
<MemberSignature Language="C#" Value="public string ActivationUri { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The <see cref="T:Gnome.Vfs.Uri" /> which represents this Volume (i.e. file:///media/cdrecorder).</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DevicePath">
<MemberSignature Language="C#" Value="public string DevicePath { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The location of the actual device if applicable (i.e. /dev/hdc).</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="VolumeType">
<MemberSignature Language="C#" Value="public Gnome.Vfs.VolumeType VolumeType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.VolumeType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the type of Volume.</summary>
<value>a <see cref="T:Gnome.Vfs.VolumeType" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsUserVisible">
<MemberSignature Language="C#" Value="public bool IsUserVisible { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns whether the Volume should be visible to the user.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="HandlesTrash">
<MemberSignature Language="C#" Value="public bool HandlesTrash { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns whether this Volume supports handling trash items.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsReadOnly">
<MemberSignature Language="C#" Value="public bool IsReadOnly { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns whether this Volume allows write access.</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DeviceType">
<MemberSignature Language="C#" Value="public Gnome.Vfs.DeviceType DeviceType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.DeviceType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The type of device this Volume represents.</summary>
<value>a <see cref="T:Gnome.Vfs.DeviceType" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Eject">
<MemberSignature Language="C#" Value="public void Eject (Gnome.Vfs.VolumeOpCallback cb);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cb" Type="Gnome.Vfs.VolumeOpCallback" />
</Parameters>
<Docs>
<param name="cb">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Unmount">
<MemberSignature Language="C#" Value="public void Unmount (Gnome.Vfs.VolumeOpCallback cb);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cb" Type="Gnome.Vfs.VolumeOpCallback" />
</Parameters>
<Docs>
<param name="cb">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HalUdi">
<MemberSignature Language="C#" Value="public string HalUdi { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>