IDocumentLayer Class Reference

#include <IDocumentLayer.h>

Inheritance diagram for IDocumentLayer:

Public Types
enum	{ kDefaultIID = IID_IDOCUMENTLAYER }
enum	IgnoreEnum { kDoNotIgnore = 0, kIgnore = 1, kLeaveUnchanged = 2 }

Public Member Functions
virtual void	GetName (PMString *pName) const =0
virtual const PMString &	GetName () const =0
virtual void	SetName (const PMString &newName)=0
virtual const UID &	GetColorUID () const =0
virtual void	SetColorUID (const UID &newColor)=0
virtual bool16	IsLocked () const =0
virtual void	SetLocked (bool16 active)=0
virtual bool16	IsVisible () const =0
virtual void	SetVisible (bool16 visible)=0
virtual bool16	IsPrintable () const =0
virtual void	SetPrintable (bool16 print)=0
virtual bool16	IsGuideLocked () const =0
virtual void	SetGuideLocked (bool16 active)=0
virtual bool16	IsGuideVisible () const =0
virtual void	SetGuideVisible (bool16 visible)=0
virtual bool16	IsUILayer () const =0
virtual void	SetUILayer (bool16 uiLayer)=0
virtual bool16	IsExpendableLayer () const =0
virtual void	SetExpendableLayer (bool16 expendableLayer)=0
virtual void	SetIgnoreTextWrapWhenNotVisible (bool16 bIgnoreWhenNotVisible)=0
virtual bool16	GetIgnoreTextWrapWhenNotVisible (void) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Interface to get and set document layer options.

Author

Zak Williamson

Member Function Documentation

virtual const UID& IDocumentLayer::GetColorUID ( ) const

pure virtual

Description: Get the color of the layer

Parameters

none

Returns

const

virtual bool16 IDocumentLayer::GetIgnoreTextWrapWhenNotVisible ( void  ) const

pure virtual

Description: Get whether or not text wrap items on this layer will be ignored when the layer is invisible.

Parameters

void

Returns

bool16

virtual void IDocumentLayer::GetName ( PMString *  pName ) const

pure virtual

Description: Get the name of the layer.

Parameters

pName

virtual const PMString& IDocumentLayer::GetName ( ) const

pure virtual

Description: Get the name of the layer.

Parameters

none

virtual bool16 IDocumentLayer::IsExpendableLayer ( ) const

pure virtual

Description: return TRUE if the layer can be deleted from the UI (Layers Panel), FALSE otherwise

Parameters

none

Returns

bool16

virtual bool16 IDocumentLayer::IsGuideLocked ( ) const

pure virtual

Description: return TRUE if the layer is write locked, FALSE otherwise

Parameters

none

Returns

bool16

virtual bool16 IDocumentLayer::IsGuideVisible ( ) const

pure virtual

Description: return TRUE if the guides on this layer are visible, FALSE otherwise

Parameters

none

Returns

bool16

virtual bool16 IDocumentLayer::IsLocked ( ) const

pure virtual

Description: return TRUE if the layer is write locked, FALSE otherwise

Parameters

none

Returns

bool16

virtual bool16 IDocumentLayer::IsPrintable ( ) const

pure virtual

Description: return TRUE if the layer is printable, FALSE otherwise

Parameters

none

Returns

bool16

virtual bool16 IDocumentLayer::IsUILayer ( ) const

pure virtual

Description: return TRUE if the layer appears in the UI (Layers Panel), FALSE otherwise

Parameters

none

Returns

bool16

virtual bool16 IDocumentLayer::IsVisible ( ) const

pure virtual

Description: return TRUE if the layer is visible, FALSE otherwise

Parameters

none

Returns

bool16

virtual void IDocumentLayer::SetColorUID ( const UID &  newColor )

pure virtual

Description: Set the color of the layer.

Parameters

&newColor

virtual void IDocumentLayer::SetExpendableLayer ( bool16  expendableLayer )

pure virtual

Description: set whether the layer layer can be deleted from the UI or not.

Parameters

expendableLayer

virtual void IDocumentLayer::SetGuideLocked ( bool16  active )

pure virtual

Description: set the lock attribute for guides on this layer

Parameters

active

virtual void IDocumentLayer::SetGuideVisible ( bool16  visible )

pure virtual

Description: set the visible attribute for guides of this layer

Parameters

visible

virtual void IDocumentLayer::SetIgnoreTextWrapWhenNotVisible ( bool16  bIgnoreWhenNotVisible )

pure virtual

Description: If kTrue, then ignore all text wrap items on this layer when the layer is invisible.

Parameters

bIgnoreWhenNotVisible

virtual void IDocumentLayer::SetLocked ( bool16  active )

pure virtual

Description: set the lock attribute this layer

Parameters

active

virtual void IDocumentLayer::SetName ( const PMString &  newName )

pure virtual

Description: Set the name of the layer

Parameters

newName

virtual void IDocumentLayer::SetPrintable ( bool16  print )

pure virtual

Description: set the printable attribute of this layer

Parameters

print

- TRUE if layer is printable, FALSE otherwise

virtual void IDocumentLayer::SetUILayer ( bool16  uiLayer )

pure virtual

Description: set whether the layer appears in the UI or not.

Parameters

uiLayer

virtual void IDocumentLayer::SetVisible ( bool16  visible )

pure virtual

Description: set the visible attribute of this layer

Parameters

none

Returns

bool16