INewPageItemCmdData Class Reference

#include <INewPageItemCmdData.h>

Inheritance diagram for INewPageItemCmdData:

Public Types
enum	{ kDefaultIID = IID_INEWPAGEITEMCMDDATA }
enum	GraphicAttrType {   kNoGraphicAttributes = 0, kDefaultGraphicAttributes, kGraphicFrameAttributes, kTextFrameAttributes,   kFrameGridAttributes, kGroupAttributes }
enum	ObjectStyleApplication { kAlwaysApplyObjectStyle, kNeverApplyObjectStyle, kCommandAppliesObjectStyle }

Public Member Functions
virtual void	SetObjectStyleApplication (ObjectStyleApplication howToApplyObjStyle)=0
virtual ObjectStyleApplication	GetObjectStyleApplication ()=0
Set functions.
Use the Set() function that corresponds to the data that you have to set. DB and ClassID are required Graphic attributes, parent and points are optional. Only those items that are set will be used in the new page item command.
virtual void	Set (IDataBase *, const ClassID)=0
virtual void	Set (IDataBase *, const ClassID, const PMPointList &initialPoints)=0
virtual void	Set (IDataBase *, const ClassID, UID parent)=0
virtual void	Set (IDataBase *, const ClassID, UID parent, const PMPointList &initialPoints)=0
virtual void	Set (IDataBase *, const ClassID, GraphicAttrType)=0
virtual void	Set (IDataBase *, const ClassID, GraphicAttrType, const PMPointList &initialPoints)=0
virtual void	Set (IDataBase *, const ClassID, GraphicAttrType, UID parent)=0
virtual void	Set (IDataBase *, const ClassID, GraphicAttrType, UID parent, const PMPointList &initialPoints)=0
Get functions.
These return values established by the Set functions.
virtual IDataBase *	GetDataBase () const =0
virtual UID	GetParent ()=0
virtual ClassID	GetItemClass ()=0
virtual const PMPointList &	GetPointList () const =0
virtual GraphicAttrType	GetGraphicItemType () const =0
Other accessor functions
virtual bool16	AddToHierarchy () const =0
virtual bool16	HasInitialPointList () const =0
virtual bool16	HasGraphicAttributes () const =0
virtual bool16	IsGraphicFrame () const =0
virtual void	SetAllowDefaultStandOff (bool16 bAllowDefaultStandOff)=0
virtual bool16	AllowDefaultStandOff () const =0
For internal use only
These are used for copy/inflating page item surrogates – see DocumentFramework::CopyandSwapSurrogateCmd for more info Don't use this if you don't know exactly what you're doing. Danger! Danger! Danger!
virtual UID	GetInternalPageItem () const =0
virtual void	SetInternalPageItem (UID pgItem)=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

Data interface for the "New Page Item" command (kNewPageItemCmdBoss).

Member Enumeration Documentation

enum INewPageItemCmdData::GraphicAttrType

Type of graphic attributes to assign to new page items

Enumerator
kNoGraphicAttributes	For special types of page items, don't copy any attributes (such as a standoff)
kDefaultGraphicAttributes	Copy the path item "defaults" to the new item
kGraphicFrameAttributes	A graphic frame which holds graphic items, use special graphic frame style
kTextFrameAttributes	A graphic frame which holds a text frame, use special text frame style
kFrameGridAttributes	A frame grid which is considered as a text frame plus frame grid attributes, use special frame grid style
kGroupAttributes	A group page item that uses special graphic attributes (transparency only)

enum INewPageItemCmdData::ObjectStyleApplication

What to do about applying object styles to the new page item

Enumerator
kAlwaysApplyObjectStyle	Always apply the object style no matter what
kNeverApplyObjectStyle	Never apply the object style no matter what
kCommandAppliesObjectStyle	Let the command decide whether to apply the object style or not

Member Function Documentation

virtual bool16 INewPageItemCmdData::AddToHierarchy ( ) const

pure virtual

Tells whether the command specified a parent.

Returns

kTrue if a parent was specified.

virtual bool16 INewPageItemCmdData::AllowDefaultStandOff ( ) const

pure virtual

Tells whether a default standoff is allowed

Returns

kTrue if a default standoff is allowed.

virtual bool16 INewPageItemCmdData::HasGraphicAttributes ( ) const

pure virtual

Tells whether a graphic attributes type was specified

Returns

kTrue if a graphic attributes type was specified (other than kNoGraphicAttributes)

virtual bool16 INewPageItemCmdData::HasInitialPointList ( ) const

pure virtual

Tells whether an initial point list was specified.

Returns

kTrue if an initial point list was specified.

virtual bool16 INewPageItemCmdData::IsGraphicFrame ( ) const

pure virtual

Tells whether the item is a graphic frame with kGraphicFrameAttributes

Returns

kTrue if the item is a graphic frame with kGraphicFrameAttributes.

virtual void INewPageItemCmdData::SetAllowDefaultStandOff ( bool16  bAllowDefaultStandOff )

pure virtual

Specifies whether to allow a default standoff

Parameters

bAllowDefaultStandOff

kTrue if using a default standoff

virtual void INewPageItemCmdData::SetObjectStyleApplication ( ObjectStyleApplication  howToApplyObjStyle )

pure virtual

Sets/Gets the object style data

Parameters

@return

howToApplyObjStyle see