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

#include <IPathSelection.h>

Inheritance diagram for IPathSelection:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPATHSELECTION }
 

Public Member Functions

virtual void ActivatePathSelection_ (bool16 isPathSelection)=0
 
virtual bool16 IsPathSelectionActive_ () const =0
 
virtual ErrorCode SelectPathPoints_ (const PathSelectionList &list)=0
 
virtual ErrorCode SelectEntirePageItem_ (const UIDList &itemList)=0
 
virtual ErrorCode ReplacePathSelection_ (const PathSelectionList &add)=0
 
virtual ErrorCode Replace__ (const UIDList &itemList)=0
 
virtual ErrorCode DeselectPageItemPathPoint_ (const UIDRef &item, const PointSelector &handle)=0
 
virtual ErrorCode DeselectPageItemPathPoints_ (const UIDRef &item, const PointSelectorList &pts)=0
 
virtual ErrorCode DeselectPathPoints_ (const PathSelectionList &list)=0
 
virtual ErrorCode DeselectEntirePageItem_ (const UIDList &itemList)=0
 
virtual ErrorCode DeselectAllPaths_ ()=0
 
virtual bool16 IsPathSelectionEmpty_ () const =0
 
virtual bool16 IsAnyPageItemPathPointSelected_ (const UIDRef &item) const =0
 
virtual bool16 IsPageItemPathPointSelected_ (const UIDRef &item, const PointSelector &handle) const =0
 
virtual int32 CountPathSelectedPageItems_ () const =0
 
virtual UIDList GetPathSelectedPageItems_ () const =0
 
virtual int32 CountPathSelectors_ (const UIDRef &item) const =0
 
virtual void GetSelectorList_ (const UIDRef &item, PointSelectorList &ptsOut) const =0
 
virtual const PathSelectionList & GetPathSelection_ () const =0
 
virtual bool16 IsEntirePageItemSelected_ (const UIDRef &item) const =0
 
virtual bool16 IsEntirePathSelected_ (const UIDRef &item, int32 pathIndex) const =0
 
virtual bool16 IsSinglePoint (UIDRef *theItem=nil, PointSelector *thePoint=nil) const =0
 
virtual bool16 IsSingleSegment (UIDRef *theItem=nil, PointSelector *theSegment=nil) const =0
 
virtual bool16 IsTwoContiguousSegs (UIDRef *theItem=nil, PointSelector *thePoint=nil) const =0
 
virtual bool16 IsFullySelected (const UIDRef &item) 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 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 void IPathSelection::ActivatePathSelection_ (bool16 isPathSelection)
pure virtual

Toggles path selection mode on/off

virtual int32 IPathSelection::CountPathSelectedPageItems_ () const
pure virtual

Return number of objects with path components selected

virtual int32 IPathSelection::CountPathSelectors_ (const UIDRef & item) const
pure virtual

Return number of path components selected on object

virtual ErrorCode IPathSelection::DeselectAllPaths_ ()
pure virtual

Deselects all path components

virtual ErrorCode IPathSelection::DeselectEntirePageItem_ (const UIDList & itemList)
pure virtual

Deselects all path components of these items

virtual ErrorCode IPathSelection::DeselectPageItemPathPoint_ (const UIDRef & item,
const PointSelector & handle 
)
pure virtual

Deselects a path component

virtual ErrorCode IPathSelection::DeselectPageItemPathPoints_ (const UIDRef & item,
const PointSelectorList & pts 
)
pure virtual

Deselects these path components for this item

virtual ErrorCode IPathSelection::DeselectPathPoints_ (const PathSelectionList & list)
pure virtual

Deselects these path components

virtual UIDList IPathSelection::GetPathSelectedPageItems_ () const
pure virtual

Retrieves the items with selected path components

virtual const PathSelectionList& IPathSelection::GetPathSelection_ () const
pure virtual

Get entire selection

virtual void IPathSelection::GetSelectorList_ (const UIDRef & item,
PointSelectorList & ptsOut 
) const
pure virtual

Retrieves the selected path components of an item

virtual bool16 IPathSelection::IsAnyPageItemPathPointSelected_ (const UIDRef & item) const
pure virtual

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

virtual bool16 IPathSelection::IsEntirePageItemSelected_ (const UIDRef & item) const
pure virtual

Returns kTrue if all points (and thus all segments as well) on the object are selected

virtual bool16 IPathSelection::IsEntirePathSelected_ (const UIDRef & item,
int32 pathIndex 
) const
pure virtual

Returns kTrue if all points (and thus all segments as well) on the object's path are selected

virtual bool16 IPathSelection::IsFullySelected (const UIDRef & item) const
pure virtual

Returns kTrue if the all points/segments on the item are selected

virtual bool16 IPathSelection::IsPageItemPathPointSelected_ (const UIDRef & item,
const PointSelector & handle 
) const
pure virtual

Returns kTrue if this path component on this item is selected

virtual bool16 IPathSelection::IsPathSelectionActive_ () const
pure virtual

Returns kTrue if the current selection is a path selection

virtual bool16 IPathSelection::IsPathSelectionEmpty_ () const
pure virtual

Returns kTrue if there are no path components selected

virtual bool16 IPathSelection::IsSinglePoint (UIDRef * theItem = nil,
PointSelector * thePoint = nil 
) const
pure virtual

Returns kTrue if only a single anchor point (and one or both contiguous segments) is selected

virtual bool16 IPathSelection::IsSingleSegment (UIDRef * theItem = nil,
PointSelector * theSegment = nil 
) const
pure virtual

Returns kTrue if only a single segment is selected

virtual bool16 IPathSelection::IsTwoContiguousSegs (UIDRef * theItem = nil,
PointSelector * thePoint = nil 
) const
pure virtual

Returns kTrue if two contiguous segments are selected (and nothing else)

virtual ErrorCode IPathSelection::Replace__ (const UIDList & itemList)
pure virtual

Replaces currently selected path components with all path components of these items

virtual ErrorCode IPathSelection::ReplacePathSelection_ (const PathSelectionList & add)
pure virtual

Replaces currently selected path components with others

virtual ErrorCode IPathSelection::SelectEntirePageItem_ (const UIDList & itemList)
pure virtual

Selects all path components of these items

virtual ErrorCode IPathSelection::SelectPathPoints_ (const PathSelectionList & list)
pure virtual

Selects a list of path components