Document.ReferenceFileManager Class Reference
Detailed Description
This class is used to manage all files referenced by a document.
Referenced files are commonly stored in the working directory or in a document's associated companion folder, but may also exist anywhere on disk.
Currently this class only provides some utilities for copying and processing referenced files, but will be extended to include more file management.
#include
<class_document_1_1_reference_file_manager.h>
Public Member Functions |
|
| __init__ () | |
| addReference () | |
| Copies the file indicated by the given
filename to the working directory with a unique filename. |
|
Member Function Documentation
| Document.ReferenceFileManager.__init__ | ( | ) |
| Document.ReferenceFileManager.addReference | ( | ) |
Copies the file indicated by the given filename to the working directory with a unique filename.
The filename is expanded to contain both the working filename and the original parameter data.
If the file could not be found or copied, or the working directory could not be created, the filename is returned unchanged.
If 'forceCopy' is True the file will be copied to the working directory even if it is a supported file ( a supported file is a file that can be found in any of the supported directories )
