doc/tmpl/gnome-vfs-xfer.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 File Transfers
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Conveniently copy/move/delete files en masse
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### ENUM GnomeVFSXferOptions ##### -->
  18 <para>
  19
  20 </para>
  21
  22 @GNOME_VFS_XFER_DEFAULT:
  23 @GNOME_VFS_XFER_UNUSED_1:
  24 @GNOME_VFS_XFER_FOLLOW_LINKS:
  25 @GNOME_VFS_XFER_UNUSED_2:
  26 @GNOME_VFS_XFER_RECURSIVE:
  27 @GNOME_VFS_XFER_SAMEFS:
  28 @GNOME_VFS_XFER_DELETE_ITEMS:
  29 @GNOME_VFS_XFER_EMPTY_DIRECTORIES:
  30 @GNOME_VFS_XFER_NEW_UNIQUE_DIRECTORY:
  31 @GNOME_VFS_XFER_REMOVESOURCE:
  32 @GNOME_VFS_XFER_USE_UNIQUE_NAMES:
  33 @GNOME_VFS_XFER_LINK_ITEMS:
  34 @GNOME_VFS_XFER_FOLLOW_LINKS_RECURSIVE:
  35
  36 <!-- ##### ENUM GnomeVFSXferProgressStatus ##### -->
  37 <para>
  38
  39 </para>
  40
  41 @GNOME_VFS_XFER_PROGRESS_STATUS_OK:
  42 @GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR:
  43 @GNOME_VFS_XFER_PROGRESS_STATUS_OVERWRITE:
  44 @GNOME_VFS_XFER_PROGRESS_STATUS_DUPLICATE:
  45
  46 <!-- ##### ENUM GnomeVFSXferOverwriteMode ##### -->
  47 <para>
  48
  49 </para>
  50
  51 @GNOME_VFS_XFER_OVERWRITE_MODE_ABORT:
  52 @GNOME_VFS_XFER_OVERWRITE_MODE_QUERY:
  53 @GNOME_VFS_XFER_OVERWRITE_MODE_REPLACE:
  54 @GNOME_VFS_XFER_OVERWRITE_MODE_SKIP:
  55
  56 <!-- ##### ENUM GnomeVFSXferOverwriteAction ##### -->
  57 <para>
  58
  59 </para>
  60
  61 @GNOME_VFS_XFER_OVERWRITE_ACTION_ABORT:
  62 @GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE:
  63 @GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE_ALL:
  64 @GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP:
  65 @GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP_ALL:
  66
  67 <!-- ##### ENUM GnomeVFSXferErrorMode ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @GNOME_VFS_XFER_ERROR_MODE_ABORT:
  73 @GNOME_VFS_XFER_ERROR_MODE_QUERY:
  74
  75 <!-- ##### ENUM GnomeVFSXferErrorAction ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @GNOME_VFS_XFER_ERROR_ACTION_ABORT:
  81 @GNOME_VFS_XFER_ERROR_ACTION_RETRY:
  82 @GNOME_VFS_XFER_ERROR_ACTION_SKIP:
  83
  84 <!-- ##### ENUM GnomeVFSXferPhase ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @GNOME_VFS_XFER_PHASE_INITIAL:
  90 @GNOME_VFS_XFER_CHECKING_DESTINATION:
  91 @GNOME_VFS_XFER_PHASE_COLLECTING:
  92 @GNOME_VFS_XFER_PHASE_READYTOGO:
  93 @GNOME_VFS_XFER_PHASE_OPENSOURCE:
  94 @GNOME_VFS_XFER_PHASE_OPENTARGET:
  95 @GNOME_VFS_XFER_PHASE_COPYING:
  96 @GNOME_VFS_XFER_PHASE_MOVING:
  97 @GNOME_VFS_XFER_PHASE_READSOURCE:
  98 @GNOME_VFS_XFER_PHASE_WRITETARGET:
  99 @GNOME_VFS_XFER_PHASE_CLOSESOURCE:
 100 @GNOME_VFS_XFER_PHASE_CLOSETARGET:
 101 @GNOME_VFS_XFER_PHASE_DELETESOURCE:
 102 @GNOME_VFS_XFER_PHASE_SETATTRIBUTES:
 103 @GNOME_VFS_XFER_PHASE_FILECOMPLETED:
 104 @GNOME_VFS_XFER_PHASE_CLEANUP:
 105 @GNOME_VFS_XFER_PHASE_COMPLETED:
 106 @GNOME_VFS_XFER_NUM_PHASES:
 107
 108 <!-- ##### TYPEDEF GnomeVFSXferProgressInfo ##### -->
 109 <para>
 110
 111 </para>
 112
 113
 114 <!-- ##### USER_FUNCTION GnomeVFSXferProgressCallback ##### -->
 115 <para>
 116
 117 </para>
 118
 119 @info:
 120 @data:
 121 @Returns:
 122
 123
 124 <!-- ##### FUNCTION gnome_vfs_xfer_uri_list ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @source_uri_list:
 130 @target_uri_list:
 131 @xfer_options:
 132 @error_mode:
 133 @overwrite_mode:
 134 @progress_callback:
 135 @data:
 136 @Returns:
 137
 138
 139 <!-- ##### FUNCTION gnome_vfs_xfer_uri ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @source_uri:
 145 @target_uri:
 146 @xfer_options:
 147 @error_mode:
 148 @overwrite_mode:
 149 @progress_callback:
 150 @data:
 151 @Returns:
 152
 153
 154 <!-- ##### FUNCTION gnome_vfs_xfer_delete_list ##### -->
 155 <para>
 156
 157 </para>
 158
 159 @source_uri_list:
 160 @error_mode:
 161 @xfer_options:
 162 @progress_callback:
 163 @data:
 164 @Returns:
 165
 166