Changeset 84983 in vbox for trunk/src/VBox/GuestHost/DragAndDrop/DnDDroppedFiles.cpp
- Timestamp:
- Jun 29, 2020 9:09:03 AM (4 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/VBox/GuestHost/DragAndDrop/DnDDroppedFiles.cpp
r82968 r84983 51 51 } 52 52 53 /** 54 * Adds a file reference to a dropped files directory. 55 * 56 * @returns VBox status code. 57 * @param pszFile Path of file entry to add. 58 */ 53 59 int DnDDroppedFiles::AddFile(const char *pszFile) 54 60 { … … 60 66 } 61 67 68 /** 69 * Adds a directory reference to a dropped files directory. 70 * Note: This does *not* (recursively) add sub entries. 71 * 72 * @returns VBox status code. 73 * @param pszDir Path of directory entry to add. 74 */ 62 75 int DnDDroppedFiles::AddDir(const char *pszDir) 63 76 { … … 69 82 } 70 83 84 /** 85 * Closes the dropped files directory handle, internal version. 86 * 87 * @returns VBox status code. 88 */ 71 89 int DnDDroppedFiles::closeInternal(void) 72 90 { … … 85 103 } 86 104 105 /** 106 * Closes the dropped files directory handle. 107 * 108 * @returns VBox status code. 109 */ 87 110 int DnDDroppedFiles::Close(void) 88 111 { … … 90 113 } 91 114 115 /** 116 * Returns the absolute path of the dropped files directory. 117 * 118 * @returns Pointer to absolute path of the dropped files directory. 119 */ 92 120 const char *DnDDroppedFiles::GetDirAbs(void) const 93 121 { … … 95 123 } 96 124 125 /** 126 * Returns whether the dropped files directory has been opened or not. 127 * 128 * @returns \c true if open, \c false if not. 129 */ 97 130 bool DnDDroppedFiles::IsOpen(void) const 98 131 { … … 100 133 } 101 134 135 /** 136 * Opens (creates) the dropped files directory. 137 * 138 * @returns VBox status code. 139 * @param pszPath Absolute path where to create the dropped files directory. 140 * @param fFlags Dropped files flags to use for this directory. 141 */ 102 142 int DnDDroppedFiles::OpenEx(const char *pszPath, DNDURIDROPPEDFILEFLAGS fFlags /* = DNDURIDROPPEDFILE_FLAGS_NONE */) 103 143 { … … 167 207 } 168 208 209 /** 210 * Opens (creates) the dropped files directory in the system's temp directory. 211 * 212 * @returns VBox status code. 213 * @param fFlags Dropped files flags to use for this directory. 214 */ 169 215 int DnDDroppedFiles::OpenTemp(DNDURIDROPPEDFILEFLAGS fFlags /* = DNDURIDROPPEDFILE_FLAGS_NONE */) 170 216 { … … 184 230 } 185 231 186 int DnDDroppedFiles::Reset(bool fRemoveDropDir) 232 /** 233 * Resets a droppped files directory. 234 * 235 * @returns VBox status code. 236 * @param fDelete Whether to physically delete the directory and its content 237 * or just clear the internal references. 238 */ 239 int DnDDroppedFiles::Reset(bool fDelete) 187 240 { 188 241 int rc = closeInternal(); 189 242 if (RT_SUCCESS(rc)) 190 243 { 191 if (f RemoveDropDir)244 if (fDelete) 192 245 { 193 246 rc = Rollback(); … … 204 257 } 205 258 259 /** 260 * Re-opens a droppes files directory. 261 * 262 * @returns VBox status code, or VERR_NOT_FOUND if the dropped files directory has not been opened before. 263 */ 206 264 int DnDDroppedFiles::Reopen(void) 207 265 { … … 212 270 } 213 271 272 /** 273 * Performs a rollback of a dropped files directory. 274 * This cleans the directory by physically deleting all files / directories which have been added before. 275 * 276 * @returns VBox status code. 277 */ 214 278 int DnDDroppedFiles::Rollback(void) 215 279 {
Note:
See TracChangeset
for help on using the changeset viewer.
