2004-11-05 21:25:40 +00:00
<Type Name= "FileSystem" FullName= "Gtk.FileSystem" >
<TypeSignature Language= "C#" Value= "public abstract interface FileSystem" 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 >
2004-12-31 00:32:25 +00:00
<summary > Interface class for representing filesystems.</summary>
<remarks > For concrete implementations, see
<see cref= "T:Gtk.FileSystem.Win32" /> and
<see cref= "T:Gtk.FileSystem.Unix" /> .</remarks>
2004-11-05 21:25:40 +00:00
</Docs>
<Base />
<Interfaces >
<Interface >
<InterfaceName > GLib.IWrapper</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members >
<Member MemberName= "ListBookmarks" >
<MemberSignature Language= "C#" Value= "public virtual GLib.SList ListBookmarks ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > GLib.SList</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-12-31 00:32:25 +00:00
<summary > Queries the list of bookmarks in the file system.</summary>
<returns > a <see cref= "T:GLib.SList" /> , a list of
<see cref= "T:Gtk.FilePath" /> objects, or
<see langword= "null" /> if there are no configured bookmarks.</returns>
<remarks >
See also <see cref= "M:Gtk.FileSystem.RemoveBookmark" /> .
</remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary >
Removes a bookmark folder from the user's bookmarks list.
</summary>
2004-11-05 21:25:40 +00:00
<param name= "path" > a <see cref= "T:Gtk.FilePath" /> </param>
<returns > a <see cref= "T:System.Boolean" /> </returns>
2004-12-31 00:32:25 +00:00
<remarks >
If the operation succeeds, the
<see cref= "E:Gtk.FileSystem.BookmarksChanged" />
signal will be emitted. If you try to remove
a <paramref name= "path" /> which does not exist in the bookmarks
list, the operation will fail and an exception will be thrown.
</remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary >
Gets the name of the parent folder of a path.
</summary>
2004-11-05 21:25:40 +00:00
<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>
2004-12-31 00:32:25 +00:00
<remarks >
If the path has no parent, as when you request the parent of a file system root,
then <paramref name= "parent" /> will be set to <see langword= "null" /> .
</remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary >
Makes a new path called <paramref name= "display_name" />
starting from path <paramref name= "base_path" /> .
</summary>
2004-11-05 21:25:40 +00:00
<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>
2004-12-31 00:32:25 +00:00
<remarks > </remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary > Gets an object to represent the folder at path <paramref name= "path" /> .</summary>
2004-11-05 21:25:40 +00:00
<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>
2004-12-31 00:32:25 +00:00
<remarks > </remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary > Converts <paramref name= "path" /> to a filename string.</summary>
2004-11-05 21:25:40 +00:00
<param name= "path" > a <see cref= "T:Gtk.FilePath" /> </param>
2004-12-31 00:32:25 +00:00
<returns > a <see cref= "T:System.String" /> , or <see langword= "null" />
if the path is not local.</returns>
<remarks > </remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary > Converts a URI to a <see cref= "T:Gtk.FilePath" /> object.</summary>
2004-11-05 21:25:40 +00:00
<param name= "uri" > a <see cref= "T:System.String" /> </param>
<returns > a <see cref= "T:Gtk.FilePath" /> </returns>
2004-12-31 00:32:25 +00:00
<remarks > </remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary > Converts <paramref name= "path" /> to a URI.</summary>
2004-11-05 21:25:40 +00:00
<param name= "path" > a <see cref= "T:Gtk.FilePath" /> </param>
<returns > a <see cref= "T:System.String" /> </returns>
2004-12-31 00:32:25 +00:00
<remarks > </remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary >
Determines what volume of the filesystem
<paramref name= "path" /> is located on.
</summary>
2004-11-05 21:25:40 +00:00
<param name= "path" > a <see cref= "T:Gtk.FilePath" /> </param>
<returns > a <see cref= "T:Gtk.FileSystemVolume" /> </returns>
2004-12-31 00:32:25 +00:00
<remarks > </remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary > Converts <paramref name= "filename" /> into a <see cref= "T:Gtk.FilePath" /> .</summary>
2004-11-05 21:25:40 +00:00
<param name= "filename" > a <see cref= "T:System.String" /> </param>
<returns > a <see cref= "T:Gtk.FilePath" /> </returns>
2004-12-31 00:32:25 +00:00
<remarks > </remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 17:05:20 +00:00
<summary > Returns an icon to represent this filesystem.</summary>
2004-11-05 21:25:40 +00:00
<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>
2004-12-31 00:32:25 +00:00
<remarks > </remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary >
Adds a path for a folder to the user's bookmarks list.
</summary>
2004-11-05 21:25:40 +00:00
<param name= "path" > a <see cref= "T:Gtk.FilePath" /> </param>
2004-12-31 00:32:25 +00:00
<param name= "position" > a <see cref= "T:System.Int32" /> , index in
the bookmarks list at which the <paramref name= "path" /> should
be inserted; use 0 for the beginning, and -1 or the number of
bookmarks itself for the end of the list.</param>
2004-11-05 21:25:40 +00:00
<returns > a <see cref= "T:System.Boolean" /> </returns>
2004-12-31 00:32:25 +00:00
<remarks >
<para > If the operation
succeeds, the <see cref= "E:Gtk.FileSystem.BookmarksChanged" />
signal will be emitted. Bookmark paths are
unique; if you try to insert a <paramref name= "path" /> that
already exists, the operation will fail and an exception will
be thrown.</para>
<para > To reorder the list of bookmarks, use
<see cref= "M:Gtk.FileSystem.RemoveBookmark" /> to
remove the path in question, and call
<see cref= "M:Gtk.FileSystem.InsertBookmark" /> with
the new position for the path.</para>
</remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary > Checks to see whether a path is local; that is,
whether <see cref= "M:Gtk.FileSystem.PathToFilename" /> would
return non-<see langword= "null" /> .</summary>
2004-11-05 21:25:40 +00:00
<param name= "path" > a <see cref= "T:Gtk.FilePath" /> </param>
<returns > a <see cref= "T:System.Boolean" /> </returns>
2004-12-31 00:32:25 +00:00
<remarks > </remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary > Gets a list of all the <see cref= "T:Gtk.FileSystemVolume" /> s
on the system.</summary>
2004-11-05 21:25:40 +00:00
<returns > a <see cref= "T:GLib.SList" /> </returns>
2004-12-31 00:32:25 +00:00
<remarks > </remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary >
Given a string entered by a user, parse it (possibly using
heuristics) into a folder path and a UTF-8 encoded
filename part suitable for passing to
<see cref= "M:Gtk.FileSystem.MakePath" /> .
</summary>
<param name= "base_path" > a <see cref= "T:Gtk.FilePath" /> , reference folder with respect to which relative paths should be interpreted.</param>
<param name= "str" > a <see cref= "T:System.String" /> , the string to parse</param>
<param name= "folder" > a <see cref= "T:Gtk.FilePath" /> , a location to store folder portion of result, or <see langword= "null" /> </param>
<param name= "file_part" > a <see cref= "T:System.String" /> , location to store file portion of result, or <see langword= "null" /> </param>
2004-11-05 21:25:40 +00:00
<returns > a <see cref= "T:System.Boolean" /> </returns>
2004-12-31 00:32:25 +00:00
<remarks >
<para >
Note that the returned filename point may point to a subfolder
of the returned folder. Adding a trailing path separator is needed
to enforce the interpretation as a folder name.
</para>
<para >
If parsing fails because the syntax of <paramref name= "str" /> is not understood,
2004-12-31 17:05:20 +00:00
an exception <see cref= "Gtk.FileSystemError.BadFilename" /> will
2004-12-31 00:32:25 +00:00
be thrown and <see langword= "false" /> returned.
</para>
<para >
If parsing fails because a path was encountered that doesn't
exist on the filesystem, then an exception
2004-12-31 17:05:20 +00:00
<see cref= "Gtk.FileSystemError.Nonexistent" /> will be thrown
2004-12-31 00:32:25 +00:00
and <see langword= "false" /> returned.
(This only applies to parsing relative paths,
not to interpretation of <paramref name= "file_part" /> . No check is made as
to whether <paramref name= "file_part" /> exists.)
</para> </remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary > Makes a new folder at <paramref name= "path" /> </summary>
2004-11-05 21:25:40 +00:00
<param name= "path" > a <see cref= "T:Gtk.FilePath" /> </param>
<returns > a <see cref= "T:System.Boolean" /> </returns>
2004-12-31 00:32:25 +00:00
<remarks > </remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary > Emitted when a related <see cref= "M:Gtk.FileSystemVolume" />
is mounted.</summary>
<remarks > </remarks>
2004-11-05 21:25:40 +00:00
</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 >
2004-12-31 00:32:25 +00:00
<summary > Event fired whenever the bookmarks to particular locations change.</summary>
<remarks > </remarks>
2004-11-05 21:25:40 +00:00
</Docs>
</Member>
</Members>
2004-12-31 00:32:25 +00:00
</Type>
