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

#include <IZOrderSelectionSuite.h>

Inheritance diagram for IZOrderSelectionSuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IZORDERSELECTIONSUITE }
 

Public Member Functions

virtual bool16 CanSelectForward (IControlView *view, Selection::Action replaceOrAdd, const PMPoint &point, const PMRect &rect=kEmptyRect) const =0
 
virtual bool16 CanSelectBackward (IControlView *view, Selection::Action replaceOrAdd, const PMPoint &point, const PMRect &rect=kEmptyRect) const =0
 
virtual bool16 CanSelectFront (IControlView *view, Selection::Action replaceOrAdd, const PMPoint &point, const PMRect &rect=kEmptyRect) const =0
 
virtual bool16 CanSelectBack (IControlView *view, Selection::Action replaceOrAdd, const PMPoint &point, const PMRect &rect=kEmptyRect) const =0
 
virtual bool16 CanSelectParent (IControlView *view) const =0
 
virtual bool16 CanSelectChild (IControlView *view) const =0
 
virtual bool16 CanSelectSibling (IControlView *view, SelectDirection direction) const =0
 
virtual ErrorCode SelectForward (IControlView *view, Selection::Action replaceOrAdd, const PMPoint &point, const PMRect &rect=kEmptyRect) const =0
 
virtual ErrorCode SelectBackward (IControlView *view, Selection::Action replaceOrAdd, const PMPoint &point, const PMRect &rect=kEmptyRect) const =0
 
virtual ErrorCode SelectFront (IControlView *view, Selection::Action replaceOrAdd, const PMPoint &point, const PMRect &rect=kEmptyRect) const =0
 
virtual ErrorCode SelectBack (IControlView *view, Selection::Action replaceOrAdd, const PMPoint &point, const PMRect &rect=kEmptyRect) const =0
 
virtual ErrorCode SelectParent (IControlView *view) const =0
 
virtual ErrorCode SelectChild (IControlView *view) const =0
 
virtual ErrorCode SelectSibling (IControlView *view, SelectDirection direction) 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

Suite interface for working with z-ordering of page items.

Member Function Documentation

virtual bool16 IZOrderSelectionSuite::CanSelectBack (IControlView * view,
Selection::Action replaceOrAdd,
const PMPoint & point,
const PMRect & rect = kEmptyRect 
) const
pure virtual

Can we select backmost item item based on current item(s) selection?

Parameters
view- Control View that the point and rect are in
replaceOrAdd- Selection::kReplace or Selection::kAddTo
thePoint- point in pasteboard coordinates to use for selecting, kInvalidPoint to ignore
rect- rect in pb coordinates to use for selecting, kEmptyRect to ignore
Returns
bool16 - kTrue if action is enabled, kFalse if disabled
virtual bool16 IZOrderSelectionSuite::CanSelectBackward (IControlView * view,
Selection::Action replaceOrAdd,
const PMPoint & point,
const PMRect & rect = kEmptyRect 
) const
pure virtual

Can we select backward an item based on current item(s) selection?

Parameters
view- Control View that the point and rect are in
replaceOrAdd- Selection::kReplace or Selection::kAddTo
thePoint- point in pasteboard coordinates to use for selecting, kInvalidPoint to ignore
rect- rect in pb coordinates to use for selecting, kEmptyRect to ignore
Returns
bool16 - kTrue if action is enabled, kFalse if disabled
virtual bool16 IZOrderSelectionSuite::CanSelectChild (IControlView * view) const
pure virtual

Can we select child content based on current item(s) selection?

Parameters
view- Control View to use
Returns
bool16 - kTrue if action is enabled, kFalse if disabled
virtual bool16 IZOrderSelectionSuite::CanSelectForward (IControlView * view,
Selection::Action replaceOrAdd,
const PMPoint & point,
const PMRect & rect = kEmptyRect 
) const
pure virtual

Can we select forward an item based on current item(s) selection?

Parameters
view- Control View that the point and rect are in
replaceOrAdd- Selection::kReplace or Selection::kAddTo
thePoint- point in pasteboard coordinates to use for selecting, kInvalidPoint to ignore
rect- rect in pb coordinates to use for selecting, kEmptyRect to ignore
Returns
bool16 - kTrue if action is enabled, kFalse if disabled
virtual bool16 IZOrderSelectionSuite::CanSelectFront (IControlView * view,
Selection::Action replaceOrAdd,
const PMPoint & point,
const PMRect & rect = kEmptyRect 
) const
pure virtual

Can we select frontmost item item based on current item(s) selection?

Parameters
view- Control View that the point and rect are in
replaceOrAdd- Selection::kReplace or Selection::kAddTo
thePoint- point in pasteboard coordinates to use for selecting, kInvalidPoint to ignore
rect- rect in pb coordinates to use for selecting, kEmptyRect to ignore
Returns
bool16 - kTrue if action is enabled, kFalse if disabled
virtual bool16 IZOrderSelectionSuite::CanSelectParent (IControlView * view) const
pure virtual

Can we select parent based on current item(s) selection?

Parameters
view- Control View to use
Returns
bool16 - kTrue if action is enabled, kFalse if disabled
virtual bool16 IZOrderSelectionSuite::CanSelectSibling (IControlView * view,
SelectDirection direction 
) const
pure virtual

Can we select a sibling item based on current item selection? (selection of length 0 or 1). This is a select next/previous operation at a particular level of the hierarchy.

Parameters
view- Control View to use
direction- Select either to the left or the right of current selection.
Returns
bool16 - kTrue if action is enabled, kFalse if disabled
virtual ErrorCode IZOrderSelectionSuite::SelectBack (IControlView * view,
Selection::Action replaceOrAdd,
const PMPoint & point,
const PMRect & rect = kEmptyRect 
) const
pure virtual

Select backmost item item based on current item(s) selection. If no items selected, select backmost item in hierarchy. If the point is not kInvalidMousePoint, use only selected items intesecting this point, not all selected items.

Parameters
view- Control View that the point and rect are in
replaceOrAdd- Selection::kReplace or Selection::kAddTo
thePoint- point in pasteboard coordinates to use for selecting, kInvalidPoint to ignore
rect- rect in pb coordinates to use for selecting, kEmptyRect to ignore
Returns
ErrorCode - Did this succeed?
virtual ErrorCode IZOrderSelectionSuite::SelectBackward (IControlView * view,
Selection::Action replaceOrAdd,
const PMPoint & point,
const PMRect & rect = kEmptyRect 
) const
pure virtual

Select backward an item based on current item(s) selection. If no items selected, select backmost item in hierarchy. If the point is not kInvalidMousePoint, use only selected items intesecting this point, not all selected items.

Parameters
view- Control View that the point and rect are in
replaceOrAdd- Selection::kReplace or Selection::kAddTo
thePoint- point in pasteboard coordinates to use for selecting, kInvalidPoint to ignore
rect- rect in pb coordinates to use for selecting, kEmptyRect to ignore
Returns
ErrorCode - Did this succeed?
virtual ErrorCode IZOrderSelectionSuite::SelectChild (IControlView * view) const
pure virtual

Select child content of selection. Always does a Selection::kReplace.

Parameters
view- Control View that the point and rect are in
Returns
ErrorCode - Did this succeed?
virtual ErrorCode IZOrderSelectionSuite::SelectForward (IControlView * view,
Selection::Action replaceOrAdd,
const PMPoint & point,
const PMRect & rect = kEmptyRect 
) const
pure virtual

Select forward an item based on current item(s) selection. If no items selected, select frontmost item in hierarchy. If the point is not kInvalidMousePoint, use only selected items intesecting this point, not all selected items.

Parameters
view- Control View that the point and rect are in
replaceOrAdd- Selection::kReplace or Selection::kAddTo
thePoint- point in pasteboard coordinates to use for selecting, kInvalidPoint to ignore
rect- rect in pb coordinates to use for selecting, kEmptyRect to ignore
Returns
ErrorCode - Did this succeed?
virtual ErrorCode IZOrderSelectionSuite::SelectFront (IControlView * view,
Selection::Action replaceOrAdd,
const PMPoint & point,
const PMRect & rect = kEmptyRect 
) const
pure virtual

Select frontmost item item based on current item(s) selection. If no items selected, select frontmost item in hierarchy. If the point is not kInvalidMousePoint, use only selected items intesecting this point, not all selected items.

Parameters
view- Control View that the point and rect are in
replaceOrAdd- Selection::kReplace or Selection::kAddTo
thePoint- point in pasteboard coordinates to use for selecting, kInvalidPoint to ignore
rect- rect in pb coordinates to use for selecting, kEmptyRect to ignore
Returns
ErrorCode - Did this succeed?
virtual ErrorCode IZOrderSelectionSuite::SelectParent (IControlView * view) const
pure virtual

Select parent of selection. Always does a Selection::kReplace.

Parameters
view- Control View that the point and rect are in
Returns
ErrorCode - Did this succeed?
virtual ErrorCode IZOrderSelectionSuite::SelectSibling (IControlView * view,
SelectDirection direction 
) const
pure virtual

Select a sibling item of current selection (of length 0 or 1). This is a select next/previous operation at a particular level of the hierarchy.

Parameters
view- Control View to use
direction- Select either to the left or the right of current selection.
Returns
ErrorCode - Did this succeed?
See Also
SelectDirection enum