ISelectionUtils Class Reference

#include <ISelectionUtils.h>

Inheritance diagram for ISelectionUtils:

Public Types
enum	{ kDefaultIID = IID_ISELECTIONUTILS }

Public Member Functions
virtual ISelectionManager *	GetActiveSelection (void)=0
virtual ISelectionManager *	QueryActiveSelection (void)=0
virtual IPMUnknown *	QuerySuite (const PMIID &, ISelectionManager *selectionManager=nil)=0
virtual IDocument *	QueryDocument (IDataBase *)=0
virtual ITextSelectionSuite *	QueryTextSelectionSuite (ISelectionManager *iSelectionManager)=0
virtual ITextSelectionSuite *	QueryActiveTextSelectionSuite (void)=0
virtual ITableSelectionSuite *	QueryTableSelectionSuite (ISelectionManager *iSelectionManager)=0
virtual ITableSelectionSuite *	QueryActiveTableSelectionSuite (void)=0
virtual ILayoutSelectionSuite *	QueryLayoutSelectionSuite (ISelectionManager *iSelectionManager)=0
virtual ILayoutSelectionSuite *	QueryActiveLayoutSelectionSuite (void)=0
virtual IPathSelectionSuite *	QueryPathSelectionSuite (ISelectionManager *iSelectionManager)=0
virtual IPathSelectionSuite *	QueryActivePathSelectionSuite (void)=0
virtual ILayoutHitTestSuite *	QueryLayoutHitTestSuite (ISelectionManager *iSelectionManager)=0
virtual ILayoutHitTestSuite *	QueryActiveLayoutHitTestSuite (void)=0
virtual IPageHitTestSuite *	QueryPageHitTestSuite (ISelectionManager *iSelectionManager)=0
virtual ISelectionManager *	QueryOwnerSelectionManager (const UIDRef &selectionOwnerRef)=0
virtual ISelectionManager *	QueryViewSelectionManager (const IPMUnknown *that)=0
virtual IActiveContext *	ActivateView (IPMUnknown *view) const =0
virtual IWindow *	QuerySelectionManagerOwnerWindow (const UIDRef &selectionOwner) const =0
virtual bool16	IsWithinActivatedView (IPMUnknown *view) 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

Utility methods related to selection.

Utils<IPathPointUtils>()->CopyObjects(...) ;

Member Function Documentation

virtual IActiveContext* ISelectionUtils::ActivateView ( IPMUnknown *  view ) const

pure virtual

Given an interface pointer will compare the context selection to the view selection. If the two do not match the Active selection will be changed to reflect the given view selection.

Returns

void

virtual ISelectionManager* ISelectionUtils::GetActiveSelection ( void  )

pure virtual

Get the abstract selection manager out of the active context and return it to the caller. The reference count is NOT incremented.

Returns

ISelectionManager* or nil

virtual bool16 ISelectionUtils::IsWithinActivatedView ( IPMUnknown *  view ) const

pure virtual

Given an interface pointer will determine if it lies within the hierarchy of the active selection of the window/presentation. Use for determining if a view in a presentation is the "active" from a selection point of view. e.g. LayoutPresentations may have structure, layout, and a split layout view all visible at once, but only one is active.

Returns

bool16 kTrue if view is part of the active selection for this presentation, kFalse otherwise.

virtual ILayoutHitTestSuite* ISelectionUtils::QueryActiveLayoutHitTestSuite ( void  )

pure virtual

Query the layout hit test suite from the active selection manager. The reference count is incremented. The caller is responsible for calling Release().

Returns

ILayoutHitTestSuite* or nil

virtual ILayoutSelectionSuite* ISelectionUtils::QueryActiveLayoutSelectionSuite ( void  )

pure virtual

Query the layout selection suite from the active selection manager. The reference count is incremented. The caller is responsible for calling Release().

Returns

ILayoutSelectionSuite* or nil

virtual IPathSelectionSuite* ISelectionUtils::QueryActivePathSelectionSuite ( void  )

pure virtual

Query the path selection suite from the active selection manager. The reference count is incremented. The caller is responsible for calling Release().

Returns

IPathSelectionSuite* or nil

virtual ISelectionManager* ISelectionUtils::QueryActiveSelection ( void  )

pure virtual

Query the abstract selection manager out of the active context and return it to the caller. The reference count is incremented. The caller is responsible for calling Release().

Returns

ISelectionManager* or nil

virtual ITableSelectionSuite* ISelectionUtils::QueryActiveTableSelectionSuite ( void  )

pure virtual

Query the table selection suite from the active selection manager. The reference count is incremented. The caller is responsible for calling Release().

Returns

ITableSelectionSuite* or nil

virtual ITextSelectionSuite* ISelectionUtils::QueryActiveTextSelectionSuite ( void  )

pure virtual

Query the text selection suite from the active selection manager. The reference count is incremented. The caller is responsible for calling Release().

Returns

ITextSelectionSuite* or nil

virtual IDocument* ISelectionUtils::QueryDocument ( IDataBase *  )

pure virtual

Given a database, return a document if possible. The reference count is incremented. The caller is responsible for calling Release().

Returns

IDocument* or nil

virtual ILayoutHitTestSuite* ISelectionUtils::QueryLayoutHitTestSuite ( ISelectionManager *  iSelectionManager )

pure virtual

Query the layout hit test suite from the specified selection manager. The reference count is incremented. The caller is responsible for calling Release().

Returns

ILayoutHitTestSuite* or nil

virtual ILayoutSelectionSuite* ISelectionUtils::QueryLayoutSelectionSuite ( ISelectionManager *  iSelectionManager )

pure virtual

Query the layout selection suite from the specified (selection manager. The reference count is incremented. The caller is responsible for calling Release().

Returns

ILayoutSelectionSuite* or nil

virtual ISelectionManager* ISelectionUtils::QueryOwnerSelectionManager ( const UIDRef &  selectionOwnerRef )

pure virtual

Given an UIDRef, returns its abstract selection, ISelectionManager. The UIDRef could be either a workspace selection or a view selection. The reference count is incremented. The caller is responsible for calling Release().

Returns

ISelectionManager*, or nil

virtual IPageHitTestSuite* ISelectionUtils::QueryPageHitTestSuite ( ISelectionManager *  iSelectionManager )

pure virtual

Query the page hit test suite from the specified selection manager. The reference count is incremented. The caller is responsible for calling Release().

Returns

IPageHitTestSuite* or nil

virtual IPathSelectionSuite* ISelectionUtils::QueryPathSelectionSuite ( ISelectionManager *  iSelectionManager )

pure virtual

Query the path selection suite from the specified selection manager. The reference count is incremented. The caller is responsible for calling Release().

Returns

IPathSelectionSuite* or nil

virtual IPMUnknown* ISelectionUtils::QuerySuite ( const PMIID &  , ISelectionManager *  selectionManager = nil  )

pure virtual

Query a suite on the abstract selection boss. The reference count is incremented. The caller is responsible for calling Release().

Returns

IPMUnknown* or nil

virtual ITableSelectionSuite* ISelectionUtils::QueryTableSelectionSuite ( ISelectionManager *  iSelectionManager )

pure virtual

Query the table selection suite from the specified selection manager. The reference count is incremented. The caller is responsible for calling Release().

Returns

ITableSelectionSuite* or nil

virtual ITextSelectionSuite* ISelectionUtils::QueryTextSelectionSuite ( ISelectionManager *  iSelectionManager )

pure virtual

Query the text selection suite from the specified selection manager. The reference count is incremented. The caller is responsible for calling Release().

Returns

ITextSelectionSuite* or nil

virtual ISelectionManager* ISelectionUtils::QueryViewSelectionManager ( const IPMUnknown *  that )

pure virtual

Given an IPMUnknown, returns its abstract selection, ISelectionManager. The IPMUnknown could be either a workspace selection or a view selection. The reference count is incremented. The caller is responsible for calling Release().

Returns

ISelectionManager*, or nil