ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

2004-12-27 Jeroen Zwartepoorte <jeroen@xs4all.nl>

Browse source 
* gnomevfs/Directory.cs: s/uint/FilePermissions/.
	* gnomevfs/Gnomevfs.metadata: Make a bunch of API more user-friendly &
	C# like.
	* gnomevfs/Monitor.cs: Add internal MonitorEventType enum.
	* gnomevfs/Uri.custom: Move a bunch of API from Vfs.cs to Uri.
	* gnomevfs/Vfs.cs: Only put initialize & shutdown methods in here (plus
	some debug API).
	* gnomevfs/VfsStream.cs: Use new Uri API.
	* sample/gnomevfs/TestUnlink.cs: Fix sample.


svn path=/trunk/gtk-sharp/; revision=38112
This commit is contained in:
Jeroen Zwartepoorte 2004-12-27 20:02:33 +00:00
parent bf9ed95944
commit f3b891e758
40 changed files with 880 additions and 832 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
ChangeLog
View file

@ -1,3 +1,15 @@
2004-12-27 Jeroen Zwartepoorte <jeroen@xs4all.nl>
* gnomevfs/Directory.cs: s/uint/FilePermissions/.
* gnomevfs/Gnomevfs.metadata: Make a bunch of API more user-friendly &
C# like.
* gnomevfs/Monitor.cs: Add internal MonitorEventType enum.
* gnomevfs/Uri.custom: Move a bunch of API from Vfs.cs to Uri.
* gnomevfs/Vfs.cs: Only put initialize & shutdown methods in here (plus
some debug API).
* gnomevfs/VfsStream.cs: Use new Uri API.
* sample/gnomevfs/TestUnlink.cs: Fix sample.
2004-12-27 Mike Kestner <mkestner@novell.com>
* generator/EnumGen.cs : rework for a single pass thru ChildNodes.

5
doc/ChangeLog
View file

@ -1,3 +1,8 @@
2004-12-27 Jeroen Zwartepoorte <jeroen@xs4all.nl>
* en/Gnome.Vfs.xml:
* en/Gnome.Vfs/*.xml: major doc commit (more to follow).
2004-12-23 Mike Kestner <mkestner@novell.com>
* en/GLib/ClassInitializerAttribute.xml : doc new attr.

14
doc/en/Gnome.Vfs/Async.xml
View file

@ -9,9 +9,17 @@
</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>Asynchronous File Operations; POSIX-style file operations that run outside your main loop.
<summary>Asynchronous File Operations; POSIX-style file operations that run outside your main loop.</summary>
<remarks>The members of this class are all static methods and use the <see cref="T:Gnome.Vfs.Handle" /> class to reference asynchronous operations in progress.
<example>
<code lang="C#">
using GLib;
using Gnome.Vfs;
using System;
using System.Text;
using System.Threading;
namespace Test.Gnome.Vfs {
public class TestAsync {
private static MainLoop loop;
private static Handle handle;
@ -76,9 +84,9 @@
loop.Quit ();
}
}
}
</code>
</example></summary>
<remarks>The members of this class are all static methods and use the <see cref="T:Gnome.Vfs.Handle" /> class to reference asynchronous operations in progress.</remarks>
</example></remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>

2
doc/en/Gnome.Vfs/AsyncCallback.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Delegate used for notifying when an asynchronous operation has finished. See <see cref="T:Gnome.Vfs.Async" /> for examples.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>

2
doc/en/Gnome.Vfs/AsyncDirectoryLoadCallback.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Delegate used for notifying when a specified number of entries have been read from a directory. Used in <see cref="M:Gnome.Vfs.Directory.GetEntries" />.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>

2
doc/en/Gnome.Vfs/AsyncReadCallback.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Delegate used for notifying when an asynchronous <see cref="M:Gnome.Vfs.Async.Read" /> operation has finished.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>

2
doc/en/Gnome.Vfs/AsyncWriteCallback.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Delegate used for notifying when an asynchronous <see cref="M:Gnome.Vfs.Async.Write" /> operation has finished.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>

6
doc/en/Gnome.Vfs/AuthenticationType.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Enumeration used in <see cref="T:Gnome.Vfs.ModuleCallbackAuthentication" /> to indicate how the password needs to be transmitted.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -37,7 +37,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Password will be transmitted unencrypted.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -50,7 +50,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Digest is transferred, not plaintext credentials.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

2
doc/en/Gnome.Vfs/DeviceType.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Enumeration used in <see cref="T:Gnome.Vfs.Drive" /> and <see cref="T:Gnome.Vfs.Volume" /> to represent the device type.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>

197
doc/en/Gnome.Vfs/Directory.xml
View file

@ -9,8 +9,66 @@
</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>
<summary>Basic directory operations: creating, reading and removing directories.</summary>
<remarks>
<example>
<code lang="C#">
using GLib;
using Gnome.Vfs;
using System;
using System.Text;
namespace Test.Gnome.Vfs {
public class TestInfo {
private static MainLoop loop;
static void Main (string[] args)
{
if (args.Length != 1) {
Console.WriteLine ("Usage: TestDirectory &lt;uri&gt;");
return;
}
Gnome.Vfs.Vfs.Initialize ();
FileInfo[] entries = Gnome.Vfs.Directory.GetEntries (args[0]);
Console.WriteLine ("Directory {0} contains {1} entries:", args[0], entries.Length);
foreach (FileInfo info in entries) {
Console.WriteLine (info.Name);
}
Gnome.Vfs.Directory.GetEntries (args[0], FileInfoOptions.Default,
20, (int)Gnome.Vfs.Async.Priority.Default,
new AsyncDirectoryLoadCallback (OnDirectoryLoad));
loop = new MainLoop ();
loop.Run ();
Gnome.Vfs.Vfs.Shutdown ();
}
private static void OnDirectoryLoad (Result result, FileInfo[] entries, uint entries_read)
{
Console.WriteLine ("DirectoryLoad: {0}", result);
if (result != Result.Ok &amp;&amp; result != Result.ErrorEof) {
loop.Quit ();
return;
}
Console.WriteLine ("read {0} entries", entries_read);
foreach (FileInfo info in entries) {
Console.WriteLine (info.Name);
}
if (result == Result.ErrorEof)
loop.Quit ();
}
}
}
</code>
</example>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -28,9 +86,9 @@
<Parameter Name="uri" Type="Gnome.Vfs.Uri" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Load a directory from <see cref="T:Gnome.Vfs.Uri" />.</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<returns>a <see cref="T:Gnome.Vfs.FileInfo[]" /></returns>
<returns>a <see cref="T:Gnome.Vfs.FileInfo[]" /> containing the files in the directory.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -45,10 +103,11 @@
<Parameter Name="options" Type="Gnome.Vfs.FileInfoOptions" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Load a directory from <see cref="T:Gnome.Vfs.Uri" /> with the specified <see cref="T:Gnome.Vfs.FileInfoOptions" />.</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<param name="options">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gnome.Vfs.FileInfo[]" /></returns>
<param name="options">
<see cref="T:Gnome.Vfs.FileInfoOptions" /> for loading the directory.</param>
<returns>a <see cref="T:Gnome.Vfs.FileInfo[]" /> containing the files in the directory.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -62,9 +121,10 @@
<Parameter Name="text_uri" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text_uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gnome.Vfs.FileInfo[]" /></returns>
<summary>Load a directory from uri.</summary>
<param name="text_uri">
<see cref="T:System.String" /> representing the URI of the directory to be loaded.</param>
<returns>a <see cref="T:Gnome.Vfs.FileInfo[]" /> containing the files in the directory.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -79,10 +139,12 @@
<Parameter Name="options" Type="Gnome.Vfs.FileInfoOptions" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text_uri">a <see cref="T:System.String" /></param>
<param name="options">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gnome.Vfs.FileInfo[]" /></returns>
<summary>Load a directory from uri with the specified <see cref="T:Gnome.Vfs.FileInfoOptions" />.</summary>
<param name="text_uri">
<see cref="T:System.String" /> representing the URI of the directory to be loaded.</param>
<param name="options">
<see cref="T:Gnome.Vfs.FileInfoOptions" /> for loading the directory.</param>
<returns>a <see cref="T:Gnome.Vfs.FileInfo[]" /> containing the files in the directory.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -100,12 +162,13 @@
<Parameter Name="callback" Type="Gnome.Vfs.AsyncDirectoryLoadCallback" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Asynchronously load a directory from <see cref="T:Gnome.Vfs.Uri" /> with the specified <see cref="T:Gnome.Vfs.FileInfoOptions" />.</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<param name="options">a <see cref="T:System.Int32" /></param>
<param name="itemsPerNotification">a <see cref="T:System.UInt32" /></param>
<param name="priority">a <see cref="T:System.Int32" /></param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncDirectoryLoadCallback" /></param>
<param name="options">
<see cref="T:Gnome.Vfs.FileInfoOptions" /> for loading the directory.</param>
<param name="itemsPerNotification">the number of entries to read in the directory per <see cref="T:Gnome.Vfs.AsyncDirectoryLoadCallback" /> notification.</param>
<param name="priority">a value from <see cref="M:Gnome.Vfs.Async+Priority.Min" /> to <see cref="T:Gnome.Vfs.Async+Priority.Max" /> (normally should be <see cref="T:Gnome.Vfs.Async+Priority.Default" />) indicating the priority to assign this job in allocating threads from the thread pool.</param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncDirectoryLoadCallback" /> to be called when the specified number of entries have been read or the operation is complete.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -123,48 +186,14 @@
<Parameter Name="callback" Type="Gnome.Vfs.AsyncDirectoryLoadCallback" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<param name="options">a <see cref="T:System.Int32" /></param>
<param name="itemsPerNotification">a <see cref="T:System.UInt32" /></param>
<param name="priority">a <see cref="T:System.Int32" /></param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncDirectoryLoadCallback" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static Gnome.Vfs.Result Create (Gnome.Vfs.Uri uri, uint perm);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Result</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="Gnome.Vfs.Uri" />
<Parameter Name="perm" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<param name="perm">a <see cref="T:System.UInt32" /></param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static Gnome.Vfs.Result Create (string uri, uint perm);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Result</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" />
<Parameter Name="perm" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<param name="perm">a <see cref="T:System.UInt32" /></param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<summary>Asynchronously load a directory from uri with the specified <see cref="T:Gnome.Vfs.FileInfoOptions" />.</summary>
<param name="uri">
<see cref="T:System.String" /> representing the URI of the directory to be loaded.</param>
<param name="options">
<see cref="T:Gnome.Vfs.FileInfoOptions" /> for loading the directory.</param>
<param name="itemsPerNotification">the number of entries to read in the directory per <see cref="T:Gnome.Vfs.AsyncDirectoryLoadCallback" /> notification.</param>
<param name="priority">a value from <see cref="M:Gnome.Vfs.Async+Priority.Min" /> to <see cref="T:Gnome.Vfs.Async+Priority.Max" /> (normally should be <see cref="T:Gnome.Vfs.Async+Priority.Default" />) indicating the priority to assign this job in allocating threads from the thread pool.</param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncDirectoryLoadCallback" /> to be called when the specified number of entries have been read or the operation is complete.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -178,8 +207,9 @@
<Parameter Name="uri" Type="Gnome.Vfs.Uri" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<summary>Delete <see cref="T:Gnome.Vfs.Uri" />. <see cref="T:Gnome.Vfs.Uri" /> must be an empty directory.</summary>
<param name="uri">
<see cref="T:Gnome.Vfs.Uri" /> of the directory to be removed.</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -194,8 +224,45 @@
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<summary>Remove uri. Uri must be an empty directory.</summary>
<param name="uri">URI of the directory to be removed.</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static Gnome.Vfs.Result Create (Gnome.Vfs.Uri uri, Gnome.Vfs.FilePermissions perm);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Result</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="Gnome.Vfs.Uri" />
<Parameter Name="perm" Type="Gnome.Vfs.FilePermissions" />
</Parameters>
<Docs>
<summary>Create a directory at <see cref="T:Gnome.Vfs.Uri" />. Only succeeds if a file or directory does not already exist at <see cref="T:Gnome.Vfs.Uri" />.</summary>
<param name="uri">
<see cref="T:Gnome.Vfs.Uri" /> of the directory to be created.</param>
<param name="perm">Unix-style permissions for the newly created directory.</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static Gnome.Vfs.Result Create (string uri, Gnome.Vfs.FilePermissions perm);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Result</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" />
<Parameter Name="perm" Type="Gnome.Vfs.FilePermissions" />
</Parameters>
<Docs>
<summary>Create a directory at uri. Only succeeds if a file or directory does not already exist at the uri.</summary>
<param name="uri">URI of the directory to be created.</param>
<param name="perm">Unix-style permissions for the newly created directory.</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>

2
doc/en/Gnome.Vfs/Drive.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Container for <see cref="T:Gnome.Vfs.Volume" /> (floppy drive, CD reader, ...).</summary>
<remarks>To be added</remarks>
</Docs>
<Base>

8
doc/en/Gnome.Vfs/FileFlags.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Enumeration representing special flags a <see cref="T:Gnome.Vfs.FileInfo" /> class can have.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -41,7 +41,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>no flags.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -54,7 +54,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>whether the file is a symlink.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -67,7 +67,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>whether the file is on a local filesystem.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

72
doc/en/Gnome.Vfs/FileInfo.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Class containing all metadata pertaining to a <see cref="T:Gnome.Vfs.Uri" />.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -51,8 +51,9 @@
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<summary>Create a new FileInfo instance representing the text uri.</summary>
<param name="uri">
<see cref="T:System.String" /> representing the uri.</param>
<returns>a <see cref="T:Gnome.Vfs.FileInfo" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -66,9 +67,11 @@
<Parameter Name="options" Type="Gnome.Vfs.FileInfoOptions" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<param name="options">a <see cref="T:System.Int32" /></param>
<summary>Create a new FileInfo instance representing the text uri with the specified <see cref="T:Gnome.Vfs.FileInfoOptions" />.</summary>
<param name="uri">
<see cref="T:System.String" /> representing the uri.</param>
<param name="options">
<see cref="T:Gnome.Vfs.FileInfoOptions" /> for the FileInfo metadata.</param>
<returns>a <see cref="T:Gnome.Vfs.FileInfo" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -81,7 +84,7 @@
<Parameter Name="uri" Type="Gnome.Vfs.Uri" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Create a new FileInfo instance representing <see cref="T:Gnome.Vfs.Uri" />.</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<returns>a <see cref="T:Gnome.Vfs.FileInfo" /></returns>
<remarks>To be added</remarks>
@ -96,9 +99,10 @@
<Parameter Name="options" Type="Gnome.Vfs.FileInfoOptions" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Create a new FileInfo instance representing <see cref="T:Gnome.Vfs.Uri" /> with the specified <see cref="T:Gnome.Vfs.FileInfoOptions" />.</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<param name="options">a <see cref="T:System.Int32" /></param>
<param name="options">
<see cref="T:Gnome.Vfs.FileInfoOptions" /> for the FileInfo metadata.</param>
<returns>a <see cref="T:Gnome.Vfs.FileInfo" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -111,7 +115,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Base name of the file (no path).</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -124,7 +128,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Properties which are actually valid in this class.</summary>
<returns>a <see cref="T:Gnome.Vfs.FileInfoFields" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -137,7 +141,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>File type (i.e. regular, directory, block device...).</summary>
<returns>a <see cref="T:Gnome.Vfs.FileType" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -150,7 +154,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>File permissions.</summary>
<returns>a <see cref="T:Gnome.Vfs.FilePermissions" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -163,7 +167,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<see cref="T:Gnome.Vfs.FileFlags" /> for this file.</summary>
<returns>a <see cref="T:Gnome.Vfs.FileFlags" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -176,7 +181,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Device id of the file. Only valid if the <see cref="M:Gnome.Vfs.Uri.IsLocal" />.</summary>
<returns>a <see cref="T:System.Int64" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -189,7 +194,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Inode number of the file. Only valid if the <see cref="M:Gnome.Vfs.Uri.IsLocal" />.</summary>
<returns>a <see cref="T:System.Int64" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -202,7 +207,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Link count.</summary>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -215,7 +220,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>UNIX user id.</summary>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -228,7 +233,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>UNIX group id.</summary>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -241,7 +246,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Size in bytes.</summary>
<returns>a <see cref="T:System.Int64" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -254,7 +259,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Size measured in units of 512-byte blocks.</summary>
<returns>a <see cref="T:System.Int64" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -267,7 +272,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Optimal buffer size for reading/writing the file.</summary>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -280,7 +285,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Last time the file was accessed.</summary>
<returns>a <see cref="T:System.DateTime" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -293,7 +298,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Last time the file was modified.</summary>
<returns>a <see cref="T:System.DateTime" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -306,7 +311,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Last time the file was changed.</summary>
<returns>a <see cref="T:System.DateTime" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -319,7 +324,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>If <see cref="M:Gnome.Vfs.FileInfo.IsSymlink" />, this specifies the file the link points to.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -332,8 +337,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<summary>MIME type. Only valid if the FileInfo was created with <see cref="M:Gnome.Vfs.FileInfoOptions.GetMimeType" />.</summary>
<returns>
<see cref="T:System.String" /> representation of the MIME type.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -345,7 +351,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Indicates whether the file is a symlink.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -358,7 +364,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Indicates whether the <see cref="T:Gnome.Vfs.Uri" /> represents a file on the local filesystem.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -371,7 +377,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Indicates whether the <see cref="M:Gnome.Vfs.FileInfo.Uid" /> property is set.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -384,7 +390,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Indicates whether the <see cref="M:Gnome.Vfs.FileInfo.Gid" /> property is set.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -397,7 +403,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Indicates whether the sticky bit is set.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>

48
doc/en/Gnome.Vfs/FileInfoFields.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Flags indicating what properties in a <see cref="T:Gnome.Vfs.FileInfo" /> class are valid. Name is always assumed valid (how else would you have gotten a <see cref="T:Gnome.Vfs.FileInfo" /> instance otherwise?).</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -41,7 +41,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>no properties are valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -54,7 +54,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.Type" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -67,7 +68,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.Permissions" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -80,7 +82,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.Flags" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -93,7 +96,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.Device" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -106,7 +110,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.Inode" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -119,7 +124,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.LinkCount" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -132,7 +138,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.Size" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -145,7 +152,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.BlockCount" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -158,7 +166,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.IoBlockSize" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -171,7 +180,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.Atime" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -184,7 +194,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.Mtime" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -197,7 +208,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.Ctime" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -210,7 +222,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.SymlinkName" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -223,7 +236,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
<see cref="M:Gnome.Vfs.FileInfo.MimeType" /> property is valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -236,7 +250,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>the access properties (<see cref="M:Gnome.Vfs.FileInfo.Gid" />, <see cref="M:Gnome.Vfs.FileInfo.Uid" /> and <see cref="M:Gnome.Vfs.FileInfo.IsSticky" />) are valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

14
doc/en/Gnome.Vfs/FileInfoOptions.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Packed boolean bitfield representing options that can be passed into a <see cref="T:Gnome.Vfs.FileInfo" /> constructor.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -41,7 +41,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>default flags.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -54,7 +54,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>detect the MIME type.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -67,7 +67,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>only use fast MIME type detection (extensions).</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -80,7 +80,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>force slow MIME type detection where available (sniffing, algorithmic detection, etc).</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -93,7 +93,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>automatically follow symbolic links and retrieve the properties of their target (recommended).</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -106,7 +106,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>tries to get data similar to what would return access(2) on a local file system (ie is the file readable, writable and/or executable). Can be really slow on remote file systems.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

32
doc/en/Gnome.Vfs/FilePermissions.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>File permissions. These are the same as the Unix ones, but we wrap them into a nicer VFS-like enum.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -41,7 +41,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>UID bit.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -54,7 +54,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>GID bit.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -67,7 +67,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>sticky bit.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -80,7 +80,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>owner has read permission.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -93,7 +93,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>owner has write permission.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -106,7 +106,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>owner has execution permission.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -119,7 +119,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>owner has all permissions.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -132,7 +132,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>group has read permission.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -145,7 +145,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>group has write permission.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -158,7 +158,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>group has execution permission.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -171,7 +171,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>group has all permissions.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -184,7 +184,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>others have read permission.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -197,7 +197,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>others have write permission.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -210,7 +210,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>others have execution permission.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -223,7 +223,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>others have all permissions.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

2
doc/en/Gnome.Vfs/Handle.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>A handle to an asynchronous operation.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>

44
doc/en/Gnome.Vfs/MimeType.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>File Types; functions for getting information about files based on their MIME type.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -27,7 +27,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>The value returned for the mime type when a file did not match any entries in the mime database. May be treated as a file of an unknown type.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -41,9 +41,11 @@
<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:System.String" /></returns>
<summary>Shortcut for determining the mime type of a file. Use this if you just want to know what mime type a file has and do not want to create a new instance of MimeType.</summary>
<param name="uri">
<see cref="T:System.String" /> representation of the <see cref="T:Gnome.Vfs.Uri" />.</param>
<returns>
<see cref="T:System.String" /> representation of the mime type.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -55,8 +57,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<summary>Returns the <see cref="T:System.String" /> representation of the mime type.</summary>
<returns>
<see cref="T:System.String" /> representation of the mime type.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -68,7 +71,7 @@
<Parameter Name="uri" Type="Gnome.Vfs.Uri" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Construct a new MimeType for this <see cref="T:Gnome.Vfs.Uri" />.</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<returns>a <see cref="T:Gnome.Vfs.MimeType" /></returns>
<remarks>To be added</remarks>
@ -82,8 +85,9 @@
<Parameter Name="mimetype" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="mimetype">a <see cref="T:System.String" /></param>
<summary>Construct a new MimeType for the specified mime type.</summary>
<param name="mimetype">
<see cref="T:System.String" /> representation of the mime type.</param>
<returns>a <see cref="T:Gnome.Vfs.MimeType" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -97,9 +101,9 @@
<Parameter Name="size" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="buffer">a <see cref="T:System.Byte" /></param>
<param name="size">a <see cref="T:System.Int32" /></param>
<summary>Tries to guess the mime type of the data in the buffer using the magic patterns.</summary>
<param name="buffer">a <see cref="T:System.Byte" /> array containing the first part of a file.</param>
<param name="size">the size of the buffer.</param>
<returns>a <see cref="T:Gnome.Vfs.MimeType" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -112,7 +116,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Query the mime database for the <see cref="T:Gnome.Vfs.MimeActionType" /> to be performed on a particular mime type by default.</summary>
<returns>a <see cref="T:Gnome.Vfs.MimeActionType" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -125,7 +129,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Query the mime database for default <see cref="T:Gnome.Vfs.MimeAction" /> associated with a particular mime type.</summary>
<returns>a <see cref="T:Gnome.Vfs.MimeAction" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -138,7 +142,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Query the mime database for a description of the specified mime type.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -151,8 +155,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<summary>Query the mime database for an icon representing the specified mime type.</summary>
<returns>The filename of the icon as listed in the mime database. This is usually a filename without path information, e.g. "i-chardev.png", and sometimes does not have an extension, e.g. "i-regular" if the icon is supposed to be image type agnostic between icon themes. Icons are generic, and not theme specific. These will not necessarily match with the icons a user sees in Nautilus, you have been warned.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -164,7 +168,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Indicates whether files of this mime type might conceivably be executable. Default for known types is false. Default for unknown types is true.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -177,7 +181,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The name of the mime type. This is the same as what the <see cref="M:Gnome.Vfs.MimeType.ToString" /> method returns.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>

123
doc/en/Gnome.Vfs/ModuleCallback.xml
View file

@ -9,8 +9,86 @@
</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>
<summary>Abstract class used by modules for asking an application for necessary information (authentication for example).</summary>
<remarks>
<example>
<code lang="C#">
using GLib;
using Gnome.Vfs;
using System;
using System.Text;
namespace Test.Gnome.Vfs {
public class TestCallback {
private static MainLoop loop;
static void Main (string[] args)
{
if (args.Length != 1) {
Console.WriteLine ("Usage: TestCallback &lt;uri&gt;");
return;
}
Gnome.Vfs.Vfs.Initialize ();
Gnome.Vfs.Uri uri = new Gnome.Vfs.Uri (args[0]);
Handle handle;
// Test 1: Attempt to access a URI requiring authentication w/o a callback registered.
try {
handle = Sync.Open (uri, OpenMode.Read);
Sync.Close (handle);
Console.WriteLine ("Uri '{0}' doesn't require authentication", uri);
return;
} catch (VfsException ex) {
if (ex.Result != Result.ErrorAccessDenied)
throw ex;
}
// Test 2: Attempt an open that requires authentication.
ModuleCallbackFullAuthentication cb = new ModuleCallbackFullAuthentication ();
cb.Callback += new ModuleCallbackHandler (OnAuthenticate);
cb.SetDefault ();
handle = Sync.Open (uri, OpenMode.Read);
Sync.Close (handle);
// Test 3: This call should not require any new authentication.
Console.WriteLine ("File info: \n{0}", uri.GetFileInfo ());
// Test 4: Attempt a call to the parent uri.
FileInfo[] entries = Directory.GetEntries (uri.Parent);
Console.WriteLine ("Directory '{0}' has {1} entries", uri.Parent, entries.Length);
// Test 5: Pop the authentication callback and try again.
cb.Pop ();
try {
handle = Sync.Open (uri, OpenMode.Read);
} catch (VfsException ex) {
if (ex.Result != Result.ErrorAccessDenied)
throw ex;
}
Gnome.Vfs.Vfs.Shutdown ();
}
private static void OnAuthenticate (ModuleCallback cb)
{
ModuleCallbackFullAuthentication fcb = cb as ModuleCallbackFullAuthentication;
Console.Write ("Enter your username ({0}): ", fcb.Username);
string username = Console.ReadLine ();
Console.Write ("Enter your password : ");
string passwd = Console.ReadLine ();
if (username.Length &gt; 0)
fcb.Username = username;
fcb.Password = passwd;
}
}
}
</code>
</example>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -26,8 +104,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Set this ModuleCallback as a temporary handler. <see cref="M:Gnome.Vfs.ModuleCallback.Callback" /> will be called on the same thread as the gnome-vfs operation that invokes it. The temporary handler is set per-thread.</summary>
<remarks>
<para>
<see cref="M:Gnome.Vfs.ModuleCallback.Pop" /> removes the most recently set temporary handler. The temporary handlers are treated as a first-in first-out stack.</para>
<para>Use this function to set a temporary callback handler for a single call or a few calls. You can use <see cref="M:Gnome.Vfs.ModuleCallback.SetDefault" /> to set a callback function that will establish a permanent global setting for all threads instead.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Pop">
@ -38,8 +120,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Remove the temporary handler set with <see cref="M:Gnome.Vfs.ModuleCallback.Push" />. If another temporary handler was previously set on the same thread, it becomes the current handler. Otherwise, the default handler, if any, becomes current.</summary>
<remarks>The temporary handlers are treated as a first-in first-out stack.</remarks>
</Docs>
</Member>
<Member MemberName="SetDefault">
@ -50,8 +132,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Set this <see cref="T:Gnome.Vfs.ModuleCallback" /> as the default handler. <see cref="M:Gnome.Vfs.ModuleCallback.Callback" /> will be called on the same thread as the gnome-vfs operation that invokes it. The default value is shared for all threads, but setting it is thread-safe.</summary>
<remarks>Use this function if you want to set a handler to be used by your whole application. You can use <see cref="M:Gnome.Vfs.ModuleCallback.Push" /> to set a callback function that will temporarily override the default on the current thread instead. Or you can also use <see cref="M:Gnome.Vfs.ModuleCallback.SetDefaultAsync" /> to set an async callback function.</remarks>
</Docs>
</Member>
<Member MemberName="PushAsync">
@ -62,8 +144,13 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Set <see cref="M:Gnome.Vfs.ModuleCallback.Callback" /> as a temprary async handler. <see cref="M:Gnome.Vfs.ModuleCallback.Callback" /> will be called from a callback on the main thread. It will be passed a response function which should be called to signal completion of the callback. The callback function itself may return in the meantime.</summary>
<remarks>
<para>The temporary async handler is set per-thread.</para>
<para>
<see cref="M:Gnome.Vfs.ModuleCallback.PopAsync" /> removes the most recently set temporary temporary handler. The temporary async handlers are treated as a first-in first-out stack.</para>
<para>Use this function to set a temporary async callback handler for a single call or a few calls. You can use <see cref="M:Gnome.Vfs.ModuleCallback.SetDefaultAsync" /> to set an async callback function that will establish a permanent global setting for all threads instead.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="PopAsync">
@ -74,8 +161,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Remove the temporary async handler most recently set with <see cref="M:Gnome.Vfs.PushAsync" />. If another temporary async handler was previously set on the same thread, it becomes the current handler. Otherwise, the default async handler, if any, becomes current.</summary>
<remarks>The temporary async handlers are treated as a first-in first-out stack.</remarks>
</Docs>
</Member>
<Member MemberName="SetDefaultAsync">
@ -86,8 +173,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Set the default async callback. <see cref="M:Gnome.Vfs.ModuleCallback.Callback" /> will be called from a callback on the main thread. It will be passed a response function which should be called to signal completion of the callback. The callback function itself may return in the meantime.</summary>
<remarks>
<para>The default value is shared for all threads, but setting it is thread-safe.</para>
<para>Use this function if you want to globally set a callback handler for use with async operations.</para>
<para>You can use <see cref="M:Gnome.Vfs.ModuleCallback.PushAsync" /> to set an async callback function that will temporarily override the default on the current thread instead. Or you can also use <see cref="M:Gnome.Vfs.ModuleCallback.SetDefault" /> to set a regular callback function.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -109,8 +200,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Event which is called when a gnome-vfs module requires additional information from an application such as authentication.</summary>
<remarks>Implementations of <see cref="T:Gnome.Vfs.ModuleCallback" /> have properties such as <see cref="M:Gnome.Vfs.ModuleCallbackFullAuthentication.Username" /> which can be retrieved and set from the <see cref="M:Gnome.Vfs.ModuleCallback.Callback" /> handler. These properties are only valid during the callback activation.</remarks>
</Docs>
</Member>
</Members>

21
doc/en/Gnome.Vfs/Monitor.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Monitor changes to files and directories.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -29,9 +29,10 @@
<Parameter Name="type" Type="Gnome.Vfs.MonitorType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<param name="type">a <see cref="T:System.Int32" /></param>
<summary>Watch the file or directory at uri for changes (or the creation/deletion of the file) and fire an event when there is a change. If a directory monitor is added, an event is fired when any file in the directory changes.</summary>
<param name="uri">
<see cref="T:System.String" /> representation of a <see cref="T:Gnome.Vfs.Uri" />.</param>
<param name="type">whether the <see cref="T:Gnome.Vfs.Uri" /> to monitor is a file or directory.</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -44,7 +45,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Stop monitoring any files and directories.</summary>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -55,7 +56,7 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Create a new instance.</summary>
<returns>a <see cref="T:Gnome.Vfs.Monitor" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -68,7 +69,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>File data has changed.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -80,7 +81,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>A file has been deleted.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -116,7 +117,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>A file has been created.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -128,7 +129,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>A file metadata has changed.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

123
doc/en/Gnome.Vfs/MonitorEventType.xml
View file

@ -1,123 +0,0 @@
<Type Name="MonitorEventType" FullName="Gnome.Vfs.MonitorEventType">
<TypeSignature Language="C#" Value="public enum MonitorEventType" Maintainer="auto" />
<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.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>System.Enum</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IComparable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IConvertible</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IFormattable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Changed">
<MemberSignature Language="C#" Value="Changed" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.MonitorEventType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Deleted">
<MemberSignature Language="C#" Value="Deleted" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.MonitorEventType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Startexecuting">
<MemberSignature Language="C#" Value="Startexecuting" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.MonitorEventType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Stopexecuting">
<MemberSignature Language="C#" Value="Stopexecuting" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.MonitorEventType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Created">
<MemberSignature Language="C#" Value="Created" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.MonitorEventType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="MetadataChanged">
<MemberSignature Language="C#" Value="MetadataChanged" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.MonitorEventType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="value__">
<MemberSignature Language="C#" Value="value__" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>

2
doc/en/Gnome.Vfs/MonitorHandler.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Delegate used for notification of changes in monitored files and/or directories. See <see cref="T:Gnome.Vfs.Monitor" />.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>

6
doc/en/Gnome.Vfs/MonitorType.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Type of <see cref="T:Gnome.Vfs.Uri" /> to monitor.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -37,7 +37,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>a file.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -50,7 +50,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>a directory.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

4
doc/en/Gnome.Vfs/OpenMode.xml
View file

@ -9,8 +9,8 @@
</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>
<summary>Mode in which files are opened.</summary>
<remarks>If <see cref="M:Gnome.Vfs.OpenMode.Random" /> is not used, the file will be have to be accessed sequentially.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>

8
doc/en/Gnome.Vfs/Priority.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Standard values for the priority to use when executing asynchronous operations.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -37,7 +37,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Minimum priority value.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -50,7 +50,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Default priority value.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -63,7 +63,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Maximum priority value.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

96
doc/en/Gnome.Vfs/Result.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Enumeration containing result codes for gnome-vfs operations.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -37,7 +37,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>No error.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -50,7 +50,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>File not found.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -63,7 +63,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Generic error.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -76,7 +76,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Internal error.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -89,7 +89,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Invalid parameters.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -102,7 +102,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Unsupported operation.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -115,7 +115,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>I/O error.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -128,7 +128,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Data corrupted.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -141,7 +141,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Format not valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -154,7 +154,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Bad file handle.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -167,7 +167,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>File too big.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -180,7 +180,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>No space left on device.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -193,7 +193,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Read-only file system.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -206,7 +206,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Invalid <see cref="T:Gnome.Vfs.Uri" />.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -219,7 +219,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>File not open.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -232,7 +232,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Open mode not valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -245,7 +245,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Access denied.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -258,7 +258,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Too many open files.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -271,7 +271,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>End of file.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -284,7 +284,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Not a directory.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -297,7 +297,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Operation in progress.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -310,7 +310,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Operation interrupted.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -323,7 +323,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>File exists.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -336,7 +336,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Looping links encountered.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -349,7 +349,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Operation not permitted.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -362,7 +362,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Is a directory.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -375,7 +375,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Not enough memory.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -388,7 +388,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Host not found.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -401,7 +401,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Host name not valid.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -414,7 +414,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Host has no address.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -427,7 +427,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Login failed.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -440,7 +440,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Operation cancelled.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -453,7 +453,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Directory busy.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -466,7 +466,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Directory not empty.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -479,7 +479,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Too many links.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -492,7 +492,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Read only file system.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -505,7 +505,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Not on the same file system.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -518,7 +518,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Name too long.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -531,7 +531,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Service not available.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -544,7 +544,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Request obsoletes service's data.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -557,7 +557,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Protocol error.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -570,7 +570,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Could not find master browser.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -583,7 +583,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>No default action associated.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -596,7 +596,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>No handler for URL scheme.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -609,7 +609,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Error parsing command line.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -622,7 +622,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Error launching command.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -635,7 +635,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Number of errors.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

8
doc/en/Gnome.Vfs/SeekPosition.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Used to specify the start position for seek operations.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -37,7 +37,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Start of the file.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -50,7 +50,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Current position.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -63,7 +63,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>End of the file.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

164
doc/en/Gnome.Vfs/Sync.xml
View file

@ -9,8 +9,57 @@
</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>
<summary>File Operations; basic POSIX-style file operations.</summary>
<remarks>
<example>
<code lang="C#">
using Gnome.Vfs;
using System;
using System.Text;
namespace Test.Gnome.Vfs {
public class TestSync {
static void Main (string[] args)
{
if (args.Length != 1) {
Console.WriteLine ("Usage: TestSync &lt;uri&gt;");
return;
}
Gnome.Vfs.Vfs.Initialize ();
Gnome.Vfs.Uri uri = new Gnome.Vfs.Uri (args[0]);
Handle handle = Sync.Open (uri, OpenMode.Read);
UTF8Encoding utf8 = new UTF8Encoding ();
byte[] buffer = new byte[1024];
Result result = Result.Ok;
while (result == Result.Ok) {
ulong bytesRead;
result = Sync.Read (handle, out buffer[0],
(ulong)buffer.Length, out bytesRead);
Console.WriteLine ("result read '{0}' = {1}", uri, result);
if (bytesRead == 0)
break;
Console.WriteLine ("read ({0} bytes) : '{1}'",
bytesRead, utf8.GetString (buffer, 0, (int)bytesRead));
}
string test;
result = Sync.FileControl (handle, "file:test", out test);
Console.WriteLine ("result filecontrol '{0}' = {1}", uri, result);
Console.WriteLine ("result file:test = {0}", test);
result = Sync.Close (handle);
Console.WriteLine ("result close '{0}' = {1}", uri, result);
Gnome.Vfs.Vfs.Shutdown ();
}
}
}
</code>
</example>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -28,7 +77,7 @@
<Parameter Name="handle" Type="Gnome.Vfs.Handle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Close file associated with <see cref="T:Gnome.Vfs.Handle" />.</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /></param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
@ -47,11 +96,13 @@
<Parameter Name="perm" Type="Gnome.Vfs.FilePermissions" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<param name="mode">a <see cref="T:System.Int32" /></param>
<param name="exclusive">a <see cref="T:System.Boolean" /></param>
<param name="perm">a <see cref="T:System.Int32" /></param>
<summary>Create uri according to <see cref="T:Gnome.Vfs.OpenMode" />.</summary>
<param name="uri">
<see cref="T:System.String" /> representing the <see cref="T:Gnome.Vfs.Uri" /> to create.</param>
<param name="mode">
<see cref="T:Gnome.Vfs.OpenMode" />.</param>
<param name="exclusive">Whether the file should be created in "exclusive" mode: i.e. if this flag is true, the operation will fail if a file with the same name already exists.</param>
<param name="perm">Bitmap representing the <see cref="T:Gnome.Vfs.FilePermissions" /> for the newly created file (Unix style).</param>
<returns>a <see cref="T:Gnome.Vfs.Handle" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -69,11 +120,13 @@
<Parameter Name="perm" Type="Gnome.Vfs.FilePermissions" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<param name="mode">a <see cref="T:System.Int32" /></param>
<param name="exclusive">a <see cref="T:System.Boolean" /></param>
<param name="perm">a <see cref="T:System.Int32" /></param>
<summary>Create <see cref="T:Gnome.Vfs.Uri" /> according to <see cref="T:Gnome.Vfs.OpenMode" />.</summary>
<param name="uri">
<see cref="T:Gnome.Vfs.Uri" /> for the file to create.</param>
<param name="mode">
<see cref="T:Gnome.Vfs.OpenMode" />.</param>
<param name="exclusive">Whether the file should be created in "exclusive" mode: i.e. if this flag is true, the operation will fail if a file with the same name already exists.</param>
<param name="perm">Bitmap representing the <see cref="T:Gnome.Vfs.FilePermissions" /> for the newly created file (Unix style).</param>
<returns>a <see cref="T:Gnome.Vfs.Handle" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -89,9 +142,11 @@
<Parameter Name="mode" Type="Gnome.Vfs.OpenMode" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<param name="mode">a <see cref="T:System.Int32" /></param>
<summary>Open uri according to <see cref="T:Gnome.Vfs.OpenMode" />.</summary>
<param name="uri">
<see cref="T:System.String" /> representing the <see cref="T:Gnome.Vfs.Uri" /> to open.</param>
<param name="mode">
<see cref="T:Gnome.Vfs.OpenMode" />.</param>
<returns>a <see cref="T:Gnome.Vfs.Handle" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -107,9 +162,11 @@
<Parameter Name="mode" Type="Gnome.Vfs.OpenMode" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<param name="mode">a <see cref="T:System.Int32" /></param>
<summary>Open <see cref="T:Gnome.Vfs.Uri" /> according to <see cref="T:Gnome.Vfs.OpenMode" />.</summary>
<param name="uri">
<see cref="T:Gnome.Vfs.Uri" /> to open.</param>
<param name="mode">
<see cref="T:Gnome.Vfs.OpenMode" />.</param>
<returns>a <see cref="T:Gnome.Vfs.Handle" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -127,13 +184,15 @@
<Parameter Name="bytes_read" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /></param>
<param name="buffer">a <see cref="T:System.Byte" /></param>
<param name="bytes">a <see cref="T:System.UInt64" /></param>
<param name="bytes_read">a <see cref="T:System.UInt64" /></param>
<summary>Read specified number of bytes from the uri <see cref="T:Gnome.Vfs.Handle" />.</summary>
<param name="handle">
<see cref="T:Gnome.Vfs.Handle" /> of the file to read data from.</param>
<param name="buffer">
<see cref="T:System.Byte" /> array that must be at least as large as the specified number of bytes to read. The array needs to be passed as "out buffer[0]".</param>
<param name="bytes">The number of bytes to read.</param>
<param name="bytes_read">The number of bytes actually read.</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
<remarks>As with Unix system calls, the number of bytes read can effectively be less than the specified number of bytes on return and will be stored in bytes_read.</remarks>
</Docs>
</Member>
<Member MemberName="Seek">
@ -148,10 +207,12 @@
<Parameter Name="offset" Type="System.Int64" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /></param>
<param name="whence">a <see cref="T:System.Int32" /></param>
<param name="offset">a <see cref="T:System.Int64" /></param>
<summary>Set the current position for reading/writing through <see cref="T:Gnome.Vfs.Handle" />.</summary>
<param name="handle">
<see cref="T:Gnome.Vfs.Handle" /> for which the current position must be changed.</param>
<param name="whence">
<see cref="T:Gnome.Vfs.SeekPosition" /> value representing the starting position.</param>
<param name="offset">number of bytes to skip from the position specified by <see cref="T:Gnome.Vfs.SeekPosition" /> (a positive value means to move forward; a negative one to move backwards).</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -169,13 +230,15 @@
<Parameter Name="bytes_written" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /></param>
<param name="buffer">a <see cref="T:System.Byte" /></param>
<param name="bytes">a <see cref="T:System.UInt64" /></param>
<param name="bytes_written">a <see cref="T:System.UInt64" /></param>
<summary>Write number of bytes from buffer byte array into the file pointed to be <see cref="T:Gnome.Vfs.Handle" />.</summary>
<param name="handle">
<see cref="T:Gnome.Vfs.Handle" /> of the file to write data to.</param>
<param name="buffer">
<see cref="T:System.Byte" /> array containing the data to be written.</param>
<param name="bytes">number of bytes to write.</param>
<param name="bytes_written">number of bytes actually written.</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
<remarks>As with Unix system calls, the number of bytes written can effectively be less than the specified number or bytes on return and will be stored in bytes_written.</remarks>
</Docs>
</Member>
<Member MemberName="Tell">
@ -189,9 +252,10 @@
<Parameter Name="offset" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /></param>
<param name="offset">a <see cref="T:System.UInt64" /></param>
<summary>Return the current position on <see cref="T:Gnome.Vfs.Handle" />. This is the point in the file pointed to by <see cref="T:Gnome.Vfs.Handle" /> that reads and writes will occur on.</summary>
<param name="handle">
<see cref="T:Gnome.Vfs.Handle" /> for which the current position must be retrieved.</param>
<param name="offset">Contains the position on return.</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -207,9 +271,10 @@
<Parameter Name="length" Type="System.UInt64" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<param name="length">a <see cref="T:System.UInt64" /></param>
<summary>Truncate the file represented by uri to the specified length. Data past the new length will be discarded.</summary>
<param name="uri">
<see cref="T:System.String" /> representation of <see cref="T:Gnome.Vfs.Uri" />.</param>
<param name="length">length of the new file.</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -225,9 +290,10 @@
<Parameter Name="length" Type="System.UInt64" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /></param>
<param name="length">a <see cref="T:System.UInt64" /></param>
<summary>Truncate the file pointed at by <see cref="T:Gnome.Vfs.Handle" /> to the specified length. Data past the new length will be discarded.</summary>
<param name="handle">
<see cref="T:Gnome.Vfs.Handle" /> to the file to be truncated.</param>
<param name="length">length of the new file.</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -244,12 +310,12 @@
<Parameter Name="data" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /></param>
<param name="operation">a <see cref="T:System.String" /></param>
<param name="data">a <see cref="T:System.String" /></param>
<summary>Execute a backend dependent operation specified by the string operation.</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /> to the file to affect.</param>
<param name="operation">operation to execute.</param>
<param name="data">data needed to execute the operation.</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
<remarks>This is typically used for specialized vfs backends that need additional operations that gnome-vfs doesn't have. Compare it to the unix call ioctl(). The format of data depends on the operation. Operation that are backend specific are normally namespaced by their module name.</remarks>
</Docs>
</Member>
</Members>

329
doc/en/Gnome.Vfs/Uri.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Functions for manipulating Uris.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -22,22 +22,6 @@
</Interfaces>
<Attributes />
<Members>
<Member MemberName="ListParse">
<MemberSignature Language="C#" Value="public static GLib.List ListParse (string uri_list);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.List</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri_list" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri_list">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:GLib.List" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="MakeFullFromRelative">
<MemberSignature Language="C#" Value="public static string MakeFullFromRelative (string base_uri, string relative_uri);" />
<MemberType>Method</MemberType>
@ -49,110 +33,13 @@
<Parameter Name="relative_uri" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Returns a full Uri given a full base Uri, and a secondary Uri which may be relative.</summary>
<param name="base_uri">a <see cref="T:System.String" /></param>
<param name="relative_uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Hash">
<MemberSignature Language="C#" Value="public static uint Hash (IntPtr p);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="p" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="p">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ListUnref">
<MemberSignature Language="C#" Value="public static GLib.List ListUnref (GLib.List list);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.List</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="list" Type="GLib.List" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="list">a <see cref="T:GLib.List" /></param>
<returns>a <see cref="T:GLib.List" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ListCopy">
<MemberSignature Language="C#" Value="public static GLib.List ListCopy (GLib.List list);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.List</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="list" Type="GLib.List" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="list">a <see cref="T:GLib.List" /></param>
<returns>a <see cref="T:GLib.List" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ListFree">
<MemberSignature Language="C#" Value="public static void ListFree (GLib.List list);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="list" Type="GLib.List" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="list">a <see cref="T:GLib.List" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ListRef">
<MemberSignature Language="C#" Value="public static GLib.List ListRef (GLib.List list);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.List</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="list" Type="GLib.List" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="list">a <see cref="T:GLib.List" /></param>
<returns>a <see cref="T:GLib.List" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Hequal">
<MemberSignature Language="C#" Value="public static int Hequal (IntPtr a, IntPtr b);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="a" Type="System.IntPtr" />
<Parameter Name="b" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="a">a <see cref="T:System.IntPtr" /></param>
<param name="b">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ExtractShortName">
<MemberSignature Language="C#" Value="public string ExtractShortName ();" />
<MemberType>Method</MemberType>
@ -161,22 +48,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Retrieve base file name for the Uri, ignoring any trailing path separators.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Ref">
<MemberSignature Language="C#" Value="public Gnome.Vfs.Uri Ref ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Uri</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gnome.Vfs.Uri" /></returns>
<remarks>To be added</remarks>
<remarks>This matches the XPG definition of basename, but not g_basename. This is often useful when you want the name of something that's pointed to by a Uri, and don't care whether the Uri has a directory or file form. If the Uri points to the root of a domain, the host name is returned. If there's no host name, it returns a single path character.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
@ -189,24 +63,12 @@
<Parameter Name="hide_options" Type="Gnome.Vfs.UriHideOptions" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="hide_options">a <see cref="T:System.Int32" /></param>
<summary>Translate the Uri into a printable string hiding the fields specified by <see cref="T:Gnome.Vfs.UriHideOptions" />.</summary>
<param name="hide_options">hide the specified <see cref="T:Gnome.Vfs.UriHideOptions" /> fields.</param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Unref">
<MemberSignature Language="C#" Value="public void Unref ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ExtractShortPathName">
<MemberSignature Language="C#" Value="public string ExtractShortPathName ();" />
<MemberType>Method</MemberType>
@ -215,9 +77,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Retrieve base file name for the Uri, ignoring any trailing path separators.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks>This matches the XPG definition of basename, but not g_basename. This is often useful when you want the name of something that's pointed to by a Uri, and don't care whether the Uri has a directory or file form. If the Uri points to the root (including the root of any domain), it returns a single path character.</remarks>
</Docs>
</Member>
<Member MemberName="ResolveRelative">
@ -230,8 +92,9 @@
<Parameter Name="relative_reference" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="relative_reference">a <see cref="T:System.String" /></param>
<summary>Create a new Uri from relative_reference, relative to this Uri.</summary>
<param name="relative_reference">
<see cref="T:System.String" /> representing a possibly relative Uri reference.</param>
<returns>a <see cref="T:Gnome.Vfs.Uri" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -246,7 +109,7 @@
<Parameter Name="uri_fragment" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Create a new Uri obtained by appending the Uri fragment. This will take care of adding an appropriate directory separator between the end of the Uri and the start of the fragment if necessary.</summary>
<param name="uri_fragment">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gnome.Vfs.Uri" /></returns>
<remarks>To be added</remarks>
@ -262,28 +125,12 @@
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Create a new Uri obtained by appending the path. This will take care of adding an appropriate directory separator between the end of the Uri and the start of the path if necessary as well as escaping the path as necessary.</summary>
<param name="path">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gnome.Vfs.Uri" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Equal">
<MemberSignature Language="C#" Value="public bool Equal (Gnome.Vfs.Uri b);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="b" Type="Gnome.Vfs.Uri" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="b">a <see cref="T:Gnome.Vfs.Uri" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ExtractDirname">
<MemberSignature Language="C#" Value="public string ExtractDirname ();" />
<MemberType>Method</MemberType>
@ -292,7 +139,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Extract the name of the directory in which the file pointed to by the Uri is stored as a newly allocated string. The string will end with a path character.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -307,25 +154,12 @@
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Create a new Uri obtained by appending the specified filename. This will take care of adding an appropriate directory separator between the end of Uri and the start of the filename if necessary.</summary>
<param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gnome.Vfs.Uri" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Dup">
<MemberSignature Language="C#" Value="public Gnome.Vfs.Uri Dup ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Uri</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gnome.Vfs.Uri" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsParent">
<MemberSignature Language="C#" Value="public bool IsParent (Gnome.Vfs.Uri possible_child, bool recursive);" />
<MemberType>Method</MemberType>
@ -337,9 +171,9 @@
<Parameter Name="recursive" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Check if the possible_child Uri is contained by this Uri. If recursive is false, just try the immediate parent directory, else search up through the hierarchy.</summary>
<param name="possible_child">a <see cref="T:Gnome.Vfs.Uri" /></param>
<param name="recursive">a <see cref="T:System.Boolean" /></param>
<param name="recursive">a flag to turn recursive check on.</param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -352,7 +186,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Returns the <see cref="T:Gnome.Vfs.FileInfo" /> for this Uri.</summary>
<returns>a <see cref="T:Gnome.Vfs.FileInfo" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -367,8 +201,9 @@
<Parameter Name="options" Type="Gnome.Vfs.FileInfoOptions" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="options">a <see cref="T:System.Int32" /></param>
<summary>Returns the <see cref="T:Gnome.Vfs.FileInfo" /> for this Uri with the specified <see cref="T:Gnome.Vfs.FileInfoOptions" />.</summary>
<param name="options">
<see cref="T:Gnome.Vfs.FileInfoOptions" /> for the <see cref="T:Gnome.Vfs.FileInfo" /> metadata.</param>
<returns>a <see cref="T:Gnome.Vfs.FileInfo" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -381,7 +216,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Translate the Uri into a printable string using <see cref="M:Gnome.Vfs.UriHideOptions.None" />.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -408,8 +243,9 @@
<Parameter Name="text_uri" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text_uri">a <see cref="T:System.String" /></param>
<summary>Create a new Uri instance from the <see cref="T:System.String" /> representation.</summary>
<param name="text_uri">
<see cref="T:System.String" /> representation of a Uri.</param>
<returns>a <see cref="T:Gnome.Vfs.Uri" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -422,7 +258,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Retrieve the Uris host name.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -435,7 +271,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Check if the Uri points to an existing entity.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -448,8 +284,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.UInt32" /></returns>
<summary>Retrieve the host port number.</summary>
<returns>The host port number used. If the value is zero, the default port value for the specified toplevel access method is used.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -461,7 +297,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Retrieve the full path name.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -474,7 +310,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Retrieve the user name.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -487,7 +323,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Retrieve the optional fragment identifier.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -500,7 +336,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Retrieve the <see cref="T:Gnome.Vfs.ToplevelUri" />.</summary>
<returns>a <see cref="T:Gnome.Vfs.ToplevelUri" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -513,7 +349,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Retrieve the password.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -526,7 +362,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Check if the Uri is a local (native) file system.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -539,7 +375,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Retrieve the Uris parent.</summary>
<returns>a <see cref="T:Gnome.Vfs.Uri" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -552,7 +388,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Check if Uri has a parent or not.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -565,7 +401,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Retrieve the scheme.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -578,10 +414,97 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The Uris <see cref="T:Gnome.Vfs.MimeType" />.</summary>
<returns>a <see cref="T:Gnome.Vfs.MimeType" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public Gnome.Vfs.Uri Clone ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Uri</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a duplicate of the Uri.</summary>
<returns>a <see cref="T:Gnome.Vfs.Uri" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Generates a hash code for the current instance.</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ParseList">
<MemberSignature Language="C#" Value="public static Gnome.Vfs.Uri[] ParseList (string uri_list);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Uri[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri_list" Type="System.String" />
</Parameters>
<Docs>
<summary>Extracts a list of Uris from a standard text/uri-list, such as one you would get on a drop operation.</summary>
<param name="uri_list">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gnome.Vfs.Uri[]" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Truncate">
<MemberSignature Language="C#" Value="public Gnome.Vfs.Result Truncate (ulong length);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Result</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="length" Type="System.UInt64" />
</Parameters>
<Docs>
<summary>Truncate the Uri to be the specified length in bytes. Data past the specified length will be discarded.</summary>
<param name="length">length of the new file.</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Unlink">
<MemberSignature Language="C#" Value="public Gnome.Vfs.Result Unlink ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Result</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Unlink this Uri (i.e. delete the file).</summary>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object o);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="o" Type="System.Object" />
</Parameters>
<Docs>
<summary>Compare the two Uris.</summary>
<param name="o">a <see cref="T:System.Object" /></param>
<returns>Returns true if the two Uris are equal, otherwise false.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>

16
doc/en/Gnome.Vfs/UriHideOptions.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Enumeration indicating which parts of a <see cref="T:Gnome.Vfs.Uri" /> should be hidden when translated to a <see cref="T:System.String" />.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -41,7 +41,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>don't hide anything.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -54,7 +54,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>hide the user name.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -67,7 +67,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>hide the password.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -80,7 +80,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>hide the host name.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -93,7 +93,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>hide the host port.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -106,7 +106,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>hide the method (e.g. http, file).</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -119,7 +119,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>hide the fragment identifier.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

157
doc/en/Gnome.Vfs/Vfs.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Common VFS tasks.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -26,72 +26,27 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Shutdown">
<MemberSignature Language="C#" Value="public static bool Shutdown ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Exists">
<MemberSignature Language="C#" Value="public static bool Exists (string textUri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="textUri" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="textUri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<summary>If Gnome.Vfs is not already initialized, initialize it. This must be called prior to performing any other Gnome.Vfs operations, and may be called multiple times without error.</summary>
<returns>true if Gnome.Vfs was succesfully initialized or was already initialized.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Move">
<MemberSignature Language="C#" Value="public static Gnome.Vfs.Result Move (string old_uri, string new_uri, bool force_replace);" />
<MemberSignature Language="C#" Value="public static Gnome.Vfs.Result Move (string source, string dest, bool force_replace);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Result</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="old_uri" Type="System.String" />
<Parameter Name="new_uri" Type="System.String" />
<Parameter Name="source" Type="System.String" />
<Parameter Name="dest" Type="System.String" />
<Parameter Name="force_replace" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="old_uri">a <see cref="T:System.String" /></param>
<param name="new_uri">a <see cref="T:System.String" /></param>
<param name="force_replace">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Unlink">
<MemberSignature Language="C#" Value="public static Gnome.Vfs.Result Unlink (string uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Result</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>
<summary>Move a file from source to dest. This will only work if source and dest are on the same file system. Otherwise, it is necessary to use the more general <see cref="M:Gnome.Vfs.Xfer.XferUri" /> function.</summary>
<param name="source">source <see cref="T:Gnome.Vfs.Uri" />.</param>
<param name="dest">destination <see cref="T:Gnome.Vfs.Uri" />.</param>
<param name="force_replace">If true, move target to new_uri even if there is already a file at new_uri. If there is a file, it will be discarded.</param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -106,64 +61,12 @@
<Parameter Name="result" Type="Gnome.Vfs.Result" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="result">a <see cref="T:System.Int32" /></param>
<summary>Returns a string representation of <see cref="T:Gnome.Vfs.Result" />, useful for debugging purposes, but probably not appropriate for passing to the user.</summary>
<param name="result">a <see cref="T:Gnome.Vfs.Result" /> value.</param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ResultToString">
<MemberSignature Language="C#" Value="public static string ResultToString (int result);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="result">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Truncate">
<MemberSignature Language="C#" Value="public static Gnome.Vfs.Result Truncate (string uri, ulong length);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Result</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" />
<Parameter Name="length" Type="System.UInt64" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<param name="length">a <see cref="T:System.UInt64" /></param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Truncate">
<MemberSignature Language="C#" Value="public static Gnome.Vfs.Result Truncate (Gnome.Vfs.Uri uri, ulong length);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gnome.Vfs.Result</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="Gnome.Vfs.Uri" />
<Parameter Name="length" Type="System.UInt64" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<param name="length">a <see cref="T:System.UInt64" /></param>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ThrowException">
<MemberSignature Language="C#" Value="public static void ThrowException (Gnome.Vfs.Result result);" />
<MemberType>Method</MemberType>
@ -174,7 +77,7 @@
<Parameter Name="result" Type="Gnome.Vfs.Result" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Throws a <see cref="T:Gnome.Vfs.VfsException" /> with the appropriate description if the <see cref="T:Gnome.Vfs.Result" /> is not <see cref="M:Gnome.Vfs.Result.Ok" />.</summary>
<param name="result">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
</Docs>
@ -190,10 +93,12 @@
<Parameter Name="result" Type="Gnome.Vfs.Result" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<param name="result">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<summary>Throws a <see cref="T:System.Exception" /> with the appropriate description if the <see cref="T:Gnome.Vfs.Result" /> is not <see cref="M:Gnome.Vfs.Result.Ok" />.</summary>
<param name="uri">
<see cref="T:Gnome.Vfs.Uri" /> to which the <see cref="T:Gnome.Vfs.Result" /> pertains.</param>
<param name="result">
<see cref="T:Gnome.Vfs.Result" /> return value.</param>
<remarks>Throws a <see cref="T:System.IO.FileNotFoundException" /> if <see cref="M:Gnome.Vfs.Result.ErrorNotFound" /> is passed. Otherwise a <see cref="T:Gnome.Vfs.VfsException" /> is thrown.</remarks>
</Docs>
</Member>
<Member MemberName="ThrowException">
@ -207,10 +112,12 @@
<Parameter Name="result" Type="Gnome.Vfs.Result" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<param name="result">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<summary>Throws a <see cref="T:System.Exception" /> with the appropriate description if the <see cref="T:Gnome.Vfs.Result" /> is not <see cref="M:Gnome.Vfs.Result.Ok" />.</summary>
<param name="uri">
<see cref="T:System.String" /> representing the <see cref="T:Gnome.Vfs.Uri" /> in question.</param>
<param name="result">
<see cref="T:Gnome.Vfs.Result" /> return value.</param>
<remarks>Throws a <see cref="T:System.IO.FileNotFoundException" /> if <see cref="M:Gnome.Vfs.Result.ErrorNotFound" /> is passed. Otherwise a <see cref="T:Gnome.Vfs.VfsException" /> is thrown.</remarks>
</Docs>
</Member>
<Member MemberName="Initialized">
@ -221,8 +128,20 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Returns whether Gnome.Vfs has already been initialized.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>Gnome.Vfs must be initialized prior to using any methods or operations.</remarks>
</Docs>
</Member>
<Member MemberName="Shutdown">
<MemberSignature Language="C#" Value="public static void Shutdown ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Cease all active Gnome.Vfs operations and unload the Mime database from memory.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

9
doc/en/Gnome.Vfs/VfsException.xml
View file

@ -9,7 +9,7 @@
</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>
<summary>Custom Vfs <see cref="T:System.Exception" /> class.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -30,8 +30,9 @@
<Parameter Name="result" Type="Gnome.Vfs.Result" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="result">a <see cref="T:System.Int32" /></param>
<summary>Create a new VfsException based on the specified <see cref="T:Gnome.Vfs.Result" />.</summary>
<param name="result">
<see cref="T:Gnome.Vfs.Result" /> return value from an operation.</param>
<returns>a <see cref="T:Gnome.Vfs.VfsException" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -44,7 +45,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>the <see cref="T:Gnome.Vfs.Result" /> error code from the underlying operation.</summary>
<returns>a <see cref="T:Gnome.Vfs.Result" /></returns>
<remarks>To be added</remarks>
</Docs>

48
doc/en/Gnome.Vfs/VfsStream.xml
View file

@ -9,8 +9,12 @@
</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>
<summary>
<see cref="T:System.IO.Stream" /> implementation using the Gnome.Vfs library.</summary>
<remarks>
<para>The VfsStream class hides the Gnome.Vfs API from the developer. It uses the <see cref="T:System.IO.Stream" /> class and associated enums to access the <see cref="T:System.String" /> representation of the <see cref="T:Gnome.Vfs.Uri" /> passed in the constructor.</para>
<para>This class is particularly useful if you want to develop an application that wants to use Gnome.Vfs where available, but can't depend on it being available always. On platforms where Gnome.Vfs is not available, the application can fallback to a regular <see cref="T:System.IO.FileStream" />. This doesn't affect how the rest of the application deals with the stream since both implement the abstract <see cref="T:System.IO.Stream" /> class.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.IO.Stream</BaseTypeName>
@ -234,11 +238,13 @@
<Parameter Name="mode" Type="System.IO.FileMode" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<param name="mode">a <see cref="T:System.Int32" /></param>
<summary>Construct a new instance of the VfsStream with the specified <see cref="T:System.IO.FileMode" />.</summary>
<param name="uri">
<see cref="T:System.String" /> representing the <see cref="T:Gnome.Vfs.Uri" /> to open.</param>
<param name="mode">
<see cref="T:System.IO.FileMode" /> specifying how to open the <see cref="T:Gnome.Vfs.Uri" />.</param>
<returns>a <see cref="T:Gnome.Vfs.VfsStream" /></returns>
<remarks>To be added</remarks>
<remarks>The underlying file will be accessed synchronously using the <see cref="T:Gnome.Vfs.Sync" /> class.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -251,12 +257,14 @@
<Parameter Name="async" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text_uri">a <see cref="T:System.String" /></param>
<param name="mode">a <see cref="T:System.Int32" /></param>
<param name="async">a <see cref="T:System.Boolean" /></param>
<summary>Construct a new instance of the VfsStream with the specified <see cref="T:System.IO.FileMode" />. Based the async parameter, the file will be accessed (a)synchronously.</summary>
<param name="text_uri">
<see cref="T:System.String" /> representing the <see cref="T:Gnome.Vfs.Uri" /> to open.</param>
<param name="mode">
<see cref="T:System.IO.FileMode" /> specifying how to open the <see cref="T:Gnome.Vfs.Uri" />.</param>
<param name="async">whether to access the file (a)sychronously.</param>
<returns>a <see cref="T:Gnome.Vfs.VfsStream" /></returns>
<remarks>To be added</remarks>
<remarks>The underlying file will be accessed either by using the <see cref="T:Gnome.Vfs.Sync" /> or <see cref="T:Gnome.Vfs.Async" /> class.</remarks>
</Docs>
</Member>
<Member MemberName="CanRead">
@ -267,7 +275,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<see cref="T:System.Boolean" /> value indicating whether the current stream supports reading.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -280,7 +289,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<see cref="T:System.Boolean" /> value indicating whether the current stream supports writing.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -293,7 +303,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<see cref="T:System.Boolean" /> value indicating whether the current stream supports seeking.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -306,7 +317,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>
<see cref="T:System.Boolean" /> value indicating whether the current stream is (a)synchronous.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -319,7 +331,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Gets the <see cref="T:System.String" /> representing the <see cref="T:Gnome.Vfs.Uri" /> which this stream reads and writes from.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -332,7 +344,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Gets the length in bytes of the stream.</summary>
<returns>a <see cref="T:System.Int64" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -345,7 +357,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Gets or sets the position within the current stream.</summary>
<returns>a <see cref="T:System.Int64" /></returns>
<remarks>To be added</remarks>
</Docs>

6
gnomevfs/Directory.cs
View file

@ -85,14 +85,14 @@ namespace Gnome.Vfs {
[DllImport ("gnomevfs-2")]
private static extern Result gnome_vfs_make_directory (string uri, uint perm);
public static Result Create (Uri uri, uint perm)
public static Result Create (Uri uri, FilePermissions perm)
{
return Create (uri.ToString (), perm);
}
public static Result Create (string uri, uint perm)
public static Result Create (string uri, FilePermissions perm)
{
return gnome_vfs_make_directory (uri, perm);
return gnome_vfs_make_directory (uri, (uint)perm);
}
[DllImport ("gnomevfs-2")]

13
gnomevfs/Gnomevfs.metadata
View file

@ -38,7 +38,7 @@
<attr path="/api/namespace/enum[@cname='GnomeVFSMimeActionType']" name="name">MimeActionType</attr>
<attr path="/api/namespace/enum[@cname='GnomeVFSMimeApplicationArgumentType']" name="name">MimeApplicationArgumentType</attr>
<attr path="/api/namespace/enum[@cname='GnomeVFSModuleCallbackFullAuthenticationFlags']" name="name">ModuleCallbackFullAuthenticationFlags</attr>
<attr path="/api/namespace/enum[@cname='GnomeVFSMonitorEventType']" name="name">MonitorEventType</attr>
<attr path="/api/namespace/enum[@cname='GnomeVFSMonitorEventType']" name="hidden">1</attr>
<attr path="/api/namespace/enum[@cname='GnomeVFSMonitorType']" name="name">MonitorType</attr>
<attr path="/api/namespace/enum[@cname='GnomeVFSOpenMode']" name="name">OpenMode</attr>
<attr path="/api/namespace/enum[@cname='GnomeVFSProcessOptions']" name="name">ProcessOptions</attr>
@ -103,7 +103,18 @@
<attr path="/api/namespace/struct[@cname='GnomeVFSToplevelURI']" name="name">ToplevelUri</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSTransform']" name="name">Transform</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSURI']" name="name">Uri</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSURI']/method[@name='Dup']" name="name">Clone</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSURI']/method[@name='Exists']" name="name">GetExists</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSURI']/method[@name='Equal']" name="hidden">1</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSURI']/method[@name='Hash']" name="hidden">1</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSURI']/method[@name='Hequal']" name="hidden">1</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSURI']/method[@name='ListCopy']" name="hidden">1</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSURI']/method[@name='ListFree']" name="hidden">1</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSURI']/method[@name='ListParse']" name="hidden">1</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSURI']/method[@name='ListRef']" name="hidden">1</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSURI']/method[@name='ListUnref']" name="hidden">1</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSURI']/method[@name='Ref']" name="hidden">1</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSURI']/method[@name='Unref']" name="hidden">1</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSUnixMount']" name="name">UnixMount</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSUnixMountPoint']" name="name">UnixMountPoint</attr>
<attr path="/api/namespace/struct[@cname='GnomeVFSXferProgressInfo']" name="name">XferProgressInfo</attr>

9
gnomevfs/Monitor.cs
View file

@ -45,6 +45,15 @@ namespace Gnome.Vfs {
}
}
internal enum MonitorEventType {
Changed,
Deleted,
Startexecuting,
Stopexecuting,
Created,
MetadataChanged,
}
public class Monitor {
private IntPtr handle;
private MonitorCallbackWrapper wrapper;

49
gnomevfs/Uri.custom
View file

@ -33,7 +33,56 @@
return new FileInfo (this, options);
}
[DllImport("gnomevfs-2")]
static extern bool gnome_vfs_uri_equal(IntPtr raw, IntPtr b);
public override bool Equals (object o) {
if (o is Uri) {
Uri uri = o as Uri;
return gnome_vfs_uri_equal (Handle, uri.Handle);
} else {
return false;
}
}
[DllImport("gnomevfs-2")]
static extern uint gnome_vfs_uri_hash(IntPtr p);
public override int GetHashCode () {
return checked ((int)gnome_vfs_uri_hash (Handle));
}
[DllImport("gnomevfs-2")]
static extern IntPtr gnome_vfs_uri_list_parse(string uri_list);
public static Uri[] ParseList (string uri_list) {
IntPtr raw_ret = gnome_vfs_uri_list_parse(uri_list);
GLib.List list = new GLib.List(raw_ret);
Uri[] uris = new Uri [list.Count];
for (int i = 0; i < list.Count; i++)
uris[i] = list[i] as Uri;
list.Dispose ();
return uris;
}
public override string ToString ()
{
return ToString (UriHideOptions.None);
}
[DllImport ("gnomevfs-2")]
private static extern Result gnome_vfs_truncate_uri (IntPtr raw, ulong length);
public Result Truncate (ulong length)
{
return gnome_vfs_truncate_uri (Handle, length);
}
[DllImport ("gnomevfs-2")]
private static extern Result gnome_vfs_unlink_from_uri (IntPtr raw);
public Result Unlink ()
{
return gnome_vfs_unlink_from_uri (Handle);
}

39
gnomevfs/Vfs.cs
View file

@ -50,33 +50,19 @@ namespace Gnome.Vfs {
}
[DllImport ("gnomevfs-2")]
static extern bool gnome_vfs_shutdown ();
static extern void gnome_vfs_shutdown ();
public static bool Shutdown ()
public static void Shutdown ()
{
return gnome_vfs_shutdown ();
}
public static bool Exists (string textUri)
{
Uri uri = new Uri (textUri);
return uri.Exists;
gnome_vfs_shutdown ();
}
[DllImport ("gnomevfs-2")]
private static extern Result gnome_vfs_move (string old_uri, string new_uri, bool force_replace);
public static Result Move (string old_uri, string new_uri, bool force_replace)
public static Result Move (string source, string dest, bool force_replace)
{
return gnome_vfs_move (old_uri, new_uri, force_replace);
}
[DllImport ("gnomevfs-2")]
private static extern Result gnome_vfs_unlink (string uri);
public static Result Unlink (string uri)
{
return gnome_vfs_unlink (uri);
return gnome_vfs_move (source, dest, force_replace);
}
[DllImport ("gnomevfs-2")]
@ -87,25 +73,12 @@ namespace Gnome.Vfs {
return ResultToString ((int)result);
}
public static string ResultToString (int result)
internal static string ResultToString (int result)
{
IntPtr ptr = gnome_vfs_result_to_string (result);
return Marshal.PtrToStringAnsi (ptr);
}
[DllImport ("gnomevfs-2")]
private static extern Result gnome_vfs_truncate (string uri, ulong length);
public static Result Truncate (string uri, ulong length)
{
return gnome_vfs_truncate (uri, length);
}
public static Result Truncate (Uri uri, ulong length)
{
return Truncate (uri.ToString (), length);
}
public static void ThrowException (Result result)
{
ThrowException ((string)null, result);

6
gnomevfs/VfsStream.cs
View file

@ -153,7 +153,7 @@ namespace Gnome.Vfs {
if (mode == FileMode.CreateNew) {
string dname = uri.ExtractDirname ();
if (dname != "" && !Vfs.Exists (dname))
if (dname != "" && !new Uri (dname).Exists)
throw new DirectoryNotFoundException ("Could not find a part of " +
"the path \"" + dname + "\".");
}
@ -231,7 +231,7 @@ namespace Gnome.Vfs {
Wait ();
} else {
handle = Sync.Open (uri, om);
result = Sync.Truncate (handle, 0);
result = uri.Truncate (0);
Vfs.ThrowException (uri, result);
}
} else {
@ -289,7 +289,7 @@ namespace Gnome.Vfs {
break;
case FileMode.Truncate:
if (uri.Exists) {
result = Vfs.Truncate (uri, 0);
result = uri.Truncate (0);
if (async) {
handle = Async.Open (uri, om,
(int)Async.Priority.Default,

2
sample/gnomevfs/TestUnlink.cs
View file

@ -13,7 +13,7 @@ namespace Test.Gnome.Vfs {
Gnome.Vfs.Vfs.Initialize ();
Gnome.Vfs.Uri uri = new Gnome.Vfs.Uri (args[0]);
Result result = Gnome.Vfs.Vfs.Unlink (uri.ToString ());
Result result = uri.Unlink ();
Console.WriteLine ("result unlink ('{0}') = {1}", uri, result);