InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CGraphicPlaceBehavior Class Reference
Inheritance diagram for CGraphicPlaceBehavior:
CPMUnknown< IPlaceBehavior >IPlaceBehaviorIPMUnknown

Public Member Functions

 CGraphicPlaceBehavior (IPMUnknown *boss)
 
virtual UIDList ProcessPlace (IPlaceBehavior *targetItem, const UIDRef &parent, const PMPointList &points, ICursorMgr::eCursorModifierState finalModifiers, ICursorMgr::eCursorModifierState startingModifiers, const ISpread *spread, IPlaceBehavior::eAfterPlace *afterPlace, IItemsToPlaceData::ePlaceFrom placeFrom=IItemsToPlaceData::kPlaceGun)
 
virtual void ProcessReplacePreserveState (IPlaceBehavior *srcRoot, IPlaceBehavior *target)
 
virtual void AppendScriptObjects (ScriptList &objectList)
 
virtual UID ProcessReplace (const UIDRef &placedItem, const UIDRef &oldItem, bool16 useClippingFrame, IPlaceBehavior::eAfterPlace *afterPlace, IItemsToPlaceData::ePlaceFrom placeFrom=IItemsToPlaceData::kPlaceGun)
 
virtual bool16 CanPlaceInto (eFrameKind newPageItemKind) const
 
virtual bool16 CanPlaceInto (const IPlaceBehavior &sourceItem, const ISpread *spread) const
 
virtual bool16 CanReplace () const
 
virtual bool16 CanConvertTo (eFrameKind newPageItemKind) const
 
virtual ErrorCode ProcessConvertTo (eFrameKind newPageItemKind, IControlView *view)
 
virtual bool16 IsEmpty () const
 
virtual bool16 IsFromMaster (const IHierarchy *targetHier, const ISpread *targetSpread) const
 
- Public Member Functions inherited from CPMUnknown< IPlaceBehavior >
IPMUnknownQueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

Protected Member Functions

virtual bool16 IsItemMasterNotOverrideable (const IHierarchy *hier, const ISpread *spread) const
 helpers
 
virtual bool16 IsItemRoot () const
 
virtual eFrameKind GetFrameKind () const
 
virtual IPlaceBehaviorQueryItemRoot ()
 
virtual UIDList ProcessDoPlace (const UIDRef &parent, const PMPointList &points, IItemsToPlaceData::ePlaceFrom placeFrom=IItemsToPlaceData::kPlaceGun)
 
virtual UIDList ProcessDoPlaceInto (IPlaceBehavior *targetItem, const PMPointList &points, IPlaceBehavior::eAfterPlace &whatToDoAfter, IItemsToPlaceData::ePlaceFrom placeFrom=IItemsToPlaceData::kPlaceGun)
 
virtual UID ProcessReplaceMe (const UIDRef &placedItem, const UIDRef &oldItem, bool16 usePlaceGunFrame, IPlaceBehavior::eAfterPlace *afterPlace, IItemsToPlaceData::ePlaceFrom placeFrom)
 
virtual UID ProcessReplaceChildren (const UIDRef &placedItem, const UIDRef &oldItem, bool16 usePlaceGunFrame, IPlaceBehavior::eAfterPlace *afterPlace)
 
virtual void HandleXMPRotation (IPersistUIDData *uidData, bool16 modifyFrame)
 
virtual bool16 IsPlaceLoaded (IDataBase *db, IItemsToPlaceData::ePlaceFrom placeFrom) const
 
virtual UID GetFirstItemToPlaceUID (IDataBase *db, IItemsToPlaceData::ePlaceFrom placeFrom) const
 
virtual ErrorCode ClearFirstItemToPlace (IDataBase *db, IItemsToPlaceData::ePlaceFrom placeFrom) const
 
virtual ErrorCode AbortFirstItemToPlace (IDataBase *db, IItemsToPlaceData::ePlaceFrom placeFrom) const
 
virtual ErrorCode AbortAllItemsToPlace (IDataBase *db, IItemsToPlaceData::ePlaceFrom placeFrom) const
 
virtual int32 RefPointPositionToAlignContentInFrame (IReferencePointData::ReferencePointPosition pos) const
 
- Protected Member Functions inherited from CPMUnknown< IPlaceBehavior >
 CPMUnknown (IPMUnknown *boss)
 

Additional Inherited Members

- Public Types inherited from IPlaceBehavior
enum  { kDefaultIID = IID_IPLACEBEHAVIOR }
 
enum  eAfterPlace { kOldBehavior, kLeaveAsIs, kClearPlaceGun, kAbortPlaceGun }
 
enum  ePlaceType { kPlaceSingle, kPlaceCascade, kPlaceMultiple }
 
enum  eFrameKind {
  kTextFrameKind, kGraphicFrameKind, kInteractiveFrameKind, kContainerFrameKind,
  kTextInsertionKind, kUnknownFrameKind
}
 
- Protected Attributes inherited from CPMUnknown< IPlaceBehavior >
HelperInterface fHelperInterface
 

Member Function Documentation

virtual void CGraphicPlaceBehavior::AppendScriptObjects (ScriptList & objectList)
virtual

Append a list of script objects corresponding to the source content. If this content can be loaded into the place gun, these script objects will be considered children of the place gun.

Parameters
thelist to which to append the script objects INOUT

Implements IPlaceBehavior.

virtual bool16 CGraphicPlaceBehavior::CanConvertTo (eFrameKind newPageItemKind) const
virtual

Can the frame corresponding to "this" object be converted to a new type.

Parameters
newPageItemKindIN the new type
Returns
true if "this" item can be converted to the new type

Implements IPlaceBehavior.

virtual bool16 CGraphicPlaceBehavior::CanPlaceInto (eFrameKind newPageItemKind) const
virtual

Can a source item of a given type be placed into "this" object

Parameters
newPageItemKindIN the type of the source item
Returns
true if "this" could accept the place

Implements IPlaceBehavior.

virtual bool16 CGraphicPlaceBehavior::CanPlaceInto (const IPlaceBehaviorsourceItem,
const ISpreadspread 
) const
virtual

Can the source item be placed into "this" object

Parameters
sourceItemIN the place behavior of the object being placed
spreadIN the destination spread (used for master spread relationship)
Returns
true if "this" could accept the place

Implements IPlaceBehavior.

virtual bool16 CGraphicPlaceBehavior::CanReplace () const
virtual

Can "this" item be replaced

Returns
true if "this" item can be replaced

Implements IPlaceBehavior.

virtual eFrameKind CGraphicPlaceBehavior::GetFrameKind () const
protectedvirtual

Get the frame kind of "this" content.

Implements IPlaceBehavior.

virtual bool16 CGraphicPlaceBehavior::IsEmpty () const
virtual

Is the frame corresponding to "this" object empty?

Implements IPlaceBehavior.

virtual bool16 CGraphicPlaceBehavior::IsFromMaster (const IHierarchytargetHier,
const ISpreadtargetSpread 
) const
virtual

Is targetHier from a different spread (thus from a master spread)?

Parameters
targetHierIN the target item's hierarchy (might be a master page item)
targetSpreadIN target spread
Returns
true if from a master spread.

Implements IPlaceBehavior.

virtual ErrorCode CGraphicPlaceBehavior::ProcessConvertTo (eFrameKind newPageItemKind,
IControlViewcontrolView 
)
virtual

Perform a ConvertTo operation.

Parameters
newPageItemKindIN which frame kind should the object be converted to
controlViewIN controlView parameter can be used by implementation if selection changes need to be made.
Returns
result of the operation, kSuccess or an error code.

Implements IPlaceBehavior.

virtual UIDList CGraphicPlaceBehavior::ProcessPlace (IPlaceBehaviortargetItem,
const UIDRefparent,
const PMPointListpoints,
ICursorMgr::eCursorModifierState finalModifiers,
ICursorMgr::eCursorModifierState startingModifiers,
const ISpreadspread,
IPlaceBehavior::eAfterPlaceafterPlace,
IItemsToPlaceData::ePlaceFrom placeFrom = IItemsToPlaceData::kPlaceGun 
)
virtual

Perform a Place operation

Parameters
targetItemIN target for the place
parentIN parent of the placed object(s)
pointsIN location of the place
finalModifiersIN modifier key state
startingModifiersIN modifier key state
spreadIN spread where place is to occur
afterPlaceINOUT what should happen after the place (optional)
Returns
UIDList of placed objects

Implements IPlaceBehavior.

virtual UID CGraphicPlaceBehavior::ProcessReplace (const UIDRefplacedItem,
const UIDRefoldItem,
bool16 useClippingFrame,
IPlaceBehavior::eAfterPlaceafterPlace,
IItemsToPlaceData::ePlaceFrom placeFrom = IItemsToPlaceData::kPlaceGun 
)
virtual

Perform a Replace operation (new item replaces an existing one)

Parameters
placedItemIN new item
oldItemIN exiting item
useClippingFrameIN retain the clipping frame
afterPlaceINOUT what should happen after the replace
Returns
newly placed object

Implements IPlaceBehavior.

virtual UID CGraphicPlaceBehavior::ProcessReplaceChildren (const UIDRefplacedItem,
const UIDRefoldItem,
bool16 usePlaceGunFrame,
IPlaceBehavior::eAfterPlaceafterPlace 
)
protectedvirtual

Utility routine to replace the children of the target object (Me)

Parameters
placedItemIN item to be placed
oldItemIN item to replace
usePlaceGunFrameIN use or strip off the frame around the item from the place gun
afterPlaceINOUT what should happen after the replace
Returns
newly placed object

Implements IPlaceBehavior.

virtual UID CGraphicPlaceBehavior::ProcessReplaceMe (const UIDRefplacedItem,
const UIDRefoldItem,
bool16 usePlaceGunFrame,
IPlaceBehavior::eAfterPlaceafterPlace,
IItemsToPlaceData::ePlaceFrom placeFrom 
)
protectedvirtual

Utility routine to replace the target object (Me)

Parameters
placedItemIN item to be placed
oldItemIN item to replace
usePlaceGunFrameIN use or strip off the frame around the item from the place gun
afterPlaceINOUT what should happen after the replace
Returns
newly placed object

Implements IPlaceBehavior.

virtual void CGraphicPlaceBehavior::ProcessReplacePreserveState (IPlaceBehaviornewItem,
IPlaceBehaviortarget 
)
virtual

ProcessReplacePreserveState gives this a chance to set itself and srcRoot to values from target. Note: newItem may or may not be the same item as "this" interface.

Parameters
newItemIN the source's place behavior
targetIN the target's place behavior

Implements IPlaceBehavior.