InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IPathSelectionList Class Referenceabstract

#include <IPathSelectionList.h>

Inheritance diagram for IPathSelectionList:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPATHSELECTIONLIST }
 

Public Member Functions

virtual IDataBase * GetDataBase () const =0
 
virtual ErrorCode SetSelection (const PathSelectionList &list)=0
 
virtual const PathSelectionList & GetSelection () const =0
 
virtual ErrorCode Add (const UIDRef &item, const PointSelector &handle)=0
 
virtual ErrorCode Add (const UIDRef &item, const PointSelectorList &pts)=0
 
virtual ErrorCode Add (const PathSelectionList &list)=0
 
virtual ErrorCode Clear ()=0
 
virtual ErrorCode Clear (const UIDRef &item)=0
 
virtual ErrorCode Clear (const UIDRef &item, const PointSelector &handle)=0
 
virtual ErrorCode Clear (const UIDRef &item, const PointSelectorList &pts)=0
 
virtual ErrorCode Clear (const PathSelectionList &list)=0
 
virtual bool16 IsEmpty () const =0
 
virtual bool16 IsSelected (const UIDRef &item) const =0
 
virtual bool16 IsSelected (const UIDRef &item, const PointSelector &handle) const =0
 
virtual int32 Length () const =0
 
virtual UIDList GetItemList () const =0
 
virtual int32 Length (const UIDRef &item) const =0
 
virtual void GetComponentList (const UIDRef &item, PointSelectorList &ptsOut) const =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

A path point selection may contain anchor points and/or path segments (collectively known as path components). An anchor point is indicated by PointSelector::Selector() == kAnchorPt. A path segment is indicated by PointSelector::Selector() == kSegment.

Member Function Documentation

virtual ErrorCode IPathSelectionList::Add (const UIDRef & item,
const PointSelector & handle 
)
pure virtual

Adds path component to selection

virtual ErrorCode IPathSelectionList::Add (const UIDRef & item,
const PointSelectorList & pts 
)
pure virtual

Adds path components to selection

virtual ErrorCode IPathSelectionList::Add (const PathSelectionList & list)
pure virtual

Appends another path selection list onto this one

virtual ErrorCode IPathSelectionList::Clear ()
pure virtual

Clears all path components

virtual ErrorCode IPathSelectionList::Clear (const UIDRef & item)
pure virtual

Clears all path components for this item

virtual ErrorCode IPathSelectionList::Clear (const UIDRef & item,
const PointSelector & handle 
)
pure virtual

Clears this path component for this item

virtual ErrorCode IPathSelectionList::Clear (const UIDRef & item,
const PointSelectorList & pts 
)
pure virtual

Clears these path components for this item

virtual ErrorCode IPathSelectionList::Clear (const PathSelectionList & list)
pure virtual

Clears these path components

virtual void IPathSelectionList::GetComponentList (const UIDRef & item,
PointSelectorList & ptsOut 
) const
pure virtual

Return list of path components selected on object

virtual IDataBase* IPathSelectionList::GetDataBase () const
pure virtual

Set the database Get the database

virtual UIDList IPathSelectionList::GetItemList () const
pure virtual

Return list of objects with path components selected

virtual const PathSelectionList& IPathSelectionList::GetSelection () const
pure virtual

Get the entire selection

virtual bool16 IPathSelectionList::IsEmpty () const
pure virtual

Returns kTrue if there are no path components selected

virtual bool16 IPathSelectionList::IsSelected (const UIDRef & item) const
pure virtual

Returns kTrue if one or more path components on this item are selected

virtual bool16 IPathSelectionList::IsSelected (const UIDRef & item,
const PointSelector & handle 
) const
pure virtual

Returns kTrue if this path component on this item is selected

virtual int32 IPathSelectionList::Length () const
pure virtual

Return number of objects with path components selected

virtual int32 IPathSelectionList::Length (const UIDRef & item) const
pure virtual

Return number of path components selected on object

virtual ErrorCode IPathSelectionList::SetSelection (const PathSelectionList & list)
pure virtual

Set the entire selection