ITextMiscellanySuite Class Reference

Inheritance diagram for ITextMiscellanySuite:

Public Types
enum	{ kDefaultIID = IID_ITEXTMISCELLANYSUITE }
enum	WhichOtherFrame { kNextFrame, kPreviousFrame, kFirstFrame, kLastFrame }
enum	HintForInsertionPoint { kDontLook, kLookBack, kLookForward }

Public Member Functions
virtual bool16	CanFillWithPlaceHolderText (void) const =0
virtual ErrorCode	FillWithPlaceHolderText (int32 script=kDontKnowScript)=0
virtual ErrorCode	GetFirstSelectedWord (PMString &word)=0
virtual ErrorCode	GetSelectedText (WideString &text)=0
virtual ErrorCode	GetGlyphsFromSelection (WideString &theChars, K2Vector< Text::GlyphID > &glyphList, IPMFont **selectedFont=nil)=0
virtual ErrorCode	SetWorkSpaceTypingRangeData (int32 specialCharacter, PMIID interfaceID)=0
virtual ErrorCode	IsSelectionCompletelyOverset (bool16 &result)=0
virtual bool16	CanDrawSelectedFrameEdges ()=0
virtual void	DrawSelectedFrameEdges (GraphicsData *gd)=0
virtual void	GetFrameThreadsBBox (GraphicsData *gd, PMRect &invalRect)=0
virtual bool16	CanSelectAnotherFrame (WhichOtherFrame which)=0
virtual ErrorCode	SelectAnotherFrame (WhichOtherFrame which, IActiveContext *ac)=0
virtual bool16	CanOffscreenWithShape (IPMUnknown *pShape)=0
virtual ErrorCode	IsSelectionInDeletedText (bool16 &result)=0
virtual bool16	IsSafeSelectionForFindFontDialog () const =0
virtual bool16	WantCheckOutOrAlertCant ()=0
virtual bool16	IsHiddenTextInSelection (HintForInsertionPoint hint=kDontLook)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Enumeration Documentation

enum ITextMiscellanySuite::HintForInsertionPoint

Enum for specifying a hint for IsHiddenTextInSelection to use when the selection is an insertion point.

Enumerator
kDontLook	IsHiddenTextInSelection doesn't look back or forward.
kLookBack	IsHiddenTextInSelection looks back.
kLookForward	IsHiddenTextInSelection looks forward.

enum ITextMiscellanySuite::WhichOtherFrame

Values for CanSelectAnotherFrame and SelectAnotherFrame to select various threaded frames in a frame list. kNextFrame selects frame after currently selected frame. kPreviousFrame select frame before currently selected frame. kFirstFrame selects first frame in the frame list of the selection. kLastFrame selects last frame in the frame list of the selection.

Member Function Documentation

virtual bool16 ITextMiscellanySuite::CanDrawSelectedFrameEdges ( )

pure virtual

Returns

result is filled in with kTrue or kFalse to indicate whether the selection supports frame edge drawing

virtual bool16 ITextMiscellanySuite::CanOffscreenWithShape ( IPMUnknown *  pShape )

pure virtual

currently we only do offscreening for shapes that are in the selection

virtual bool16 ITextMiscellanySuite::CanSelectAnotherFrame ( WhichOtherFrame  which )

pure virtual

Can the selection be changed to the appropriate TextFrame relative to the current selection.

Parameters

which,which	frame in the threaded frame list to select, as an WhichOtherFrame value
targetLayer,selection	on source IDocumentLayer will be moved to targetLayer IDocumentLayer.
view,the	IControlView to use.
guideLayerOnly,kTrue	if moving guide layers, kFalse otherwise.
replaceOrAdd	- Selection::kReplace or Selection::kAddTo
bDuplicate,kTrue	to duplicate the selection before moving to the destination layer.

Returns

ErrorCode

virtual void ITextMiscellanySuite::DrawSelectedFrameEdges ( GraphicsData *  gd )

pure virtual

Draws the frame edges

virtual ErrorCode ITextMiscellanySuite::GetFirstSelectedWord ( PMString &  word )

pure virtual

always clears parameter "word" and then copies the first word (according to dictionary code) into the parameter if no selection, word is blank

virtual void ITextMiscellanySuite::GetFrameThreadsBBox ( GraphicsData *  gd, PMRect &  invalRect  )

pure virtual

Places the frame thread bounding box into

Parameters

invalRect

virtual ErrorCode ITextMiscellanySuite::GetGlyphsFromSelection ( WideString &  theChars, K2Vector< Text::GlyphID > &  glyphList, IPMFont **  selectedFont = nil  )

pure virtual

always clears theChars & glyphList puts the characters and the glyphs represented by the selection into the two data structures and can report the INITIAL font as well.

Parameters

theChars	will have the selected characters
glyphList	contains the selected glyphs
selectedFont	(if non-nil) will be set with an add'refed font if all of the characters have the same font, combining glyphs (e.g. ligatures) can produce fewer glyphs than characters.

virtual ErrorCode ITextMiscellanySuite::GetSelectedText ( WideString &  text )

pure virtual

Parameters

text	is overwritten with the currently selected text in this selection. text is set to empty if there's no selection

virtual bool16 ITextMiscellanySuite::IsHiddenTextInSelection ( HintForInsertionPoint  hint = kDontLook )

pure virtual

Detect if the selection contains hidden conditional text. If the selection is a range it is examined for hidden text but if it is an insertion point then use the hint to look back, forward or don't look for the case of backspace versus forward delete versus typing.

Parameters

hint	A hint for detecting hidden text if selection is an insertion point.

Returns

kTrue if found hidden conditional text.

virtual bool16 ITextMiscellanySuite::IsSafeSelectionForFindFontDialog ( ) const

pure virtual

DoesSelectionContainTableAnchors

Returns

true if this selection is one which is valid for the find font dialog to leave when exitting

virtual ErrorCode ITextMiscellanySuite::IsSelectionCompletelyOverset ( bool16 &  result )

pure virtual

Parameters

result

is filled in with kTrue or kFalse to indicate whether the selection is in overset

virtual ErrorCode ITextMiscellanySuite::IsSelectionInDeletedText ( bool16 &  result )

pure virtual

Parameters

result	(in InCopy) is filled in with kTrue or kFalse to indicate whether the selection is in deleted text
result	(in InDesign) is filled in with kFalse because deletions are not accessible in InDesign (yet?)

virtual ErrorCode ITextMiscellanySuite::SelectAnotherFrame ( WhichOtherFrame  which, IActiveContext *  ac  )

pure virtual

Change the selection to the appropriate TextFrame relative to the current selection

Parameters

which,which	frame in the threaded frame list to select, as an WhichOtherFrame value
ac,IActiveContext	to use for the selection action. Typically driven from an ActionComponent.

virtual bool16 ITextMiscellanySuite::WantCheckOutOrAlertCant ( )

pure virtual

Ask the user if they want to check out the story or, InCopy only, alert them that they cannot make edits. IInCopyBridgeUIUtils must be available.

Returns

kTrue if check out was successful