GtkSharp/doc/en/Gnome.Vfs/Drive.xml

<Type Name="Drive" FullName="Gnome.Vfs.Drive">
  <TypeSignature Language="C#" Maintainer="auto" Value="public class Drive : 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.20.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>Container for <see cref="T:Gnome.Vfs.Volume" /> (floppy drive, CD reader, ...).</summary>
    <remarks>To be added</remarks>
  </Docs>
  <Base>
    <BaseTypeName>GLib.Object</BaseTypeName>
  </Base>
  <Interfaces>
  </Interfaces>
  <Members>
    <Member MemberName="OnVolumePreUnmount">
      <MemberSignature Language="C#" Value="protected virtual void OnVolumePreUnmount (Gnome.Vfs.Volume volume);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="volume" Type="Gnome.Vfs.Volume" />
      </Parameters>
      <Docs>
        <summary>Default handler for the <see cref="M:Gnome.Vfs.Drive.VolumePreUnmount" /> event.</summary>
        <param name="volume">a <see cref="T:Gnome.Vfs.Volume" /></param>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gnome.Vfs.Drive.VolumePreUnmount" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnVolumeUnmounted">
      <MemberSignature Language="C#" Value="protected virtual void OnVolumeUnmounted (Gnome.Vfs.Volume volume);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="volume" Type="Gnome.Vfs.Volume" />
      </Parameters>
      <Docs>
        <summary>Default handler for the <see cref="M:Gnome.Vfs.Drive.VolumeUnmounted" /> event.</summary>
        <param name="volume">a <see cref="T:Gnome.Vfs.Volume" /></param>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gnome.Vfs.Drive.VolumeUnmounted" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnVolumeMounted">
      <MemberSignature Language="C#" Value="protected virtual void OnVolumeMounted (Gnome.Vfs.Volume volume);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="volume" Type="Gnome.Vfs.Volume" />
      </Parameters>
      <Docs>
        <summary>Default handler for the <see cref="M:Gnome.Vfs.Drive.VolumeMounted" /> event.</summary>
        <param name="volume">a <see cref="T:Gnome.Vfs.Volume" /></param>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gnome.Vfs.Drive.VolumeMounted" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Compare">
      <MemberSignature Language="C#" Value="public int Compare (Gnome.Vfs.Drive b);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="b" Type="Gnome.Vfs.Drive" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="b">a <see cref="T:Gnome.Vfs.Drive" /></param>
        <returns>a <see cref="T:System.Int32" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected Drive (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 Drive (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 Drive ();" />
      <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.Drive" />.</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 Drive Id.</summary>
        <value>a <see cref="T:System.UInt64" /></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 Drive (i.e. "CD-RW/DVD-ROM Drive").</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 Drive.</summary>
        <value>a <see cref="T:System.String" /></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 Drive 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 Drive (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="MountedVolume">
      <MemberSignature Language="C#" Value="public Gnome.Vfs.Volume MountedVolume { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gnome.Vfs.Volume</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>If <see cref="M:Gnome.Vfs.Drive.IsMounted" />, this points to the mounted <see cref="T:Gnome.Vfs.Volume" />.</summary>
        <value>a <see cref="T:Gnome.Vfs.Volume" /></value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>System.Obsolete</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="IsConnected">
      <MemberSignature Language="C#" Value="public bool IsConnected { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns whether the Drive is connected.</summary>
        <value>a <see cref="T:System.Boolean" /></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 Drive should be visible to the user.</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 Drive represents.</summary>
        <value>a <see cref="T:Gnome.Vfs.DeviceType" /></value>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="VolumePreUnmount">
      <MemberSignature Language="C#" Value="public event Gnome.Vfs.VolumePreUnmountHandler VolumePreUnmount;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gnome.Vfs.VolumePreUnmountHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Drive is about to be unmounted.</summary>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Signal("volume_pre_unmount")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="VolumeUnmounted">
      <MemberSignature Language="C#" Value="public event Gnome.Vfs.VolumeUnmountedHandler VolumeUnmounted;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gnome.Vfs.VolumeUnmountedHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Drive has been unmounted.</summary>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Signal("volume_unmounted")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="VolumeMounted">
      <MemberSignature Language="C#" Value="public event Gnome.Vfs.VolumeMountedHandler VolumeMounted;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gnome.Vfs.VolumeMountedHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Drive has been mounted.</summary>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Signal("volume_mounted")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Mount">
      <MemberSignature Language="C#" Value="public void Mount (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="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="VolumeListFree">
      <MemberSignature Language="C#" Value="public static void VolumeListFree (GLib.List volumes);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="volumes" Type="GLib.List" />
      </Parameters>
      <Docs>
        <param name="volumes">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>
    <Member MemberName="MountedVolumes">
      <MemberSignature Language="C#" Value="public GLib.List MountedVolumes { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>GLib.List</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="NeedsEject">
      <MemberSignature Language="C#" Value="public bool NeedsEject ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <since version="Gnome# 2.20" />
      </Docs>
    </Member>
  </Members>
</Type>