FileSpecification Class Documentation

classFileSpecification

Namespace:datalogics_interface

Detailed Description

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

LaunchActionRemoteGoToAction

Uses types

PDFObject

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()

Member Function Documentation

get_path

std::stringget_path()

Returns:

The 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:

The underlying PDFObject for this FileSpecification.

Retrieve the PDFObject representation of this object.

to_string

std::stringto_string()

Returns:

The path to the file referenced by this FileSpecification.

The returned value is the file path referenced by this specification.