GtkSharp/doc/en/Gtk/FileSystemUnix.xml
John Luke 70635096fa 2004-12-29 John Luke <john.luke@gmail.com>
* gen-intptr-ctor-docs.cs: docs for Type (IntPtr) ctor
        * gen-gtype-ctor-docs.cs: docs for Type (GType) ctor
        * gen-finalize-docs.cs: docs Finalize methods
        * gen-gtype-docs.cs: docs GType properties, based off
        of gen-vm-docs.cs
        * en/*.xml: run these 4 tools for all the assemblies


svn path=/trunk/gtk-sharp/; revision=38159
2004-12-29 18:36:31 +00:00

413 lines
No EOL
17 KiB
XML

<Type Name="FileSystemUnix" FullName="Gtk.FileSystemUnix">
<TypeSignature Language="C#" Value="public class FileSystemUnix : GLib.Object, FileSystem, IWrapper, IDisposable" 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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Gtk.FileSystem</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected override void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the resources associated with this <see cref="T:Gtk.FileSystemUnix" /> object.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="ListBookmarks">
<MemberSignature Language="C#" Value="public virtual GLib.SList ListBookmarks ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.SList</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RemoveBookmark">
<MemberSignature Language="C#" Value="public virtual bool RemoveBookmark (Gtk.FilePath path);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetParent">
<MemberSignature Language="C#" Value="public virtual bool GetParent (Gtk.FilePath path, Gtk.FilePath parent);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="Gtk.FilePath" />
<Parameter Name="parent" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<param name="parent">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="MakePath">
<MemberSignature Language="C#" Value="public virtual Gtk.FilePath MakePath (Gtk.FilePath base_path, string display_name);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.FilePath</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="base_path" Type="Gtk.FilePath" />
<Parameter Name="display_name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="base_path">a <see cref="T:Gtk.FilePath" /></param>
<param name="display_name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetFolder">
<MemberSignature Language="C#" Value="public virtual Gtk.FileFolder GetFolder (Gtk.FilePath path, Gtk.FileInfoType types);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.FileFolder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="Gtk.FilePath" />
<Parameter Name="types" Type="Gtk.FileInfoType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<param name="types">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gtk.FileFolder" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PathToFilename">
<MemberSignature Language="C#" Value="public virtual string PathToFilename (Gtk.FilePath path);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="UriToPath">
<MemberSignature Language="C#" Value="public virtual Gtk.FilePath UriToPath (string uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.FilePath</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PathToUri">
<MemberSignature Language="C#" Value="public virtual string PathToUri (Gtk.FilePath path);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetVolumeForPath">
<MemberSignature Language="C#" Value="public virtual Gtk.FileSystemVolume GetVolumeForPath (Gtk.FilePath path);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.FileSystemVolume</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:Gtk.FileSystemVolume" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FilenameToPath">
<MemberSignature Language="C#" Value="public virtual Gtk.FilePath FilenameToPath (string filename);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.FilePath</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RenderIcon">
<MemberSignature Language="C#" Value="public virtual Gdk.Pixbuf RenderIcon (Gtk.FilePath path, Gtk.Widget widget, int pixel_size);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="Gtk.FilePath" />
<Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="pixel_size" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></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>To be added</remarks>
</Docs>
</Member>
<Member MemberName="InsertBookmark">
<MemberSignature Language="C#" Value="public virtual bool InsertBookmark (Gtk.FilePath path, int position);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="Gtk.FilePath" />
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<param name="position">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PathIsLocal">
<MemberSignature Language="C#" Value="public virtual bool PathIsLocal (Gtk.FilePath path);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ListVolumes">
<MemberSignature Language="C#" Value="public virtual GLib.SList ListVolumes ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.SList</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public virtual bool Parse (Gtk.FilePath base_path, string str, Gtk.FilePath folder, string file_part);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="base_path" Type="Gtk.FilePath" />
<Parameter Name="str" Type="System.String" />
<Parameter Name="folder" Type="Gtk.FilePath" />
<Parameter Name="file_part" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="base_path">a <see cref="T:Gtk.FilePath" /></param>
<param name="str">a <see cref="T:System.String" /></param>
<param name="folder">a <see cref="T:Gtk.FilePath" /></param>
<param name="file_part">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CreateFolder">
<MemberSignature Language="C#" Value="public virtual bool CreateFolder (Gtk.FilePath path);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="OnVolumesChanged">
<MemberSignature Language="C#" Value="protected virtual void OnVolumesChanged ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gtk.FileSystemUnix.VolumesChanged" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.FileSystemUnix.VolumesChanged" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnBookmarksChanged">
<MemberSignature Language="C#" Value="protected virtual void OnBookmarksChanged ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gtk.FileSystemUnix.BookmarksChanged" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.FileSystemUnix.BookmarksChanged" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected FileSystemUnix (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>
<returns>a <see cref="T:Gtk.FileSystemUnix" /></returns>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileSystemUnix (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>
<returns>a <see cref="T:Gtk.FileSystemUnix" /></returns>
<remarks>This is not typically used by C# code.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileSystemUnix ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.FileSystemUnix" /></returns>
<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>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.FileSystemUnix" />.</remarks>
</Docs>
</Member>
<Member MemberName="VolumesChanged">
<MemberSignature Language="C#" Value="public virtual event EventHandler VolumesChanged;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="BookmarksChanged">
<MemberSignature Language="C#" Value="public virtual event EventHandler BookmarksChanged;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>