IGraphicFrameData Class Reference

Inheritance diagram for IGraphicFrameData:

Public Types
enum	{ kDefaultIID = IID_IGRAPHICFRAMEDATA }

Public Member Functions
virtual bool16	IsGraphicFrame () const =0
virtual void	SetGraphicFrame (bool16 isGraphicFrame)=0
virtual bool16	HasContent () const =0
virtual bool16	HasPlaceHolderContent () const =0
virtual UID	GetTextContentUID () const =0
virtual UID	GetMCTextFrameUID () const =0
virtual IMultiColumnTextFrame *	QueryMCTextFrame () const =0
virtual bool16	IsSplitAllowed (const UIDRef *parent=nil) const =0
virtual bool16	IsCopyToCompoundPathAllowed () const =0
virtual bool16	IsMakeCompoundPathAllowed () const =0
virtual bool16	IsReleaseCompoundPathAllowed () const =0
virtual ICommand *	CreateSetupPartialCopyCommand (const UIDRef *parent=nil)=0
virtual ICommand *	CreateCleanupPartialCopyCommand (const UIDRef *parent=nil)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Function Documentation

virtual ICommand* IGraphicFrameData::CreateCleanupPartialCopyCommand ( const UIDRef *  parent = nil )

pure virtual

This method gives the object an opportunity to make itself temporarily copyable when only a part (or parts) of an object will be copied (e.g., multiple discontiguous points or segments selected). If parent == nil, the object's current parent is assumed. Caveat emptor: One or both of these methods may legitimately return nil. Also, it's legitimate for the implementation to expect that these methods will be called in consecutive pairs

Returns

ICommand*, returns command, may return nil.

virtual ICommand* IGraphicFrameData::CreateSetupPartialCopyCommand ( const UIDRef *  parent = nil )

pure virtual

This method gives the object an opportunity to make itself temporarily copyable when only a part (or parts) of an object will be copied (e.g., multiple discontiguous points or segments selected). If parent == nil, the object's current parent is assumed. Caveat emptor: One or both of these methods may legitimately return nil. Also, it's legitimate for the implementation to expect that these methods will be called in consecutive pairs

Returns

ICommand*, returns command, may return nil.

virtual UID IGraphicFrameData::GetMCTextFrameUID ( ) const

pure virtual

Determines if a frame is a text frame.

Returns

UID, Returns UID child text frame (IMultiColumnTextFrame), kInvalidUID if not a text frame.

virtual UID IGraphicFrameData::GetTextContentUID ( ) const

pure virtual

Determines if a frame is a text frame. This method is an alias to GetMCTextFrameUID. This method does nothing except "return GetMCTextFrameUID()".

Returns

UID, Returns UID child text frame (IMultiColumnTextFrame), kInvalidUID if not a text frame.

virtual bool16 IGraphicFrameData::HasContent ( ) const

pure virtual

Determines if a graphic frame has content, which is true if the frame has children in its hierarchy.

Returns

bool16, Returns kTrue if frame has content, kFalse if not.

virtual bool16 IGraphicFrameData::HasPlaceHolderContent ( ) const

pure virtual

Determines if a graphic frame has placeholder content, which is true if the frame has a kPlaceHolderItemBoss as its child.

Returns

bool16, Returns kTrue if frame has placeholder content, kFalse if not.

virtual bool16 IGraphicFrameData::IsCopyToCompoundPathAllowed ( ) const

pure virtual

Determines if a frame's paths may be converted to compound path during copy.

Returns

bool16, returns kTrue if parts of this object's path may be combined into a compound path during a copy, kFalse otherwise.

virtual bool16 IGraphicFrameData::IsGraphicFrame ( ) const

pure virtual

Interface on all spline page items indicating if the item is considered a frame.

Returns

bool16, Returns kTrue if item is a graphic frame (draws with an 'x'), kFalse if not.

virtual bool16 IGraphicFrameData::IsMakeCompoundPathAllowed ( ) const

pure virtual

Determines if a frame's path may be converted to a compound path.

Returns

bool16, returns kTrue if this object may be incorporated into a compound path, kFalse otherwise.

virtual bool16 IGraphicFrameData::IsReleaseCompoundPathAllowed ( ) const

pure virtual

Determines if a frame's paths may be released from a compound path.

Returns

bool16, returns kTrue if this object may be released from a compound path, kFalse otherwise.

virtual bool16 IGraphicFrameData::IsSplitAllowed ( const UIDRef *  parent = nil ) const

pure virtual

Determines if a frame may be split. Used by scissors and eraser tools.

Returns

bool16, returns kTrue if this object's path may be split into multiple objects with the given parent, kFalse otherwise. If parent == nil, the object's current parent is assumed.

virtual IMultiColumnTextFrame* IGraphicFrameData::QueryMCTextFrame ( ) const

pure virtual

Determines if a frame is a text frame.

Returns

IMultiColumnTextFrame*, Return the child text frame (IMultiColumnTextFrame), nil if not a text frame.

virtual void IGraphicFrameData::SetGraphicFrame ( bool16  isGraphicFrame )

pure virtual

Set method for turning a non-frame into a frame. See also kSetGraphicFrameDataCmdBoss.

Parameters

bool16

kTrue to change to a graphic frame, kFalse to change to a non-frame.