#include <PdfPublishCollectionFolder.h>

Inheritance diagram for OdPdfPublish::OdAttachedFolder:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdAttachedFolder)

	ODRX_HEAP_OPERATORS ()

virtual	~OdAttachedFolder ()

void	setName (const OdString &name)

void	setDescription (const OdString &description)

void	setCreationDate (const OdTimeStamp &creation_date)

void	setModDate (const OdTimeStamp &mod_date)

void	setThumb (const OdImagePtr &pImage)

void	addTextCollectionItem (const OdString &name, const OdString &item)

void	addDateCollectionItem (const OdString &name, const OdTimeStamp &date)

void	addNumberCollectionItem (const OdString &name, const double &number)

void	addChildFolder (const OdAttachedFolderPtr &folder)

void	addFile (const OdAttachedFilePtr &file)

void	getName (OdString &name) const

void	getDescription (OdString &description) const

void	getCreationDate (OdTimeStamp &creation_date) const

void	getModDate (OdTimeStamp &mod_date) const

void	getThumb (OdImagePtr &pOutImage) const

void	getTextCollectionItems (OdStringArray &names, OdStringArray &items) const

void	getDateCollectionItems (OdStringArray &names, OdArray< OdTimeStamp > &dates) const

void	getNumberCollectionItems (OdStringArray &names, OdDoubleArray &numbers) const

void	getChildFolders (OdAttachedFolderPtrArray &folders) const

void	getFiles (OdAttachedFilePtrArray &files) const

Public Member Functions inherited from OdPdfPublish::OdObject
	ODRX_DECLARE_MEMBERS (OdObject)

	ODRX_HEAP_OPERATORS ()

virtual	~OdObject ()

virtual bool	isEmpty () const

virtual bool	isValid () const

virtual void	clear ()

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Member Functions
	OdAttachedFolder ()

Protected Member Functions inherited from OdPdfPublish::OdObject
	OdObject (OdPublishObjectImpl *pImpl)

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

static void	rxInit ()

static void	rxUninit ()

Detailed Description

This class implements an attached folder entity in .pdf documents created with Publish SDK.

Definition at line 54 of file PdfPublishCollectionFolder.h.

Constructor & Destructor Documentation

◆ OdAttachedFolder()

OdPdfPublish::OdAttachedFolder::OdAttachedFolder ( )

protected

◆ ~OdAttachedFolder()

virtual OdPdfPublish::OdAttachedFolder::~OdAttachedFolder ( )

virtual

Destroys an attached folder object.

Member Function Documentation

◆ addChildFolder()

void OdPdfPublish::OdAttachedFolder::addChildFolder ( const OdAttachedFolderPtr & folder )

Adds the child attached folder object for the attached folder.

Parameters

folder [in] A smart pointer to a attached folder object.

◆ addDateCollectionItem()

void OdPdfPublish::OdAttachedFolder::addDateCollectionItem	(	const OdString &	name,
		const OdTimeStamp &	date )

Adds the date collection item for the attached folder.

Parameters

name	[in] A new name of collection item value.
date	[in] A new collection item value.

Remarks: The name shouldn't contain any special characters or spaces. To display this item, the collection should contain a column with the same name.

◆ addFile()

void OdPdfPublish::OdAttachedFolder::addFile ( const OdAttachedFilePtr & file )

Adds the attached folder object for the attached folder.

Parameters

file	[in] A smart pointer to a attached file object.

◆ addNumberCollectionItem()

void OdPdfPublish::OdAttachedFolder::addNumberCollectionItem	(	const OdString &	name,
		const double &	number )

Adds the number collection item for the attached folder.

Parameters

name	[in] A new name of collection item value.
number	[in] A new collection item value.

Remarks: The name shouldn't contain any special characters or spaces. To display this item, the collection should contain a column with the same name.

◆ addTextCollectionItem()

void OdPdfPublish::OdAttachedFolder::addTextCollectionItem	(	const OdString &	name,
		const OdString &	item )

Adds the text collection item for the attached folder.

Parameters

name	[in] A new name of collection item value.
item	[in] A new collection item value.

Remarks: The name shouldn't contain any special characters or spaces. To display this item, the collection should contain a column with the same name.

◆ getChildFolders()

void OdPdfPublish::OdAttachedFolder::getChildFolders ( OdAttachedFolderPtrArray & folders ) const

Returns a collection of child attached folder of the attached folder. This method fills the passed array of smart pointer to OdAttachedFolder, then returns them to a calling subroutine.

Parameters

folders [out] A placeholder for collection of attached folder.

◆ getCreationDate()

void OdPdfPublish::OdAttachedFolder::getCreationDate ( OdTimeStamp & creation_date ) const

Returns the current creation date of the attached folder. The method fills a passed TimeStamp and returns it to the calling subroutine.

Parameters

creation_date [out] A placeholder for creation date value.

◆ getDateCollectionItems()

void OdPdfPublish::OdAttachedFolder::getDateCollectionItems	(	OdStringArray &	names,
		OdArray< OdTimeStamp > &	dates ) const

Returns a collection of date collection item of the attached folder. This method fills the passed string array and array of TimeStamp objects, then returns them to a calling subroutine.

Parameters

names	[out] A placeholder for collection item names.
images	[out] A placeholder for date collection item values.

◆ getDescription()

void OdPdfPublish::OdAttachedFolder::getDescription ( OdString & description ) const

Returns the current description of the attached folder. The method fills a passed string object and returns it to the calling subroutine.

Parameters

description [out] A placeholder for description value.

◆ getFiles()

void OdPdfPublish::OdAttachedFolder::getFiles ( OdAttachedFilePtrArray & files ) const

Returns a collection of attached file of the attached folder. This method fills the passed array of smart pointer to OdAttachedFile, then returns them to a calling subroutine.

Parameters

folders [out] A placeholder for collection of attached file.

◆ getModDate()

void OdPdfPublish::OdAttachedFolder::getModDate ( OdTimeStamp & mod_date ) const

Returns the current modification date of the attached folder. The method fills a passed TimeStamp and returns it to the calling subroutine.

Parameters

mod_date [out] A placeholder for modification date value.

◆ getName()

void OdPdfPublish::OdAttachedFolder::getName ( OdString & name ) const

Returns the current displayed name of the attached folder. The method fills a passed string object and returns it to the calling subroutine.

Parameters

name	[out] A placeholder for displayed name value.

◆ getNumberCollectionItems()

void OdPdfPublish::OdAttachedFolder::getNumberCollectionItems	(	OdStringArray &	names,
		OdDoubleArray &	numbers ) const

Returns a collection of number collection item of the attached folder. This method fills the passed string array and array of double, then returns them to a calling subroutine.

Parameters

names	[out] A placeholder for collection item names.
images	[out] A placeholder for number collection item values.

◆ getTextCollectionItems()

void OdPdfPublish::OdAttachedFolder::getTextCollectionItems	(	OdStringArray &	names,
		OdStringArray &	items ) const

Returns a collection of text collection item of the attached folder. This method fills the passed string array and string array, then returns them to a calling subroutine.

Parameters

names	[out] A placeholder for collection item names.
images	[out] A placeholder for collection item values.

◆ getThumb()

void OdPdfPublish::OdAttachedFolder::getThumb ( OdImagePtr & pOutImage ) const

Returns the current thumbnail raster image object of the attached folder. The method fills a passed raster image object and returns it to the calling subroutine.

Parameters

pOutImage [out] A placeholder for raster image object.

◆ ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdAttachedFolder::ODRX_DECLARE_MEMBERS ( OdAttachedFolder )

◆ ODRX_HEAP_OPERATORS()

OdPdfPublish::OdAttachedFolder::ODRX_HEAP_OPERATORS ( )

◆ setCreationDate()

void OdPdfPublish::OdAttachedFolder::setCreationDate ( const OdTimeStamp & creation_date )

Sets the creation date of the attached folder.

Parameters

creation_date [in] A new creation date value.

◆ setDescription()

void OdPdfPublish::OdAttachedFolder::setDescription ( const OdString & description )

Sets the description of the attached folder.

Parameters

description [in] A new description value.

◆ setModDate()

void OdPdfPublish::OdAttachedFolder::setModDate ( const OdTimeStamp & mod_date )

Sets the modification date of the attached folder.

Parameters

mod_date [in] A new modification date value.

◆ setName()

void OdPdfPublish::OdAttachedFolder::setName ( const OdString & name )

Sets the displayed name of the attached folder. Use IsValid() to check the status of the operation.

Parameters

name	[in] A new displayed name value.

◆ setThumb()

void OdPdfPublish::OdAttachedFolder::setThumb ( const OdImagePtr & pImage )

Sets the thumbnail image of the attached folder.

Parameters

pImage [in] A smart pointer to a thumbnail raster image object.

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

PdfPublishCollectionFolder.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdAttachedFolder()

◆ ~OdAttachedFolder()

Member Function Documentation

◆ addChildFolder()

◆ addDateCollectionItem()

◆ addFile()

◆ addNumberCollectionItem()

◆ addTextCollectionItem()

◆ getChildFolders()

◆ getCreationDate()

◆ getDateCollectionItems()

◆ getDescription()

◆ getFiles()

◆ getModDate()

◆ getName()

◆ getNumberCollectionItems()

◆ getTextCollectionItems()

◆ getThumb()

◆ ODRX_DECLARE_MEMBERS()

◆ ODRX_HEAP_OPERATORS()

◆ setCreationDate()

◆ setDescription()

◆ setModDate()

◆ setName()

◆ setThumb()