ITextEditSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Zak Williamson
// 
// $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.
// 
// 
// Notes:
// 
//========================================================================================

#ifndef __ITextEditSuite__
#define __ITextEditSuite__

#include "IPMUnknown.h"
#include "TextID.h"
#include "CTextEnum.h"
#include "WideString.h"


class ITextEditSuite : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ITEXTEDIT_ISUITE };

 virtual bool16 CanEditText() const = 0;

 virtual ErrorCode InsertCharacter(UTF32TextChar ch) = 0;

 typedef enum { kThisPage, kContinuedFrom, kContinuedOn } PageNumberType;
 virtual ErrorCode InsertPageNumber(PageNumberType pageNumberType) = 0;

 virtual ErrorCode InsertBreakCharacter(Text::StartBreakLocation breakLocation) = 0;

 virtual bool16 CanInsertFootnote() = 0;

 virtual ErrorCode InsertFootnote() = 0;

 virtual bool16 CanConvertVariable(ClassID whichVariableClass = kInvalidClass) const = 0;

 virtual ErrorCode ConvertVariableToText(ClassID whichVariableClass = kInvalidClass) = 0;

 virtual ErrorCode InsertText(const WideString& theText) = 0;

 virtual ErrorCode Delete(CharCounter numChars = 1) = 0;

 virtual ErrorCode ForwardDelete(CharCounter numChars = 1) = 0;

 virtual ErrorCode InsertEndnote() = 0;

 virtual bool16 CanInsertEndnote() = 0;

 virtual bool16 IsTextSelectionInEndnoteStory() = 0;

 virtual bool16 IsInsideEndnoteTextRange() = 0;

 virtual bool16 IsInsideEndnoteAnchor() = 0;

 virtual bool16 GotoEndnoteAnchor() = 0;

 virtual bool16 GotoEndnoteTextRange() = 0;
};

#endif