SnpProcessDocumentLayerCmds Class Reference

Public Member Functions
	SnpProcessDocumentLayerCmds ()
virtual	~SnpProcessDocumentLayerCmds ()
ErrorCode	CreateNewLayer (IDocument *doc)
ErrorCode	CopyToNewLayer (IDocument *doc, IControlView *view)
ErrorCode	CreateActiveLayer (IDocument *doc, IControlView *view)
ErrorCode	CopySelectedItems (IControlView *view)
ErrorCode	SetLayerPrefs (bool16 pasteRemembersLayers)
bool16	GetPasteRemembersLayers ()
ErrorCode	SelectAllItemsOnActiveLayer (IDocument *doc, IControlView *view)
ErrorCode	ChangeItemName (UIDRef selectedItemRef, PMString itemName)
ErrorCode	ShowHidePageItem (UIDRef selectedItemRef)

Detailed Description

• how to write code that processes document layer commands and sequence of commands.

Constructor & Destructor Documentation

SnpProcessDocumentLayerCmds::SnpProcessDocumentLayerCmds ( )

inline

Constructor.

virtual SnpProcessDocumentLayerCmds::~SnpProcessDocumentLayerCmds ( )

inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpProcessDocumentLayerCmds::ChangeItemName	(	UIDRef	selectedItemRef,
		PMString	itemName
	)

change the current selected item name if it is not assigned by user

Parameters

selectedItemRef	IN the current selected item
itemName	IN the new pageitem name

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpProcessDocumentLayerCmds::CopySelectedItems

(

IControlView *

view

)

Copy/Paste the current selection into the current layer via the IScrapSuite and the clipboard.

Parameters

view	IN the control view

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpProcessDocumentLayerCmds::CopyToNewLayer	(	IDocument *	doc,
		IControlView *	view
	)

Parameters

doc	IN the document
view	IN the control view

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpProcessDocumentLayerCmds::CreateActiveLayer	(	IDocument *	doc,
		IControlView *	view
	)

Invokes NewLayerCmd to create a new command followed by SetActiveLayerCmd to make the new layer active.

Parameters

doc	IN the document
view	IN the control view

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpProcessDocumentLayerCmds::CreateNewLayer

(

IDocument *

doc

)

Parameters

doc	IN the document

Returns

kSuccess on success, other ErrorCode otherwise.

bool16 SnpProcessDocumentLayerCmds::GetPasteRemembersLayers

(

)

Queries the layer preferences to find if the preference PasteRemembersLayers is set.

Returns

kTrue PasteRemembersLayers is On, kFalse PasteRemembersLayers is Off.

ErrorCode SnpProcessDocumentLayerCmds::SelectAllItemsOnActiveLayer	(	IDocument *	doc,
		IControlView *	view
	)

select all page items on active layer

Parameters

doc	IN the current document
view	IN the control view to use

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpProcessDocumentLayerCmds::SetLayerPrefs

(

bool16

pasteRemembersLayers

)

Invokes SetLayerPrefsCmd to set layer preferences

Parameters

pasteRemembersLayers

IN whether or not to set PasteRemembersLayers preference

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpProcessDocumentLayerCmds::ShowHidePageItem

(

UIDRef

selectedItemRef

)

hide the current selected item

Parameters

selectedItemRef

IN the current selected item

Returns

kSuccess on success, other ErrorCode otherwise.