GtkSharp/doc/en/Gtk/FileSystemVolume.xml

<Type Name="FileSystemVolume" FullName="Gtk.FileSystemVolume">
  <TypeSignature Language="C#" Value="public class FileSystemVolume : GLib.Opaque, IWrapper" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>gtk-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.0.0.0</AssemblyVersion>
    <AssemblyCulture>neutral</AssemblyCulture>
    <Attributes />
  </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>Represents a volume of a filesystem; typically, this corresponds to one physical or logical hard drive.</summary>
    <remarks></remarks>
  </Docs>
  <Base>
    <BaseTypeName>GLib.Opaque</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>GLib.IWrapper</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes />
  <Members>
    <Member MemberName="GetDisplayName">
      <MemberSignature Language="C#" Value="public static string GetDisplayName (Gtk.FileSystem file_system, Gtk.FileSystemVolume volume);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="file_system" Type="Gtk.FileSystem" />
        <Parameter Name="volume" Type="Gtk.FileSystemVolume" />
      </Parameters>
      <Docs>
        <summary>Queries the human-readable name for a volume.  
	</summary>
        <param name="file_system">a <see cref="T:Gtk.FileSystem" /></param>
        <param name="volume">a <see cref="T:Gtk.FileSystemVolume" /></param>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>
	  This string can be displayed
	  in a list of volumes that can be accessed, for example.
	</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetBasePath">
      <MemberSignature Language="C#" Value="public static Gtk.FilePath GetBasePath (Gtk.FileSystem file_system, Gtk.FileSystemVolume volume);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.FilePath</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="file_system" Type="Gtk.FileSystem" />
        <Parameter Name="volume" Type="Gtk.FileSystemVolume" />
      </Parameters>
      <Docs>
        <summary>Returns the base path of this volume.</summary>
        <param name="file_system">a <see cref="T:Gtk.FileSystem" /></param>
        <param name="volume">a <see cref="T:Gtk.FileSystemVolume" /></param>
        <returns>a <see cref="T:Gtk.FilePath" /></returns>
        <remarks> For example, a CD-ROM device may yield a path of "/mnt/cdrom"
	  on Linux.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Free">
      <MemberSignature Language="C#" Value="public static void Free (Gtk.FileSystem file_system, Gtk.FileSystemVolume volume);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="file_system" Type="Gtk.FileSystem" />
        <Parameter Name="volume" Type="Gtk.FileSystemVolume" />
      </Parameters>
      <Docs>
        <summary>Frees memory used by this data structure.</summary>
        <param name="file_system">a <see cref="T:Gtk.FileSystem" /></param>
        <param name="volume">a <see cref="T:Gtk.FileSystemVolume" /></param>
        <remarks>XXX: should this even exist?</remarks>
      </Docs>
    </Member>
    <Member MemberName="RenderIcon">
      <MemberSignature Language="C#" Value="public static Gdk.Pixbuf RenderIcon (Gtk.FileSystem file_system, Gtk.FileSystemVolume volume, Gtk.Widget widget, int pixel_size);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Pixbuf</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="file_system" Type="Gtk.FileSystem" />
        <Parameter Name="volume" Type="Gtk.FileSystemVolume" />
        <Parameter Name="widget" Type="Gtk.Widget" />
        <Parameter Name="pixel_size" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>Returns an icon to represent this volume.</summary>
        <param name="file_system">a <see cref="T:Gtk.FileSystem" /></param>
        <param name="volume">a <see cref="T:Gtk.FileSystemVolume" /></param>
        <param name="widget">a <see cref="T:Gtk.Widget" /></param>
        <param name="pixel_size">a <see cref="T:System.Int32" /></param>
        <returns>a <see cref="T:Gdk.Pixbuf" /></returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="Mount">
      <MemberSignature Language="C#" Value="public static bool Mount (Gtk.FileSystem file_system, Gtk.FileSystemVolume volume);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="file_system" Type="Gtk.FileSystem" />
        <Parameter Name="volume" Type="Gtk.FileSystemVolume" />
      </Parameters>
      <Docs>
        <summary>
	  Tries to mount an unmounted volume.  
	</summary>
        <param name="file_system">a <see cref="T:Gtk.FileSystem" /></param>
        <param name="volume">a <see cref="T:Gtk.FileSystemVolume" /></param>
        <returns>a <see cref="T:System.Boolean" />, true if the volume was mounted successfully, false otherwise.</returns>
        <remarks>
	  This may cause the <see cref="M:Gtk.FileSystem.VolumesChanged"/> signal in the 
	  <paramref name="file_system"/> to be emitted.
	</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetIsMounted">
      <MemberSignature Language="C#" Value="public static bool GetIsMounted (Gtk.FileSystem file_system, Gtk.FileSystemVolume volume);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="file_system" Type="Gtk.FileSystem" />
        <Parameter Name="volume" Type="Gtk.FileSystemVolume" />
      </Parameters>
      <Docs>
        <summary>Queries whether a volume is mounted or not.</summary>
        <param name="file_system">a <see cref="T:Gtk.FileSystem" /></param>
        <param name="volume">a <see cref="T:Gtk.FileSystemVolume" /></param>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks>If the volume is not mounted, it can be mounted with
	<see cref="M:Gtk.FileSystemVolume.Mount"/>.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FileSystemVolume (IntPtr raw);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="raw" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <summary>Public constructor. For internal use; do not use.</summary>
        <param name="raw">a <see cref="T:System.IntPtr" />, pointer to the underlying C object.</param>
        <returns>a <see cref="T:Gtk.FileSystemVolume" /></returns>
        <remarks></remarks>
      </Docs>
    </Member>
  </Members>
</Type>