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

2004-12-30 Shane Landrum <epicene@pobox.com>

Browse source 
* en/Gtk/FileSystem.xml
	* en/Gtk/FileInfo.xml
	* en/Gtk/FileInfoType.xml
	* en/Gtk/FileSystemUnix.xml
	* en/Gtk/FileSystemVolume.xml
	* en/Gtk/FileSystemWin32.xml
	* en/Gtk/FileFilterInfo.xml: Docs for filesystem-handling classes.


svn path=/trunk/gtk-sharp/; revision=38214
This commit is contained in:
Shane Landrum 2004-12-31 00:32:25 +00:00
parent 58bee3e00d
commit d4ccc144cf
8 changed files with 239 additions and 146 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/ChangeLog
View file

@ -1,3 +1,13 @@
2004-12-30 Shane Landrum <epicene@pobox.com>
* en/Gtk/FileSystem.xml
* en/Gtk/FileInfo.xml
* en/Gtk/FileInfoType.xml
* en/Gtk/FileSystemUnix.xml
* en/Gtk/FileSystemVolume.xml
* en/Gtk/FileSystemWin32.xml
* en/Gtk/FileFilterInfo.xml: Docs for filesystem-handling classes.
2004-12-30 Shane Landrum <epicene@pobox.com>
* en/Gtk/IconSource.xml

35
doc/en/Gtk/FileFilterInfo.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>Used to pass information about files to <see cref="M:Gtk.FileFilter.Filter"/>.</summary> Mostly for internal use.
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>An empty FileFilterInfo</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Contains">
@ -40,8 +40,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Flags indicating which of the fields are filled.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Filename">
@ -53,8 +53,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The filename of the file being tested</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Uri">
@ -66,8 +66,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The URI for the file being tested</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DisplayName">
@ -79,8 +79,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The string that will be used to display the file in the file chooser</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="MimeType">
@ -92,8 +92,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The mime type of the file</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="New">
@ -106,11 +106,12 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Public constructor.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.FileFilterInfo" /></returns>
<remarks>To be added</remarks>
<remarks>XXX: the API here needs adjusting, as this shouldn't
require an IntPtr parameter.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

28
doc/en/Gtk/FileInfo.xml
View file

@ -10,7 +10,7 @@
<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>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
@ -31,7 +31,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Copy">
@ -44,7 +44,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.FileInfo" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -58,7 +58,7 @@
<summary>To be added</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.FileInfo" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -69,7 +69,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.FileInfo" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -82,7 +82,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DisplayName">
@ -95,7 +95,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="MimeType">
@ -108,7 +108,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ModificationTime">
@ -121,7 +121,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int64" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Size">
@ -134,7 +134,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int64" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IsHidden">
@ -147,7 +147,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DisplayKey">
@ -160,7 +160,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IsFolder">
@ -173,8 +173,8 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

18
doc/en/Gtk/FileInfoType.xml
View file

@ -10,7 +10,7 @@
<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>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -42,7 +42,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IsFolder">
@ -55,7 +55,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IsHidden">
@ -68,7 +68,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="MimeType">
@ -81,7 +81,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ModificationTime">
@ -94,7 +94,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Size">
@ -107,7 +107,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="All">
@ -120,7 +120,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="value__">
@ -137,4 +137,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

161
doc/en/Gtk/FileSystem.xml
View file

@ -9,8 +9,10 @@
</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>Interface class for representing filesystems.</summary>
<remarks>For concrete implementations, see
<see cref="T:Gtk.FileSystem.Win32"/> and
<see cref="T:Gtk.FileSystem.Unix"/>.</remarks>
</Docs>
<Base />
<Interfaces>
@ -28,9 +30,13 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks>
<summary>Queries the list of bookmarks in the file system.</summary>
<returns>a <see cref="T:GLib.SList" />, a list of
<see cref="T:Gtk.FilePath"/> objects, or
<see langword="null"/> if there are no configured bookmarks.</returns>
<remarks>
See also <see cref="M:Gtk.FileSystem.RemoveBookmark"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="RemoveBookmark">
@ -43,10 +49,18 @@
<Parameter Name="path" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Removes a bookmark folder from the user's bookmarks list.
</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>
If the operation succeeds, the
<see cref="E:Gtk.FileSystem.BookmarksChanged"/>
signal will be emitted. If you try to remove
a <paramref name="path"/> which does not exist in the bookmarks
list, the operation will fail and an exception will be thrown.
</remarks>
</Docs>
</Member>
<Member MemberName="GetParent">
@ -60,11 +74,16 @@
<Parameter Name="parent" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Gets the name of the parent folder of a path.
</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<param name="parent">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>
If the path has no parent, as when you request the parent of a file system root,
then <paramref name="parent"/> will be set to <see langword="null"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="MakePath">
@ -78,11 +97,14 @@
<Parameter Name="display_name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Makes a new path called <paramref name="display_name"/>
starting from path <paramref name="base_path"/>.
</summary>
<param name="base_path">a <see cref="T:Gtk.FilePath" /></param>
<param name="display_name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetFolder">
@ -96,11 +118,11 @@
<Parameter Name="types" Type="Gtk.FileInfoType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Gets an object to represent the folder at path <paramref name="path"/>.</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<param name="types">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gtk.FileFolder" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PathToFilename">
@ -113,10 +135,11 @@
<Parameter Name="path" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Converts <paramref name="path"/> to a filename string.</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.String" />, or <see langword="null"/>
if the path is not local.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="UriToPath">
@ -129,10 +152,10 @@
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Converts a URI to a <see cref="T:Gtk.FilePath" /> object.</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PathToUri">
@ -145,10 +168,10 @@
<Parameter Name="path" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Converts <paramref name="path"/> to a URI.</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetVolumeForPath">
@ -161,10 +184,13 @@
<Parameter Name="path" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Determines what volume of the filesystem
<paramref name="path"/> is located on.
</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:Gtk.FileSystemVolume" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="FilenameToPath">
@ -177,10 +203,10 @@
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Converts <paramref name="filename"/> into a <see cref="T:Gtk.FilePath" />.</summary>
<param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RenderIcon">
@ -200,7 +226,7 @@
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="pixel_size">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="InsertBookmark">
@ -214,11 +240,28 @@
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Adds a path for a folder to the user's bookmarks list.
</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<param name="position">a <see cref="T:System.Int32" /></param>
<param name="position">a <see cref="T:System.Int32" />, index in
the bookmarks list at which the <paramref name="path"/> should
be inserted; use 0 for the beginning, and -1 or the number of
bookmarks itself for the end of the list.</param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>If the operation
succeeds, the <see cref="E:Gtk.FileSystem.BookmarksChanged"/>
signal will be emitted. Bookmark paths are
unique; if you try to insert a <paramref name="path"/> that
already exists, the operation will fail and an exception will
be thrown.</para>
<para>To reorder the list of bookmarks, use
<see cref="M:Gtk.FileSystem.RemoveBookmark"/> to
remove the path in question, and call
<see cref="M:Gtk.FileSystem.InsertBookmark"/> with
the new position for the path.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="PathIsLocal">
@ -231,10 +274,12 @@
<Parameter Name="path" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Checks to see whether a path is local; that is,
whether <see cref="M:Gtk.FileSystem.PathToFilename"/> would
return non-<see langword="null"/>.</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ListVolumes">
@ -245,9 +290,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Gets a list of all the <see cref="T:Gtk.FileSystemVolume"/>s
on the system.</summary>
<returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Parse">
@ -263,13 +309,37 @@
<Parameter Name="file_part" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="base_path">a <see cref="T:Gtk.FilePath" /></param>
<param name="str">a <see cref="T:System.String" /></param>
<param name="folder">a <see cref="T:Gtk.FilePath" /></param>
<param name="file_part">a <see cref="T:System.String" /></param>
<summary>
Given a string entered by a user, parse it (possibly using
heuristics) into a folder path and a UTF-8 encoded
filename part suitable for passing to
<see cref="M:Gtk.FileSystem.MakePath"/>.
</summary>
<param name="base_path">a <see cref="T:Gtk.FilePath" />, reference folder with respect to which relative paths should be interpreted.</param>
<param name="str">a <see cref="T:System.String" />, the string to parse</param>
<param name="folder">a <see cref="T:Gtk.FilePath" />, a location to store folder portion of result, or <see langword="null"/></param>
<param name="file_part">a <see cref="T:System.String" />, location to store file portion of result, or <see langword="null"/></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>
Note that the returned filename point may point to a subfolder
of the returned folder. Adding a trailing path separator is needed
to enforce the interpretation as a folder name.
</para>
<para>
If parsing fails because the syntax of <paramref name="str"/> is not understood,
an exception "GTK_FILE_SYSTEM_ERROR_BAD_FILENAME" will
be thrown and <see langword="false"/> returned.
</para>
<para>
If parsing fails because a path was encountered that doesn't
exist on the filesystem, then an exception
"GTK_FILE_SYSTEM_ERROR_NONEXISTENT" will be thrown
and <see langword="false"/> returned.
(This only applies to parsing relative paths,
not to interpretation of <paramref name="file_part"/>. No check is made as
to whether <paramref name="file_part"/> exists.)
</para> </remarks>
</Docs>
</Member>
<Member MemberName="CreateFolder">
@ -282,10 +352,10 @@
<Parameter Name="path" Type="Gtk.FilePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Makes a new folder at <paramref name="path"/></summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="VolumesChanged">
@ -296,8 +366,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a related <see cref="M:Gtk.FileSystemVolume"/>
is mounted.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="BookmarksChanged">
@ -308,9 +379,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Event fired whenever the bookmarks to particular locations change.</summary>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

42
doc/en/Gtk/FileSystemUnix.xml
View file

@ -10,7 +10,7 @@
<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>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -51,7 +51,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RemoveBookmark">
@ -67,7 +67,7 @@
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetParent">
@ -85,7 +85,7 @@
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<param name="parent">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="MakePath">
@ -103,7 +103,7 @@
<param name="base_path">a <see cref="T:Gtk.FilePath" /></param>
<param name="display_name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetFolder">
@ -121,7 +121,7 @@
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<param name="types">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gtk.FileFolder" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PathToFilename">
@ -137,7 +137,7 @@
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="UriToPath">
@ -153,7 +153,7 @@
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PathToUri">
@ -169,7 +169,7 @@
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetVolumeForPath">
@ -185,7 +185,7 @@
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:Gtk.FileSystemVolume" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="FilenameToPath">
@ -201,7 +201,7 @@
<summary>To be added</summary>
<param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RenderIcon">
@ -221,7 +221,7 @@
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="pixel_size">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="InsertBookmark">
@ -239,7 +239,7 @@
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<param name="position">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PathIsLocal">
@ -255,7 +255,7 @@
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ListVolumes">
@ -268,7 +268,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Parse">
@ -290,7 +290,7 @@
<param name="folder">a <see cref="T:Gtk.FilePath" /></param>
<param name="file_part">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CreateFolder">
@ -306,7 +306,7 @@
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="OnVolumesChanged">
@ -369,7 +369,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.FileSystemUnix" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -394,7 +394,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="BookmarksChanged">
@ -406,8 +406,8 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

47
doc/en/Gtk/FileSystemVolume.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>Represents a volume of a filesystem; typically, this corresponds to one physical or logical hard drive.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
@ -33,11 +33,15 @@
<Parameter Name="volume" Type="Gtk.FileSystemVolume" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Queries the human-readable name for a volume.
</summary>
<param name="file_system">a <see cref="T:Gtk.FileSystem" /></param>
<param name="volume">a <see cref="T:Gtk.FileSystemVolume" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks>
This string can be displayed
in a list of volumes that can be accessed, for example.
</remarks>
</Docs>
</Member>
<Member MemberName="GetBasePath">
@ -51,11 +55,12 @@
<Parameter Name="volume" Type="Gtk.FileSystemVolume" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Returns the base path of this volume.</summary>
<param name="file_system">a <see cref="T:Gtk.FileSystem" /></param>
<param name="volume">a <see cref="T:Gtk.FileSystemVolume" /></param>
<returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks>
<remarks> For example, a CD-ROM device may yield a path of "/mnt/cdrom"
on Linux.</remarks>
</Docs>
</Member>
<Member MemberName="Free">
@ -69,10 +74,10 @@
<Parameter Name="volume" Type="Gtk.FileSystemVolume" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Frees memory used by this data structure.</summary>
<param name="file_system">a <see cref="T:Gtk.FileSystem" /></param>
<param name="volume">a <see cref="T:Gtk.FileSystemVolume" /></param>
<remarks>To be added</remarks>
<remarks>XXX: should this even exist?</remarks>
</Docs>
</Member>
<Member MemberName="RenderIcon">
@ -94,7 +99,7 @@
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="pixel_size">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Mount">
@ -108,11 +113,16 @@
<Parameter Name="volume" Type="Gtk.FileSystemVolume" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Tries to mount an unmounted volume.
</summary>
<param name="file_system">a <see cref="T:Gtk.FileSystem" /></param>
<param name="volume">a <see cref="T:Gtk.FileSystemVolume" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.Boolean" />, true if the volume was mounted successfully, false otherwise.</returns>
<remarks>
This may cause the <see cref="M:Gtk.FileSystem.VolumesChanged"/> signal in the
<paramref name="file_system"/> to be emitted.
</remarks>
</Docs>
</Member>
<Member MemberName="GetIsMounted">
@ -126,11 +136,12 @@
<Parameter Name="volume" Type="Gtk.FileSystemVolume" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Queries whether a volume is mounted or not.</summary>
<param name="file_system">a <see cref="T:Gtk.FileSystem" /></param>
<param name="volume">a <see cref="T:Gtk.FileSystemVolume" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>If the volume is not mounted, it can be mounted with
<see cref="M:Gtk.FileSystemVolume.Mount"/>.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -141,11 +152,11 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<summary>Public constructor. For internal use; do not use.</summary>
<param name="raw">a <see cref="T:System.IntPtr" />, pointer to the underlying C object.</param>
<returns>a <see cref="T:Gtk.FileSystemVolume" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

44
doc/en/Gtk/FileSystemWin32.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>A class for representing filesystem interactions on Win32.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -51,7 +51,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RemoveBookmark">
@ -67,7 +67,7 @@
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetParent">
@ -85,7 +85,7 @@
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<param name="parent">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="MakePath">
@ -103,7 +103,7 @@
<param name="base_path">a <see cref="T:Gtk.FilePath" /></param>
<param name="display_name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetFolder">
@ -121,7 +121,7 @@
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<param name="types">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gtk.FileFolder" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PathToFilename">
@ -137,7 +137,7 @@
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="UriToPath">
@ -153,7 +153,7 @@
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PathToUri">
@ -169,7 +169,7 @@
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetVolumeForPath">
@ -185,7 +185,7 @@
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:Gtk.FileSystemVolume" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="FilenameToPath">
@ -201,7 +201,7 @@
<summary>To be added</summary>
<param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.FilePath" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RenderIcon">
@ -221,7 +221,7 @@
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="pixel_size">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="InsertBookmark">
@ -239,7 +239,7 @@
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<param name="position">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PathIsLocal">
@ -255,7 +255,7 @@
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ListVolumes">
@ -268,7 +268,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Parse">
@ -290,7 +290,7 @@
<param name="folder">a <see cref="T:Gtk.FilePath" /></param>
<param name="file_part">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CreateFolder">
@ -306,7 +306,7 @@
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.FilePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="OnVolumesChanged">
@ -369,7 +369,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.FileSystemWin32" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -394,7 +394,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="BookmarksChanged">
@ -406,8 +406,8 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>