IHidTxtModel.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $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.
// 
//========================================================================================

#ifndef __IHIDTXTMODEL__
#define __IHIDTXTMODEL__

#include "IPMUnknown.h"
#include "HidTxtID.h"

class ITextModel;

class IHidTxtModel : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IHIDTXTMODEL };

 // Methods in this section can be called by any client.
 public:
 virtual ITextModel* QueryTextModel() const = 0;
 
 virtual bool16 GetAnchorTextRange(TextIndex& start, int32& span) const = 0;
 
 virtual bool16 GetHiddenTextRange(TextIndex& start, int32& span) const = 0;

 // Methods in this section can by called by commands that
 // manipulate the hidden text model or by implementations
 // that form part of the hidden text model.
 public:
 virtual ErrorCode AttachToTextModel(UID textModelUID, const TextIndex& anchorTextIndex) = 0;

 virtual ErrorCode DetachFromTextModel() = 0;
 
 virtual bool16 GetConnectedToTextContent() const = 0;
 
 virtual void SetConnectedToTextContent(bool16 connected) = 0;
}; 

#endif // __IHIDTXTMODEL__