diff --git a/doc/ChangeLog b/doc/ChangeLog index 6ed0beb74..5405fa2b3 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,13 @@ +2004-12-30 Shane Landrum + + * 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 * en/Gtk/IconSource.xml diff --git a/doc/en/Gtk/FileFilterInfo.xml b/doc/en/Gtk/FileFilterInfo.xml index ae4b781f0..774e99402 100644 --- a/doc/en/Gtk/FileFilterInfo.xml +++ b/doc/en/Gtk/FileFilterInfo.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Used to pass information about files to . Mostly for internal use. + System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + An empty FileFilterInfo + @@ -40,8 +40,8 @@ - To be added - To be added + Flags indicating which of the fields are filled. + @@ -53,8 +53,8 @@ - To be added - To be added + The filename of the file being tested + @@ -66,8 +66,8 @@ - To be added - To be added + The URI for the file being tested + @@ -79,8 +79,8 @@ - To be added - To be added + The string that will be used to display the file in the file chooser + @@ -92,8 +92,8 @@ - To be added - To be added + The mime type of the file + @@ -106,11 +106,12 @@ - To be added + Public constructor. a a - To be added + XXX: the API here needs adjusting, as this shouldn't + require an IntPtr parameter. - \ No newline at end of file + diff --git a/doc/en/Gtk/FileInfo.xml b/doc/en/Gtk/FileInfo.xml index e36ecf334..c3e5e87fc 100644 --- a/doc/en/Gtk/FileInfo.xml +++ b/doc/en/Gtk/FileInfo.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. To be added - To be added + GLib.Opaque @@ -31,7 +31,7 @@ To be added - To be added + @@ -44,7 +44,7 @@ To be added a - To be added + @@ -58,7 +58,7 @@ To be added a a - To be added + @@ -69,7 +69,7 @@ To be added a - To be added + @@ -82,7 +82,7 @@ To be added a - To be added + @@ -95,7 +95,7 @@ To be added a - To be added + @@ -108,7 +108,7 @@ To be added a - To be added + @@ -121,7 +121,7 @@ To be added a - To be added + @@ -134,7 +134,7 @@ To be added a - To be added + @@ -147,7 +147,7 @@ To be added a - To be added + @@ -160,7 +160,7 @@ To be added a - To be added + @@ -173,8 +173,8 @@ To be added a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/FileInfoType.xml b/doc/en/Gtk/FileInfoType.xml index 09bde6431..3af189cc0 100644 --- a/doc/en/Gtk/FileInfoType.xml +++ b/doc/en/Gtk/FileInfoType.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. To be added - To be added + System.Enum @@ -42,7 +42,7 @@ To be added - To be added + @@ -55,7 +55,7 @@ To be added - To be added + @@ -68,7 +68,7 @@ To be added - To be added + @@ -81,7 +81,7 @@ To be added - To be added + @@ -94,7 +94,7 @@ To be added - To be added + @@ -107,7 +107,7 @@ To be added - To be added + @@ -120,7 +120,7 @@ To be added - To be added + @@ -137,4 +137,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/FileSystem.xml b/doc/en/Gtk/FileSystem.xml index b1be4c084..a356d9cea 100644 --- a/doc/en/Gtk/FileSystem.xml +++ b/doc/en/Gtk/FileSystem.xml @@ -9,8 +9,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Interface class for representing filesystems. + For concrete implementations, see + and + . @@ -28,9 +30,13 @@ - To be added - a - To be added + Queries the list of bookmarks in the file system. + a , a list of + objects, or + if there are no configured bookmarks. + + See also . + @@ -43,10 +49,18 @@ - To be added + + Removes a bookmark folder from the user's bookmarks list. + a a - To be added + + If the operation succeeds, the + + signal will be emitted. If you try to remove + a which does not exist in the bookmarks + list, the operation will fail and an exception will be thrown. + @@ -60,11 +74,16 @@ - To be added + + Gets the name of the parent folder of a path. + a a a - To be added + + If the path has no parent, as when you request the parent of a file system root, + then will be set to . + @@ -78,11 +97,14 @@ - To be added + + Makes a new path called + starting from path . + a a a - To be added + @@ -96,11 +118,11 @@ - To be added + Gets an object to represent the folder at path . a a a - To be added + @@ -113,10 +135,11 @@ - To be added + Converts to a filename string. a - a - To be added + a , or + if the path is not local. + @@ -129,10 +152,10 @@ - To be added + Converts a URI to a object. a a - To be added + @@ -145,10 +168,10 @@ - To be added + Converts to a URI. a a - To be added + @@ -161,10 +184,13 @@ - To be added + + Determines what volume of the filesystem + is located on. + a a - To be added + @@ -177,10 +203,10 @@ - To be added + Converts into a . a a - To be added + @@ -200,7 +226,7 @@ a a a - To be added + @@ -214,11 +240,28 @@ - To be added + + Adds a path for a folder to the user's bookmarks list. + a - a + a , index in + the bookmarks list at which the should + be inserted; use 0 for the beginning, and -1 or the number of + bookmarks itself for the end of the list. a - To be added + + If the operation + succeeds, the + signal will be emitted. Bookmark paths are + unique; if you try to insert a that + already exists, the operation will fail and an exception will + be thrown. + To reorder the list of bookmarks, use + to + remove the path in question, and call + with + the new position for the path. + @@ -231,10 +274,12 @@ - To be added + Checks to see whether a path is local; that is, + whether would + return non-. a a - To be added + @@ -245,9 +290,10 @@ - To be added + Gets a list of all the s + on the system. a - To be added + @@ -263,13 +309,37 @@ - To be added - a - a - a - a + + 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 + . + + a , reference folder with respect to which relative paths should be interpreted. + a , the string to parse + a , a location to store folder portion of result, or + a , location to store file portion of result, or a - To be added + + + 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. + + + If parsing fails because the syntax of is not understood, + an exception "GTK_FILE_SYSTEM_ERROR_BAD_FILENAME" will + be thrown and returned. + + + 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 returned. + (This only applies to parsing relative paths, + not to interpretation of . No check is made as + to whether exists.) + @@ -282,10 +352,10 @@ - To be added + Makes a new folder at a a - To be added + @@ -296,8 +366,9 @@ - To be added - To be added + Emitted when a related + is mounted. + @@ -308,9 +379,9 @@ - To be added - To be added + Event fired whenever the bookmarks to particular locations change. + - \ No newline at end of file + diff --git a/doc/en/Gtk/FileSystemUnix.xml b/doc/en/Gtk/FileSystemUnix.xml index f8317a61c..a1c5a6152 100644 --- a/doc/en/Gtk/FileSystemUnix.xml +++ b/doc/en/Gtk/FileSystemUnix.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. To be added - To be added + GLib.Object @@ -51,7 +51,7 @@ To be added a - To be added + @@ -67,7 +67,7 @@ To be added a a - To be added + @@ -85,7 +85,7 @@ a a a - To be added + @@ -103,7 +103,7 @@ a a a - To be added + @@ -121,7 +121,7 @@ a a a - To be added + @@ -137,7 +137,7 @@ To be added a a - To be added + @@ -153,7 +153,7 @@ To be added a a - To be added + @@ -169,7 +169,7 @@ To be added a a - To be added + @@ -185,7 +185,7 @@ To be added a a - To be added + @@ -201,7 +201,7 @@ To be added a a - To be added + @@ -221,7 +221,7 @@ a a a - To be added + @@ -239,7 +239,7 @@ a a a - To be added + @@ -255,7 +255,7 @@ To be added a a - To be added + @@ -268,7 +268,7 @@ To be added a - To be added + @@ -290,7 +290,7 @@ a a a - To be added + @@ -306,7 +306,7 @@ To be added a a - To be added + @@ -369,7 +369,7 @@ To be added a - To be added + @@ -394,7 +394,7 @@ To be added - To be added + @@ -406,8 +406,8 @@ To be added - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/FileSystemVolume.xml b/doc/en/Gtk/FileSystemVolume.xml index a8b4e1b93..a761d7938 100644 --- a/doc/en/Gtk/FileSystemVolume.xml +++ b/doc/en/Gtk/FileSystemVolume.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Represents a volume of a filesystem; typically, this corresponds to one physical or logical hard drive. + GLib.Opaque @@ -33,11 +33,15 @@ - To be added + Queries the human-readable name for a volume. + a a a - To be added + + This string can be displayed + in a list of volumes that can be accessed, for example. + @@ -51,11 +55,12 @@ - To be added + Returns the base path of this volume. a a a - To be added + For example, a CD-ROM device may yield a path of "/mnt/cdrom" + on Linux. @@ -69,10 +74,10 @@ - To be added + Frees memory used by this data structure. a a - To be added + XXX: should this even exist? @@ -94,7 +99,7 @@ a a a - To be added + @@ -108,11 +113,16 @@ - To be added + + Tries to mount an unmounted volume. + a a - a - To be added + a , true if the volume was mounted successfully, false otherwise. + + This may cause the signal in the + to be emitted. + @@ -126,11 +136,12 @@ - To be added + Queries whether a volume is mounted or not. a a a - To be added + If the volume is not mounted, it can be mounted with + . @@ -141,11 +152,11 @@ - To be added - a + Public constructor. For internal use; do not use. + a , pointer to the underlying C object. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/FileSystemWin32.xml b/doc/en/Gtk/FileSystemWin32.xml index a12059be6..13a4776f4 100644 --- a/doc/en/Gtk/FileSystemWin32.xml +++ b/doc/en/Gtk/FileSystemWin32.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A class for representing filesystem interactions on Win32. + GLib.Object @@ -51,7 +51,7 @@ To be added a - To be added + @@ -67,7 +67,7 @@ To be added a a - To be added + @@ -85,7 +85,7 @@ a a a - To be added + @@ -103,7 +103,7 @@ a a a - To be added + @@ -121,7 +121,7 @@ a a a - To be added + @@ -137,7 +137,7 @@ To be added a a - To be added + @@ -153,7 +153,7 @@ To be added a a - To be added + @@ -169,7 +169,7 @@ To be added a a - To be added + @@ -185,7 +185,7 @@ To be added a a - To be added + @@ -201,7 +201,7 @@ To be added a a - To be added + @@ -221,7 +221,7 @@ a a a - To be added + @@ -239,7 +239,7 @@ a a a - To be added + @@ -255,7 +255,7 @@ To be added a a - To be added + @@ -268,7 +268,7 @@ To be added a - To be added + @@ -290,7 +290,7 @@ a a a - To be added + @@ -306,7 +306,7 @@ To be added a a - To be added + @@ -369,7 +369,7 @@ To be added a - To be added + @@ -394,7 +394,7 @@ To be added - To be added + @@ -406,8 +406,8 @@ To be added - To be added + - \ No newline at end of file +