PoDoFo  0.9.4
Public Member Functions | List of all members
PoDoFo::PdfFileSpec Class Reference

#include <PdfFileSpec.h>

Inheritance diagram for PoDoFo::PdfFileSpec:
PoDoFo::PdfElement

Public Member Functions

 PdfFileSpec (const char *pszFilename, const unsigned char *data, ptrdiff_t size, PdfVecObjects *pParent, bool bStripPath=false)
 
const PdfStringGetFilename (bool canUnicode) const
 
- Public Member Functions inherited from PoDoFo::PdfElement
PdfObjectGetObject ()
 
const PdfObjectGetObject () const
 

Additional Inherited Members

- Protected Member Functions inherited from PoDoFo::PdfElement
 PdfElement (const char *pszType, PdfVecObjects *pParent)
 
 PdfElement (const char *pszType, PdfDocument *pParent)
 
 PdfElement (const char *pszType, PdfObject *pObject)
 
 PdfElement (EPdfDataType eExpectedDataType, PdfObject *pObject)
 
const char * TypeNameForIndex (int i, const char **ppTypes, long lLen) const
 
int TypeNameToIndex (const char *pszType, const char **ppTypes, long lLen, int nUnknownValue) const
 
PdfObjectCreateObject (const char *pszType=NULL)
 
PdfObjectGetNonConstObject () const
 

Detailed Description

A file specification is used in the PDF file to referr to another file. The other file can be a file outside of the PDF or can be embedded into the PDF file itself.

Constructor & Destructor Documentation

PoDoFo::PdfFileSpec::PdfFileSpec ( const char *  pszFilename,
const unsigned char *  data,
ptrdiff_t  size,
PdfVecObjects pParent,
bool  bStripPath = false 
)

Embeds the file in memory from "data" buffer under "pszFileName" fie name.

Member Function Documentation

const PdfString & PoDoFo::PdfFileSpec::GetFilename ( bool  canUnicode) const

Gets file name for the FileSpec

Parameters
canUnicodeWhether can return file name in unicode (/UF)
Returns
the filename of this file specification. if no general name is available it will try the Unix, Mac and DOS keys too.