FileSpecification Class Documentation
class FileSpecificationNamespace:datalogics_interface
Detailed Description
Refers to the location of a PDF file within a file system.
The PDF file system is known more commonly as the file path name.
The reference can be either absolute, as in a complete path name, or relative to the current place in a directory structure.
Referenced by
Uses types
Constructor & Destructor Documentation
FileSpecification
FileSpecification(Document & doc, const std::string & path)Parameters
doc: Document &The document in which the file specification is created.
path: const std::string &The string corresponding to the path of the file to reference. It may be relative or absolute.
Creates a new file specification object.
FileSpecification
FileSpecification(FileSpecification && )Parameters
~FileSpecification
~FileSpecification()Member Function Documentation
get_path
std::string get_path()Returns:
std::stringThe file path as a string, which may be relative or absolute.
Gets the path to the file referenced.
get_pdf_object
std::unique_ptr< PDFObject > get_pdf_object()Returns:
std::unique_ptr< PDFObject >The underlying PDFObject for this FileSpecification.
Retrieve the PDFObject representation of this object.
operator=
FileSpecification & operator=(FileSpecification && )Parameters
Returns:
FileSpecification &to_string
std::string to_string()Returns:
std::stringThe path to the file referenced by this FileSpecification.
Returns a string representation of this FileSpecification.
The returned value is the file path referenced by this specification.