OdPdfPublish::OdCollection Class Reference

#include <PdfPublishCollection.h>

Inheritance diagram for OdPdfPublish::OdCollection:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdCollection)
	ODRX_HEAP_OPERATORS ()
virtual	~OdCollection ()
void	addColumn (const OdCollectionColumnPtr &column)
void	setColumns (const OdCollectionColumnPtrArray &columns)
void	setInitialFile (const OdAttachedFilePtr &file)
void	setInitalViewType (const CollectionSchema::InitialView view_type)
void	setBackgroundColor (const ODCOLORREF color)
void	setCardBackgroundColor (const ODCOLORREF color)
void	setCardBorderColor (const ODCOLORREF color)
void	setPrimaryTextColor (const ODCOLORREF color)
void	setSecondaryTextColor (const ODCOLORREF color)
void	setRootFolder (const OdAttachedFolderPtr &folder)
void	getColumns (OdCollectionColumnPtrArray &columns) const
void	getInitialFile (OdAttachedFilePtr &file) const
void	getInitalViewType (CollectionSchema::InitialView view_type) const
void	getBackgroundColor (ODCOLORREF &color) const
void	getCardBackgroundColor (ODCOLORREF &color) const
void	getCardBorderColor (ODCOLORREF &color) const
void	getPrimaryTextColor (ODCOLORREF &color) const
void	getSecondaryTextColor (ODCOLORREF &color) const
void	getRootFolder (OdAttachedFolderPtr &folder) 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
	OdCollection ()
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 collection entity in .pdf documents created with Publish SDK.

Definition at line 48 of file PdfPublishCollection.h.

Constructor & Destructor Documentation

OdCollection()

OdPdfPublish::OdCollection::OdCollection ( )

protected

~OdCollection()

virtual OdPdfPublish::OdCollection::~OdCollection ( )

virtual

Destroys an collection object.

Member Function Documentation

addColumn()

void OdPdfPublish::OdCollection::addColumn

(

const OdCollectionColumnPtr &

column

)

Adds the column object for the collection.

Parameters

column

[in] A smart pointer to a column object.

getBackgroundColor()

void OdPdfPublish::OdCollection::getBackgroundColor

(

ODCOLORREF &

color

)

const

Returns the background color for the collection object. The method fills a passed ODCOLORREF value and returns it to a calling subroutine.

Parameters

color

[out] A placeholder for the color value.

getCardBackgroundColor()

void OdPdfPublish::OdCollection::getCardBackgroundColor

(

ODCOLORREF &

color

)

const

Returns the card background color for the collection object. The method fills a passed ODCOLORREF value and returns it to a calling subroutine.

Parameters

color

[out] A placeholder for the color value.

getCardBorderColor()

void OdPdfPublish::OdCollection::getCardBorderColor

(

ODCOLORREF &

color

)

const

Returns the card border color for the collection object. The method fills a passed ODCOLORREF value and returns it to a calling subroutine.

Parameters

color

[out] A placeholder for the color value.

getColumns()

void OdPdfPublish::OdCollection::getColumns

(

OdCollectionColumnPtrArray &

columns

)

const

Returns a collection of column of the collection object. This method fills the passed array of smart pointer to OdCollectionColumn, then returns them to a calling subroutine.

Parameters

columns

[out] A placeholder for collection of column object.

getInitalViewType()

void OdPdfPublish::OdCollection::getInitalViewType

(

CollectionSchema::InitialView

view_type

)

const

Returns the collection view type. The method fills a passed collection view type value and returns it to a calling subroutine.

Parameters

view_type

[out] A placeholder for the collection view type value.

See also

<link OdPdfPublish::CollectionSchema::InitialView, CollectionSchema::InitialView enumeration>.

getInitialFile()

void OdPdfPublish::OdCollection::getInitialFile

(

OdAttachedFilePtr &

file

)

const

Returns a attached file that is displayed when the collection is opened. This method fills the passed smart pointer to OdAttachedFile, then returns them to a calling subroutine.

Parameters

file	[out] A placeholder for smart pointer to a attached file object.

getPrimaryTextColor()

void OdPdfPublish::OdCollection::getPrimaryTextColor

(

ODCOLORREF &

color

)

const

Returns the primary text color for the collection object. The method fills a passed ODCOLORREF value and returns it to a calling subroutine.

Parameters

color

[out] A placeholder for the color value.

getRootFolder()

void OdPdfPublish::OdCollection::getRootFolder

(

OdAttachedFolderPtr &

folder

)

const

Returns a root folder object for the collection object. This method fills the passed smart pointer to OdAttachedFolder, then returns them to a calling subroutine.

Parameters

folder

[out] A placeholder for smart pointer to attached folder.

getSecondaryTextColor()

void OdPdfPublish::OdCollection::getSecondaryTextColor

(

ODCOLORREF &

color

)

const

Returns the secondary text color for the collection object. The method fills a passed ODCOLORREF value and returns it to a calling subroutine.

Parameters

color

[out] A placeholder for the color value.

ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdCollection::ODRX_DECLARE_MEMBERS

(

OdCollection

)

ODRX_HEAP_OPERATORS()

OdPdfPublish::OdCollection::ODRX_HEAP_OPERATORS

(

)

setBackgroundColor()

void OdPdfPublish::OdCollection::setBackgroundColor

(

const ODCOLORREF

color

)

Sets a new background color for the collection object.

Parameters

color

[in] A new color value to be set.

setCardBackgroundColor()

void OdPdfPublish::OdCollection::setCardBackgroundColor

(

const ODCOLORREF

color

)

Sets a new card background color for the collection object.

Parameters

color

[in] A new color value to be set.

setCardBorderColor()

void OdPdfPublish::OdCollection::setCardBorderColor

(

const ODCOLORREF

color

)

Sets a new card border color for the collection object.

Parameters

color

[in] A new color value to be set.

setColumns()

void OdPdfPublish::OdCollection::setColumns

(

const OdCollectionColumnPtrArray &

columns

)

Sets the collection of column object for the collection.

Parameters

columns

[in] A array of smart pointers to a column object.

setInitalViewType()

void OdPdfPublish::OdCollection::setInitalViewType

(

const CollectionSchema::InitialView

view_type

)

Returns the collection view type. The method fills a passed collection view type value and returns it to a calling subroutine.

Parameters

view_type

[out] A placeholder for the collection view type value.

See also

<link OdPdfPublish::CollectionSchema::InitialView, CollectionSchema::InitialView enumeration>.

setInitialFile()

void OdPdfPublish::OdCollection::setInitialFile

(

const OdAttachedFilePtr &

file

)

Sets the attached file that is displayed when the collection is opened.

Parameters

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

Remarks

The file should also be added to the root directory of the Collection.

setPrimaryTextColor()

void OdPdfPublish::OdCollection::setPrimaryTextColor

(

const ODCOLORREF

color

)

Sets a new primary text color for the collection object.

Parameters

color

[in] A new color value to be set.

setRootFolder()

void OdPdfPublish::OdCollection::setRootFolder

(

const OdAttachedFolderPtr &

folder

)

Sets the root folder object for the collection object.

Parameters

folder

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

setSecondaryTextColor()

void OdPdfPublish::OdCollection::setSecondaryTextColor

(

const ODCOLORREF

color

)

Sets a new secondary text color for the collection object.

Parameters

color

[in] A new color value to be set.

---

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

• PdfPublishCollection.h