Wrap gio.File.copy, add tests and documentation. Rename

2008-07-24  Johan Dahlin  <johan@gnome.org>

    * gio/gfile.override:
    * gio/gfileenumerator.override:
    * gio/ginputstream.override:
    * gio/gio.defs:
    * gio/gio.override:
    * gio/goutputstream.override:
    * tests/test_gio.py:
    Wrap gio.File.copy, add tests and documentation.
    Rename PyGAsyncRequestNotify to PyGIONotify and reuse it.


svn path=/trunk/; revision=850

1 files changed, 38 insertions, 0 deletions

diff --git a/gio/gio.defs b/gio/gio.defs
index 7a225d0..2ce5726 100644
--- a/gio/gio.defs
+++ b/gio/gio.defs
@@ -1645,6 +1645,44 @@
 )
 
 (define-method copy
+  (docstring
+"Copies the file source to the location specified by destination.\n"
+"Can not handle recursive copies of directories.\n"
+"\n"
+"If the flag gio.FILE_COPY_OVERWRITE is specified an already existing\n"
+"destination file is overwritten.\n"
+"\n"
+"If the flag gio.FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlink\n"
+"will be copied as symlinks, otherwise the target of the source symlink\n"
+"will be copied.\n"
+"\n"
+"If cancellable is not None, then the operation can be cancelled b\n"
+"triggering the cancellable object from another thread.\n"
+"If the operation was cancelled, the error gio.ERROR_CANCELLED\n"
+"will be returned.\n"
+"\n"
+"If progress_callback is not None, then the operation can be monitored\n"
+"by setting this to a callable. if specified progress_callback_data will\n"
+"be passed to this function. It is guaranteed that this callback\n"
+"will be called after all data has been transferred with the total number\n"
+"of bytes copied during the operation.\n"
+"\n"
+"If the source file does not exist then the gio.ERROR_NOT_FOUND\n"
+"error is returned, independent on the status of the destination.\n"
+"\n"
+"If gio.FILE_COPY_OVERWRITE is not specified and the target exists\n"
+"then the error gio.ERROR_EXISTS is returned.\n"
+"\n"
+"If trying to overwrite a file over a directory the gio.ERROR_IS_DIRECTORY\n"
+"error is returned. If trying to overwrite a directory with a directory\n"
+"the gio.ERROR_WOULD_MERGE error is returned.\n"
+"\n"
+"If the source is a directory and the target does not exist\n"
+"or gio.FILE_COPY_OVERWRITE is specified and the target is a file\n"
+"then the gio.ERROR_WOULD_RECURSE error is returned.\n"
+"\n"
+"If you are interested in copying the GFile object itself\n"
+"(not the on-disk file), see gio.File.dup().")
   (of-object "GFile")
   (c-name "g_file_copy")
   (return-type "gboolean")