ITextMiscellanySuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Martz
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Note:
// 
//========================================================================================

#ifndef _ITextMiscellanySuite_
#define _ITextMiscellanySuite_

#include "IPMUnknown.h"
#include "TextEditorModelID.h"
#include "CTextEnum.h"
#include "BravoForwardDecl.h" // for kDontKnowScript

class WideString;
class IPMFont;
class GraphicsData;
class IControlView;
class IActiveContext;

class ITextMiscellanySuite : public IPMUnknown
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_ITEXTMISCELLANYSUITE };

 //____________________________________________________________________________________________
 // Member functions
 //____________________________________________________________________________________________
 public:
 //________________________________________________________________________________________
 // DESCR: Should the "Fill with Placeholder text" function be enabled for the
 // selection.
 //
 // RETURNS: kTrue / kFalse
 //________________________________________________________________________________________
 virtual bool16 CanFillWithPlaceHolderText (void) const = 0;

 //________________________________________________________________________________________
 // DESCR: Process commands in a sequence which fill with placeholder text those
 // items in the selection.
 //
 // RETURNS: Error code.
 //________________________________________________________________________________________
 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;

 // Determine the typing range based on the selection and special character, and set RangeData on the global workspace
 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;

 typedef enum { kNextFrame, kPreviousFrame, kFirstFrame, kLastFrame } WhichOtherFrame;

 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;

 enum HintForInsertionPoint
 { 
 kDontLook, 
 kLookBack, 
 kLookForward
 };

 virtual bool16 IsHiddenTextInSelection(HintForInsertionPoint hint = kDontLook) = 0;
 };

#endif // _ITextMiscellanySuite_