IPlaceGun Class Reference

#include <IPlaceGun.h>

Inheritance diagram for IPlaceGun:

Public Types
enum	{ kDefaultIID = IID_IPLACEGUN }
enum	PlaceGunLocation { kAddToFront, kAddToBack }

Public Member Functions
virtual bool16	IsLoaded () const =0
virtual uint32	CountPlaceGunUIDs () const =0
virtual void	LoadPlaceGun (UID uid, PlaceGunLocation where=kAddToBack)=0
virtual void	EmptyFirstPlaceGunItem ()=0
virtual UID	GetFirstPlaceGunItemUID () const =0
virtual UID	GetNthPlaceGunItemUID (uint32 n) const =0
virtual UID	GetAbortingItemUID () const =0
virtual void	SetAbortingItemUID (UID uid)=0
virtual bool16	ContainsUID (UID uid)=0
virtual bool16	OwnsAnyPageItemsOnLayer (UID spreadLayerUID) const =0
virtual bool16	OwnsAnyPageItemsOnSpread (UID spreadUID) const =0
virtual void	RotateList (bool16 forward)=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

This class deals with placing images/text onto the page once they have been imported into the document

Member Enumeration Documentation

enum IPlaceGun::PlaceGunLocation

Where to add the item into the place gun

Enumerator
kAddToFront	add to front of place gun list - unusual
kAddToBack	add to end of place gun list - typical

Member Function Documentation

virtual bool16 IPlaceGun::ContainsUID ( UID  uid )

pure virtual

Returns whether a given UID is currently in the place gun.

Parameters

uid	- The UID to search for

Returns

- kTrue if the UID is found, else kFalse

virtual uint32 IPlaceGun::CountPlaceGunUIDs ( ) const

pure virtual

Count how many UIDs are loaded in the place gun

Returns

-count of UIDs

virtual void IPlaceGun::EmptyFirstPlaceGunItem ( )

pure virtual

Clears the uid stored in this interface, but does not delete the uid from the database.

virtual UID IPlaceGun::GetAbortingItemUID ( ) const

pure virtual

During abort place gun, this is the UID of the item being aborted, previously in GetFirstPlaceGunItemUID()

Returns

- The item that was (but is no longer) being placed

See Also

GetFirstPlaceGunItemUID

virtual UID IPlaceGun::GetFirstPlaceGunItemUID ( ) const

pure virtual

Returns UID of the current contents of the place gun.

Returns

- The UID of the contents of the gun

virtual UID IPlaceGun::GetNthPlaceGunItemUID ( uint32  n ) const

pure virtual

Returns UID of the current contents of the place gun.

Returns

- The UID of the contents of the gun

virtual bool16 IPlaceGun::IsLoaded ( ) const

pure virtual

Is the place gun loaded

Returns

- kTrue means the place gun currently has data that could be placed on the page.

virtual void IPlaceGun::LoadPlaceGun ( UID  uid, PlaceGunLocation  where = kAddToBack  )

pure virtual

Load the place gun with this uid.

Parameters

uid	- The UID of the item to be placed. The uid must be of a page item.
where	- Whether to add the item to the front or back of the list Note: The LoadPlaceGunCmd will accept a story uid and call this method with the uid of a newly created frame on the story.

virtual bool16 IPlaceGun::OwnsAnyPageItemsOnLayer ( UID  spreadLayerUID ) const

pure virtual

Returns whether any pageitems in the placegun are on a documentLayer.

Parameters

uid	- The document layer UID

Returns

- kTrue if an owned pageitem assigned to the layer is found, else kFalse

virtual bool16 IPlaceGun::OwnsAnyPageItemsOnSpread ( UID  spreadUID ) const

pure virtual

Returns whether any pageitems in the placegun are on a spread.

Parameters

uid	- The spread UID

Returns

- kTrue if an owned pageitem on the spread is found, else kFalse

virtual void IPlaceGun::RotateList ( bool16  forward )

pure virtual

Rotates the list of UIDs.

Parameters

forward

- Rotate the list forward(i.e. move the front UID to end) or backwards(move backmost UID to front)

virtual void IPlaceGun::SetAbortingItemUID ( UID  uid )

pure virtual

Set the UID of the item being aborted

Parameters

uid	- The UID to abort the placing of