InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ILayoutTarget Class Referenceabstract

#include <ILayoutTarget.h>

Inheritance diagram for ILayoutTarget:
IPMUnknown

Classes

struct  Int2Type
 
struct  LockedParentChoice
 
struct  StandoffChoice
 

Public Types

enum  { kDefaultIID = IID_ILAYOUTTARGET }
 

Public Member Functions

virtual void Add (const UID newItem)=0
 
virtual void Add (const UIDList &newItems)=0
 
virtual void Remove (const UID itemToRemove)=0
 
virtual void Clear (void)=0
 
virtual UIDList GetUIDList (StandoffChoice stripStandoffs, LockedParentChoice stripIfParentLocked) const =0
 
UIDList GetUIDList (StandoffChoice stripStandoffs) const
 
virtual void SetUIDList (const UIDList &)=0
 
virtual void SetUIDList (const UID)=0
 
virtual UIDList CreateFlattenedUIDList (const PMIID &) const =0
 
virtual void CalculatePreviousSelectionDifferences (UIDList *addedPageItems, UIDList *removedPageItems)=0
 
virtual void Initialize (IDataBase *)=0
 
virtual bool16 PartOfTarget (const UID &) const =0
 
virtual void TargetChanged (void)=0
 
virtual bool16 HasContent (void) const =0
 
virtual UIDRef GetKeyObject (void) const =0
 
virtual void SetKeyObject (const UIDRef &keyObject)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

The Layout target interface. A wrapper around the a UIDList for selection and target bosses

Member Function Documentation

virtual void ILayoutTarget::Add (const UID newItem)
pure virtual

Add a new item

virtual void ILayoutTarget::Add (const UIDListnewItems)
pure virtual

Add a new item

virtual void ILayoutTarget::CalculatePreviousSelectionDifferences (UIDListaddedPageItems,
UIDListremovedPageItems 
)
pure virtual

Calculate the differences between the last two layout selections.

virtual void ILayoutTarget::Clear (void )
pure virtual

Clear the target

virtual UIDList ILayoutTarget::CreateFlattenedUIDList (const PMIID) const
pure virtual

Return the previous target. Only works on the LayoutCSB. Flattent the target's UIDList. This means: (a) Remove any page item that does not have the GfxSelection interface (b) Expand all containers so their children are in the returned list (c) Filter out any page items that do not support "interfaceID" (optional) (d) Any duplicates are removed from the list.

NOTE: If "interfaceID" is kInvalidInterfaceID don't filter any page items.

Returns
Index (>= 0 if in list); Negative number (< 0) if not in list.
virtual UIDRef ILayoutTarget::GetKeyObject (void ) const
pure virtual

Return the key object, kInvalidUIDRef if none

virtual UIDList ILayoutTarget::GetUIDList (StandoffChoice stripStandoffs,
LockedParentChoice stripIfParentLocked 
) const
pure virtual

Get the target

virtual bool16 ILayoutTarget::HasContent (void ) const
pure virtual

Has content, is the UIDList non empty

virtual void ILayoutTarget::Initialize (IDataBase)
pure virtual

Initialize

virtual bool16 ILayoutTarget::PartOfTarget (const UID) const
pure virtual

Is the UID part of the target

virtual void ILayoutTarget::Remove (const UID itemToRemove)
pure virtual

Remove a item

virtual void ILayoutTarget::SetKeyObject (const UIDRefkeyObject)
pure virtual

Set the key object, kInvalidUIDRef to clear

virtual void ILayoutTarget::SetUIDList (const UIDList)
pure virtual

Set the target

virtual void ILayoutTarget::SetUIDList (const UID )
pure virtual

Set the target

virtual void ILayoutTarget::TargetChanged (void )
pure virtual

The target has changed