IPasteboardUtils Class Reference

#include <IPasteboardUtils.h>

Inheritance diagram for IPasteboardUtils:

Public Types
enum	{ kDefaultIID = IID_IPASTEBOARDUTILS }

Public Member Functions
virtual ISpread *	QuerySpread (IHierarchy *item) const =0
virtual ISpread *	QuerySpread (IHierarchy *item, const ScriptInfo::RequestContext &context, bool16 useLastFrameIfOverset=kFalse) const =0
virtual ISpread *	QuerySpread (IControlView *layoutView, const PBPMPoint &location) const =0
virtual ISpread *	QuerySpread (IControlView *layoutView, const PMReal &location, bool16 horizontal) const =0
virtual ISpread *	QueryNearestSpread (IControlView *layoutView, const PBPMPoint &location) 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

This interface contains pasteboard related utility functions.

For example,

Utils<IPasteboardUtils>()->QuerySpread( ... );

Member Enumeration Documentation

anonymous enum

Define the default IID for IPasteboardUtils.

Member Function Documentation

virtual ISpread* IPasteboardUtils::QueryNearestSpread ( IControlView *  layoutView, const PBPMPoint &  location  ) const

pure virtual

Query the closest spread to the indicated location in the view. It's biased towards vertical measurements, i.e. it finds the spread closest to the vertical component of the location. If there is at least one spread then it will be returned even if the point is in the floor area The caller should deference the return interface.

Parameters

layoutView	the given layout view, one of the condition for querying spread.
location	the given location, one of the condition for querying spread.

Returns

ISpread* spread that satisfies the given conditions.

virtual ISpread* IPasteboardUtils::QuerySpread ( IHierarchy *  item ) const

pure virtual

Query the spread containing a particular item. The caller should deference the return interface.

Parameters

item	the condition for querying spread.

Returns

ISpread* that contains the given item.

virtual ISpread* IPasteboardUtils::QuerySpread ( IHierarchy *  item, const ScriptInfo::RequestContext &  context, bool16  useLastFrameIfOverset = kFalse  ) const

pure virtual

For script provider implementations (

See Also

CScriptProvider): Query the spread on which a page item rests. Forces recompose first for inline page items.

Parameters

page	item for which to get the spread
context	is the script request context
useLastFrameIfOverset	if kTrue and item is an inline object in overset text, return the spread for the last frame in the text's story (instead of nil)

Returns

spread that contains the given item

virtual ISpread* IPasteboardUtils::QuerySpread ( IControlView *  layoutView, const PBPMPoint &  location  ) const

pure virtual

Query the spread containing the particular location in the view. The caller should deference the return interface.

Parameters

layoutView	the given layout view, one of the condition for querying spread.
location	the given location, one of the condition for querying spread.

Returns

ISpread* spread that satisfies the given conditions. May return nil for points outside any spread (e.g. no man's land gray area)

virtual ISpread* IPasteboardUtils::QuerySpread ( IControlView *  layoutView, const PMReal &  location, bool16  horizontal  ) const

pure virtual

Query the spread with the particular coordinate in a horizontal or vertical direction in the view. The caller should deference the return interface.

Parameters

layoutView	the given layout view, one of the condition for querying spread.
location	the given location, one of the condition for querying spread.
horizontal	the given direction, one of the condition for querying spread.

Returns

ISpread* spread that satisfies the given conditions. May return nil for points outside any spread (e.g. no man's land gray area)