IAnchoredObjectInsertData Class Reference

#include <IAnchoredObjectInsertData.h>

Inheritance diagram for IAnchoredObjectInsertData:

Public Types
enum	{ kDefaultIID = IID_IANCHOREDOBJECTINSERTDATA }
enum	AnchoredContent { kTextFrame, kGraphicFrame, kUnassignedFrame }
enum	{   kCmdSelector_Content = 0x01, kCmdSelector_ObjectStyle = 0x02, kCmdSelector_ParaStyle = 0x04, kCmdSelector_Height = 0x08,   kCmdSelector_Width = 0x010 }

Public Member Functions
virtual void	SetInitialContent (IAnchoredObjectInsertData::AnchoredContent content)=0
virtual IAnchoredObjectInsertData::AnchoredContent	GetInitialContent () const =0
virtual void	SetInitialObjectStyle (UID styleID)=0
virtual UID	GetInitialObjectStyle () const =0
virtual void	SetInitialParagraphStyle (UID styleID)=0
virtual UID	GetInitialParagraphStyle () const =0
virtual void	SetInitialWidth (PMReal w)=0
virtual PMReal	GetInitialWidth () const =0
virtual void	SetInitialHeight (PMReal h)=0
virtual PMReal	GetInitialHeight () 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

IAnchoredObjectInsertData is an interface used to store the properties used when creating anchored objects. Used by both the CreateAnchoredObjectCmd and also defaults, this interface stores information about the size, what kind of object, and some intitial properties when created anchored pageitems automatically.

See Also

IAnchoredObjectData

Member Enumeration Documentation

anonymous enum

used by the ChangeAnchoredObjectCmd's IIntData interface to control which fields to set by the command

enum IAnchoredObjectInsertData::AnchoredContent

the initial inserted object's content types

Member Function Documentation

virtual IAnchoredObjectInsertData::AnchoredContent IAnchoredObjectInsertData::GetInitialContent ( ) const

pure virtual

Get the type of content that will be inserted.

Returns

the content type.

virtual PMReal IAnchoredObjectInsertData::GetInitialHeight ( ) const

pure virtual

Get the height of the object to be inserted.

Returns

the initial height in points.

virtual UID IAnchoredObjectInsertData::GetInitialObjectStyle ( ) const

pure virtual

Get the object style that would be applied to the inserted object.

Returns

the UID of the object style.

virtual UID IAnchoredObjectInsertData::GetInitialParagraphStyle ( ) const

pure virtual

Get the paragraph style that would be applied to an inserted text frame.

Returns

the UID of the paragraph style.

virtual PMReal IAnchoredObjectInsertData::GetInitialWidth ( ) const

pure virtual

Get the initial width of the object that would be inserted.

Returns

the initial width.

virtual void IAnchoredObjectInsertData::SetInitialContent ( IAnchoredObjectInsertData::AnchoredContent  content )

pure virtual

When inserting an anchored object automatically, which type of object should be inserted?

Parameters

content

is the type of object to insert: text frame, graphic frame, unassigned frame.

virtual void IAnchoredObjectInsertData::SetInitialHeight ( PMReal  h )

pure virtual

Set the height of the object to be inserted.

Parameters

h	is the height in points.

virtual void IAnchoredObjectInsertData::SetInitialObjectStyle ( UID  styleID )

pure virtual

Set the object style to be applied to the inserted object.

Parameters

styleID

is the object style to apply.

virtual void IAnchoredObjectInsertData::SetInitialParagraphStyle ( UID  styleID )

pure virtual

Set the paragraph style to be applied to the inserted object, IFF the object is a text frame.

Parameters

styleID

is the paragraph style to apply

virtual void IAnchoredObjectInsertData::SetInitialWidth ( PMReal  w )

pure virtual

Set the width of the object to be inserted.

Parameters

w	is the width in points.