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

#include <IGrabBehavior.h>

Inheritance diagram for IGrabBehavior:
IPMUnknownCPMUnknown< IGrabBehavior >CGrabBehavior

Public Types

enum  { kDefaultIID = IID_IGRABBEHAVIOR }
 
enum  eGrabType { kGrabSingle, kGrabNeedfulSet }
 

Public Member Functions

virtual bool16 CanFormNeedfulSet () const =0
 
virtual UIDList GetNeedfulSet () const =0
 
virtual UID GetRootUID () const =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

Interface used to determine how a grab operation behaves over a particular page item. A base implementation is defined in CGrabBehavior; most subclassers should start there.

Member Enumeration Documentation

Types of place given various UI gestures
Enumerator
kGrabSingle 

Grab as a single item

Member Function Documentation

virtual bool16 IGrabBehavior::CanFormNeedfulSet () const
pure virtual

Can the source item be grabbed as NeedfulSet

Returns
true if "this" could have items in NeedfulSet

Implemented in CGrabBehavior.

virtual UIDList IGrabBehavior::GetNeedfulSet () const
pure virtual

Returns UIDList of elements that would be part of the NeedfulSet for this item. It does not include the item's own UID. Only the items that should be part of set for this item are returned

Implemented in CGrabBehavior.

virtual UID IGrabBehavior::GetRootUID () const
pure virtual

Returns UID of the outermost element that has IID_IGRABBEHAVIOR interface defined on it

Implemented in CGrabBehavior.