IAutoFlowCmdData Class Reference

#include <IAutoFlowCmdData.h>

Inheritance diagram for IAutoFlowCmdData:

Public Types
enum	{ kDefaultIID = IID_IAUTOFLOWCMDDATA }

Public Member Functions
virtual void	Set (UID page, UID framelist, UIDRef &parent, PMPoint &where, bool16 usePB=kFalse, bool16 usePlaceGun=kTrue)=0
virtual IFrameList *	QueryFrameList ()=0
virtual IGeometry *	QueryStartPage ()=0
virtual const UIDRef &	GetParent () const =0
virtual const PMPoint &	GetClickPoint () const =0
virtual bool16	UseProgressBar () const =0
virtual TextIndex	GetTextLength ()=0
virtual UID	GetFrameListUID ()=0
virtual UID	GetInitialTextFrameUID () const =0
virtual UID	GetFirstPlaceItemUID () const =0
virtual bool16	UsePlaceGun () 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

Used by the auto-flow text command, this interface sets the parameters for the command to use.

Member Function Documentation

virtual const PMPoint& IAutoFlowCmdData::GetClickPoint ( ) const

pure virtual

Get the mouse-down position.

Returns

the mouse-down point in pasteboard coordinates.

virtual UID IAutoFlowCmdData::GetFirstPlaceItemUID ( ) const

pure virtual

Get the first item on the place gun if UsePlaceGun returns kTrue else returns the first item on the content dropper's place head.

Returns

the UID of the first place item.

virtual UID IAutoFlowCmdData::GetFrameListUID ( )

pure virtual

Get the IFrameList reference.

Returns

the UID of the frame list.

virtual UID IAutoFlowCmdData::GetInitialTextFrameUID ( ) const

pure virtual

Get the initial text frame to start autoflowing with.

Returns

the UID of the starting text frame.

virtual const UIDRef& IAutoFlowCmdData::GetParent ( ) const

pure virtual

Get the layer to flow onto.

Returns

the UIDRef of the layer to place into.

virtual TextIndex IAutoFlowCmdData::GetTextLength ( )

pure virtual

Get the number of characters that will be autoflowed - used for the progress bar.

Returns

the length of the story.

virtual IFrameList* IAutoFlowCmdData::QueryFrameList ( )

pure virtual

Get the IFrameList interface of story to autoflow.

Returns

an AddRef'd IFrameList interface of the story.

virtual IGeometry* IAutoFlowCmdData::QueryStartPage ( )

pure virtual

Get the page to start autoflowing on.

Returns

an AddRef'd IGeometry interface of the starting page.

virtual void IAutoFlowCmdData::Set ( UID  page, UID  framelist, UIDRef &  parent, PMPoint &  where, bool16  usePB = kFalse, bool16  usePlaceGun = kTrue  )

pure virtual

Set the parameters for the command to use.

Parameters

page	is which page UID to start autoflowing on.
framelist	is the framelist UID of the story to start autoflowing with. If the frame list is kInvalidUID, the cmd will use the contents of the place gun or content dropper; otherwise it will use the provided framelist and delete the place gun's(or content dropper's)
parent	is the layer within to document to autoflow into. This becomes the hierarchical parent of the new text frames.
where	specifies to point in pasteboard coordinates of the initial mouse-down.
usePB	specified whether to use a progress bar during auto-flow.
usePlaceGun	specifies whether to use the place gun or content dropper

virtual bool16 IAutoFlowCmdData::UsePlaceGun ( ) const

pure virtual

Controls whether to use the place or content dropper. This option will be used if the framelist provided in the Set method is kInvalidUID.

Returns

kTrue if place gun is to be used.

virtual bool16 IAutoFlowCmdData::UseProgressBar ( ) const

pure virtual

Control the progress bar.

Returns

kFalse to suppress the progress bar.