InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Facade::IArrangeFacade Class Referenceabstract
Inheritance diagram for Facade::IArrangeFacade:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IARRANGEFACADE }
 

Public Member Functions

virtual bool16 CanBringToFront (const UIDList &targetItemList, UID referenceItem=kInvalidUID) const =0
 
virtual bool16 CanBringForward (const UIDList &targetItemList) const =0
 
virtual bool16 CanSendBackward (const UIDList &targetItemList) const =0
 
virtual bool16 CanSendToBack (const UIDList &targetItemList, UID referenceItem=kInvalidUID) const =0
 
virtual ErrorCode ProcessBringToFront (const UIDList &targetItemList, UID referenceItem=kInvalidUID, bool16 bDuplicate=kFalse)=0
 
virtual ErrorCode ProcessBringForward (const UIDList &targetItemList)=0
 
virtual ErrorCode ProcessSendBackward (const UIDList &targetItemList)=0
 
virtual ErrorCode ProcessSendToBack (const UIDList &targetItemList, UID referenceItem=kInvalidUID, bool16 bDuplicate=kFalse)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual bool16 Facade::IArrangeFacade::CanBringForward (const UIDListtargetItemList) const
pure virtual

Can these items be brought forward?

Parameters
targetItemListthe list of items to be affected
Returns
bool16 - kTrue == Yes, kFalse == No
virtual bool16 Facade::IArrangeFacade::CanBringToFront (const UIDListtargetItemList,
UID referenceItem = kInvalidUID 
) const
pure virtual

Can these items be brought to front?

Parameters
targetItemListthe list of items to be affected
referenceItemthe item these should be positioned relative to(if any)
Returns
bool16 - kTrue == Yes, kFalse == No
virtual bool16 Facade::IArrangeFacade::CanSendBackward (const UIDListtargetItemList) const
pure virtual

Can these items be sent backward?

Parameters
targetItemListthe list of items to be affected
Returns
bool16 - kTrue == Yes, kFalse == No
virtual bool16 Facade::IArrangeFacade::CanSendToBack (const UIDListtargetItemList,
UID referenceItem = kInvalidUID 
) const
pure virtual

Can these items be sent to back?

Parameters
targetItemListthe list of items to be affected
referenceItemthe item these should be positioned relative to(if any)
Returns
bool16 - kTrue == Yes, kFalse == No
virtual ErrorCode Facade::IArrangeFacade::ProcessBringForward (const UIDListtargetItemList)
pure virtual

Bring the targeted items forward

Parameters
targetItemListthe list of items to be affected
Returns
ErrorCode - Success/Failure
virtual ErrorCode Facade::IArrangeFacade::ProcessBringToFront (const UIDListtargetItemList,
UID referenceItem = kInvalidUID,
bool16 bDuplicate = kFalse 
)
pure virtual

Bring the targeted items to the front

Parameters
targetItemListthe list of items to be affected
referenceItemthe item these should be positioned relative to(if any)
bDuplicate,kTrueto duplicate the items before moving to the new z-order location
Returns
ErrorCode - Success/Failure
virtual ErrorCode Facade::IArrangeFacade::ProcessSendBackward (const UIDListtargetItemList)
pure virtual

Send the targeted items backward in the Z-order

Parameters
targetItemListthe list of items to be affected
Returns
ErrorCode - Success/Failure
virtual ErrorCode Facade::IArrangeFacade::ProcessSendToBack (const UIDListtargetItemList,
UID referenceItem = kInvalidUID,
bool16 bDuplicate = kFalse 
)
pure virtual

Send the items to the back of the z-order

Parameters
targetItemListthe list of items to be affected
referenceItemthe item these should be positioned relative to(if any)
bDuplicate,kTrueto duplicate the items before moving to the new z-order location
Returns
ErrorCode - Success/Failure