PDF::FileSpec Class Reference

Represents a file specification in a PDF document. More...

#include <pdfsdk/cxx/filespec.h>

Inheritance diagram for PDF::FileSpec:

Public Member Functions
Object	GetPdfObject () const
void	SetFileSystem (PDAtom fileSys)
PDAtom	GetFileSystem ()
void	SetPath (const std::wstring &path)
std::wstring	GetPath ()
void	SetDesc (const std::wstring &desc)
std::wstring	GetDesc ()
PDDateTime	GetCreateDate ()
PDDateTime	GetModDate ()
int64_t	GetFileSize ()
XObject	GetThumbnail (const Document &doc)
void	SetThumbnail (const XObject &thumb)
void	SaveToFile (const std::filesystem::path &path)
	FileSpec (PDFileSpec handle, bool adopt=false) noexcept
	FileSpec (const FileSpec &rhs) noexcept
FileSpec &	operator= (const FileSpec &rhs) noexcept
	FileSpec (FileSpec &&rhs) noexcept
FileSpec &	operator= (FileSpec &&rhs) noexcept

Static Public Member Functions
static FileSpec	CreateFromPdfObject (const Object &object)

Detailed Description

Represents a file specification in a PDF document.

ISO-32000-2:2020 - 7.11 File specifications

Member Function Documentation

CreateFromPdfObject()

static FileSpec PDF::FileSpec::CreateFromPdfObject ( const Object & object )

static

Creates a file specification from the specified PDF object.

Parameters

object

The PDF object.

Returns

The file specification.

GetCreateDate()

PDDateTime PDF::FileSpec::GetCreateDate

(

)

Gets the creation date of the file.

Returns

The creation date.

GetDesc()

std::wstring PDF::FileSpec::GetDesc

(

)

Gets the description of the file.

Returns

The file description.

GetFileSize()

int64_t PDF::FileSpec::GetFileSize

(

)

Gets the size of the file.

Returns

The file size in bytes.

GetFileSystem()

PDAtom PDF::FileSpec::GetFileSystem

(

)

Gets the file system associated with the file specification.

Returns

The file system.

GetModDate()

PDDateTime PDF::FileSpec::GetModDate

(

)

Gets the modification date of the file.

Returns

The modification date.

GetPath()

std::wstring PDF::FileSpec::GetPath

(

)

Gets the path of the file.

Returns

The file path.

GetPdfObject()

Object PDF::FileSpec::GetPdfObject

(

)

const

Gets the file specification PDF object.

Returns

The file specification PDF object.

GetThumbnail()

XObject PDF::FileSpec::GetThumbnail

(

const Document &

doc

)

Gets the thumbnail associated with the file.

Parameters

doc	The document to retrieve the thumbnail from.

Returns

The thumbnail XObject.

SaveToFile()

void PDF::FileSpec::SaveToFile

(

const std::filesystem::path &

path

)

Saves the file to the specified path.

Parameters

path	The path to save the file to.

SetDesc()

void PDF::FileSpec::SetDesc

(

const std::wstring &

desc

)

Sets the description of the file.

Parameters

desc	The description to set.

SetFileSystem()

void PDF::FileSpec::SetFileSystem

(

PDAtom

fileSys

)

Sets the file system associated with the file specification.

Parameters

fileSys

The file system to set.

SetPath()

void PDF::FileSpec::SetPath

(

const std::wstring &

path

)

Sets the path of the file.

Parameters

path	The path to set.

SetThumbnail()

void PDF::FileSpec::SetThumbnail

(

const XObject &

thumb

)

Sets the thumbnail for the file.

Parameters

thumb

The thumbnail XObject to set.

---

The documentation for this class was generated from the following file:

• include/pdfsdk/cxx/filespec.h