diff --git a/doc/ChangeLog b/doc/ChangeLog index 5405fa2b3..6655819c1 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,15 @@ +2004-12-31 Shane Landrum + + * en/Gtk/FileSystem.xml + * en/Gtk/FileSystemUnix.xml + * en/Gtk/FileSystemVolume.xml + * en/Gtk/FileSystemWin32.xml: Filesystem docs. + * en/Gtk/FilesAddedHandler.xml + * en/Gtk/FilesChangedHandler.xml + * en/Gtk/FilesRemovedHandler.xml: Handler docs. + * en/Gtk/FileInfoType.xml + * en/Gtk/FileSystemError.xml: Docs for some enums. + 2004-12-30 Shane Landrum * en/Gtk/FileSystem.xml diff --git a/doc/en/Gtk/FileInfoType.xml b/doc/en/Gtk/FileInfoType.xml index 3af189cc0..8244f8ec2 100644 --- a/doc/en/Gtk/FileInfoType.xml +++ b/doc/en/Gtk/FileInfoType.xml @@ -9,7 +9,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + Enumeration to represent information about a file. diff --git a/doc/en/Gtk/FileSystem.xml b/doc/en/Gtk/FileSystem.xml index a356d9cea..34d0d0793 100644 --- a/doc/en/Gtk/FileSystem.xml +++ b/doc/en/Gtk/FileSystem.xml @@ -221,7 +221,7 @@ - To be added + Returns an icon to represent this filesystem. a a a @@ -328,13 +328,13 @@ If parsing fails because the syntax of is not understood, - an exception "GTK_FILE_SYSTEM_ERROR_BAD_FILENAME" will + an exception 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 + will be thrown and returned. (This only applies to parsing relative paths, not to interpretation of . No check is made as diff --git a/doc/en/Gtk/FileSystemError.xml b/doc/en/Gtk/FileSystemError.xml index 44491ef14..6323857be 100644 --- a/doc/en/Gtk/FileSystemError.xml +++ b/doc/en/Gtk/FileSystemError.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 + Types of errors that can be encountered by classes. + System.Enum @@ -37,8 +37,8 @@ - To be added - To be added + The path referred to does not exist. + @@ -50,8 +50,8 @@ - To be added - To be added + The path referred to is not a folder. + @@ -63,8 +63,8 @@ - To be added - To be added + The given URI is not valid. + @@ -76,8 +76,9 @@ - To be added - To be added + The given filename is not valid. + This may mean that an illegal character has been specified + as part of the filename. @@ -89,8 +90,8 @@ - To be added - To be added + A general failure error, used for errors not otherwise covered. + @@ -102,8 +103,8 @@ - To be added - To be added + There was an attempt to create a file or folder that already exists. + @@ -120,4 +121,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/FileSystemUnix.xml b/doc/en/Gtk/FileSystemUnix.xml index a1c5a6152..ab1ab213c 100644 --- a/doc/en/Gtk/FileSystemUnix.xml +++ b/doc/en/Gtk/FileSystemUnix.xml @@ -9,7 +9,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + Filesystem interface layer for Unix-style systems. @@ -49,9 +49,13 @@ - To be added - a - + Queries the list of bookmarks in the file system. + a , a list of + objects, or + if there are no configured bookmarks. + + See also . + @@ -64,10 +68,18 @@ - To be added + + Removes a bookmark folder from the user's bookmarks list. + a a - + + 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. + @@ -81,11 +93,16 @@ - To be added + + Gets the name of the parent folder of a path. + a a a - + + If the path has no parent, as when you request the parent of a file system root, + then will be set to . + @@ -99,7 +116,10 @@ - To be added + + Makes a new path called + starting from path . + a a a @@ -117,7 +137,7 @@ - To be added + Gets an object to represent the folder at path . a a a @@ -134,9 +154,10 @@ - To be added + Converts to a filename string. a - a + a , or + if the path is not local. @@ -150,7 +171,7 @@ - To be added + Converts a URI to a object. a a @@ -166,7 +187,7 @@ - To be added + Converts to a URI. a a @@ -182,7 +203,10 @@ - To be added + + Determines what volume of the filesystem + is located on. + a a @@ -198,7 +222,7 @@ - To be added + Converts into a . a a @@ -216,7 +240,7 @@ - To be added + Returns an icon to represent this filesystem. a a a @@ -235,11 +259,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 - + + 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. + @@ -252,7 +293,9 @@ - To be added + Checks to see whether a path is local; that is, + whether would + return non-. a a @@ -266,7 +309,8 @@ - To be added + Gets a list of all the s + on the system. a @@ -284,13 +328,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 - + + + 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 will + be thrown and returned. + + + If parsing fails because a path was encountered that doesn't + exist on the filesystem, then an exception + will be thrown + and returned. + (This only applies to parsing relative paths, + not to interpretation of . No check is made as + to whether exists.) + @@ -303,7 +371,7 @@ - To be added + Makes a new folder at . a a @@ -367,7 +435,7 @@ - To be added + Public constructor. a @@ -393,7 +461,8 @@ - To be added + Emitted when a related + is mounted. @@ -405,7 +474,7 @@ - To be added + Event fired whenever the bookmarks to particular locations change. diff --git a/doc/en/Gtk/FileSystemVolume.xml b/doc/en/Gtk/FileSystemVolume.xml index a761d7938..13e3a17d5 100644 --- a/doc/en/Gtk/FileSystemVolume.xml +++ b/doc/en/Gtk/FileSystemVolume.xml @@ -93,7 +93,7 @@ - To be added + Returns an icon to represent this volume. a a a diff --git a/doc/en/Gtk/FileSystemWin32.xml b/doc/en/Gtk/FileSystemWin32.xml index 13a4776f4..1c26540af 100644 --- a/doc/en/Gtk/FileSystemWin32.xml +++ b/doc/en/Gtk/FileSystemWin32.xml @@ -49,9 +49,13 @@ - To be added - a - + Queries the list of bookmarks in the file system. + a , a list of + objects, or + if there are no configured bookmarks. + + See also . + @@ -64,10 +68,18 @@ - To be added + + Removes a bookmark folder from the user's bookmarks list. + a a - + + 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. + @@ -81,11 +93,16 @@ - To be added + + Gets the name of the parent folder of a path. + a a a - + + If the path has no parent, as when you request the parent of a file system root, + then will be set to . + @@ -99,7 +116,10 @@ - To be added + + Makes a new path called + starting from path . + a a a @@ -117,7 +137,7 @@ - To be added + Gets an object to represent the folder at path . a a a @@ -134,9 +154,10 @@ - To be added + Converts to a filename string. a - a + a , or + if the path is not local. @@ -150,7 +171,7 @@ - To be added + Converts a URI to a object. a a @@ -166,7 +187,7 @@ - To be added + Converts to a URI. a a @@ -182,7 +203,10 @@ - To be added + + Determines what volume of the filesystem + is located on. + a a @@ -198,7 +222,7 @@ - To be added + Converts into a . a a @@ -216,7 +240,7 @@ - To be added + Returns an icon to represent this filesystem. a a a @@ -235,11 +259,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 - + + 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. + @@ -252,7 +293,9 @@ - To be added + Checks to see whether a path is local; that is, + whether would + return non-. a a @@ -266,7 +309,8 @@ - To be added + Gets a list of all the s + on the system. a @@ -284,13 +328,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 - + + + 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 will + be thrown and returned. + + + If parsing fails because a path was encountered that doesn't + exist on the filesystem, then an exception + will be thrown + and returned. + (This only applies to parsing relative paths, + not to interpretation of . No check is made as + to whether exists.) + @@ -303,7 +371,7 @@ - To be added + Makes a new folder at a a @@ -367,7 +435,7 @@ - To be added + Public constructor. a @@ -393,7 +461,8 @@ - To be added + Emitted when a related + is mounted. @@ -405,7 +474,7 @@ - To be added + Event fired whenever the bookmarks to particular locations change. diff --git a/doc/en/Gtk/FilesAddedHandler.xml b/doc/en/Gtk/FilesAddedHandler.xml index d2c2b2d9a..3c348b083 100644 --- a/doc/en/Gtk/FilesAddedHandler.xml +++ b/doc/en/Gtk/FilesAddedHandler.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 + Event handler for . + System.Delegate @@ -32,4 +32,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/FilesChangedHandler.xml b/doc/en/Gtk/FilesChangedHandler.xml index 0ae5e38ab..598caf4f9 100644 --- a/doc/en/Gtk/FilesChangedHandler.xml +++ b/doc/en/Gtk/FilesChangedHandler.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 + Event handler for . + System.Delegate @@ -32,4 +32,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/FilesRemovedHandler.xml b/doc/en/Gtk/FilesRemovedHandler.xml index 7ad27613c..028fbee68 100644 --- a/doc/en/Gtk/FilesRemovedHandler.xml +++ b/doc/en/Gtk/FilesRemovedHandler.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 + Event handler for . + System.Delegate @@ -32,4 +32,4 @@ - \ No newline at end of file +