OdPdfPublish::Od2dGeometryLayer Class Reference

#include <PdfPublish2dGeometryLayer.h>

Inheritance diagram for OdPdfPublish::Od2dGeometryLayer:

Public Member Functions
	ODRX_DECLARE_MEMBERS (Od2dGeometryLayer)
	ODRX_HEAP_OPERATORS ()
virtual	~Od2dGeometryLayer ()
void	setName (const OdString &name)
void	setVisible (const bool state)
void	setLocked (const bool state)
void	getName (OdString &name) const
void	getVisible (bool &state) const
void	getLocked (bool &state) 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
	Od2dGeometryLayer ()
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 the layer object for the two-dimensional geometry in .pdf documents created with Publish SDK. PDF layers can be used when adding objects to an <link OdPdfPublish::Od2dGeometryBlock, Od2dGeometryBlock> object as well as to <link OdPdfPublish::Od2dGeometryReference, Od2dGeometryReference>, <link OdPdfPublish::OdImage, OdImage>, and <link OdPdfPublish::OdText, OdText> objects, which can be added to the document page.

Definition at line 49 of file PdfPublish2dGeometryLayer.h.

Constructor & Destructor Documentation

Od2dGeometryLayer()

OdPdfPublish::Od2dGeometryLayer::Od2dGeometryLayer ( )

protected

~Od2dGeometryLayer()

virtual OdPdfPublish::Od2dGeometryLayer::~Od2dGeometryLayer ( )

virtual

Destroys the layer object.

Member Function Documentation

getLocked()

void OdPdfPublish::Od2dGeometryLayer::getLocked

(

bool &

state

)

const

Returns the current value of the locked flag of the layer. The method fills a passed Boolean value and returns it to a calling subroutine.

Parameters

state

[out] A placeholder for the locked flag value.

Remarks

The method fills a passed boolean value and returns it to a calling subroutine.

getName()

void OdPdfPublish::Od2dGeometryLayer::getName

(

OdString &

name

)

const

Returns the layer name. The method fills a passed string object and returns it to a calling subroutine.

Parameters

name	[out] A placeholder for the layer name.

Remarks

The method fills a passed string object and returns it to a calling subroutine.

getVisible()

void OdPdfPublish::Od2dGeometryLayer::getVisible

(

bool &

state

)

const

Returns the current value of the visibility flag of the layer. The method fills a passed Boolean value and returns it to a calling subroutine.

Parameters

state

[out] A placeholder for the visibility flag value.

Remarks

The method fills a passed boolean value and returns it to a calling subroutine.

ODRX_DECLARE_MEMBERS()

OdPdfPublish::Od2dGeometryLayer::ODRX_DECLARE_MEMBERS

(

Od2dGeometryLayer

)

ODRX_HEAP_OPERATORS()

OdPdfPublish::Od2dGeometryLayer::ODRX_HEAP_OPERATORS

(

)

setLocked()

void OdPdfPublish::Od2dGeometryLayer::setLocked

(

const bool

state

)

Sets the locked flag value for the layer object. This flag determines whether visibility of the layer can be changed when the document is viewed. If the visibility can be changed, the flag equals true; otherwise, it equals false.

Parameters

state

[out] Locked flag value to be set.

setName()

void OdPdfPublish::Od2dGeometryLayer::setName

(

const OdString &

name

)

Sets the layer name.

Parameters

name	[in] A string that contains the name to be set.

Remarks

The name is mandatory and must be unique among the document object names.

setVisible()

void OdPdfPublish::Od2dGeometryLayer::setVisible

(

const bool

state

)

Sets the visibility flag value for the layer object. This flag determines whether objects that belong to the layer are visible (equals true) or invisible (equals false) when the document is opened.

Parameters

state

[in] Visibility flag value to be set.

---

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

• PdfPublish2dGeometryLayer.h