ITextFocusManager.h

//========================================================================================
// 
// $File$
// 
// Owner: Eric Menninga
// 
// $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 __ITextFocusManager__
#define __ITextFocusManager__

#include "IPMUnknown.h"
#include "TextID.h"

//----------------------------------------------------------------------------------------
// Interface ITextFocusManager
//----------------------------------------------------------------------------------------

class ITextFocus;
class RangeData;

class ITextFocusManager : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITEXTFOCUSMANAGER };

 enum FocusUpdateType
 {
 kInvalidUpdateType = 0,
 kInserted,
 kDeleted,
 kAppliedAttrs
 };

 struct FocusUpdateInfo
 {
 typedef base_type data_type;

 FocusUpdateInfo(FocusUpdateType type, TextIndex start, int32 len)
 :fUpdateType(type), fStart(start), fLen(len)
 {}

 bool operator==(const FocusUpdateInfo&) const
 { ASSERT_FAIL("appease K2Vector.Location"); return false; }

 FocusUpdateType fUpdateType;
 TextIndex fStart;
 int32 fLen;
 };

 typedef K2Vector<FocusUpdateInfo> FocusUpdateInfoList;


 virtual ITextFocus* NewFocus( const RangeData& range, ClassID focusClass = kInvalidClass) = 0;

 virtual void AddFocus(ITextFocus* f) = 0;

 virtual void RemoveFocus(ITextFocus* f) = 0;

 virtual int32 GetFocusCount() const = 0;

 virtual ITextFocus * QueryNthFocus( int32 nAt ) = 0;

 virtual void Inserted(TextIndex start, int32 count, bool16 allowNotify = kTrue) = 0;

 virtual void Deleted(TextIndex start, int32 count, bool16 allowNotify = kTrue) = 0;

 virtual void AttributeApplied(TextIndex start, int32 count, bool16 allowNotify = kTrue) = 0;

 virtual void StoryThreadCreated(TextIndex at, int32 len) = 0;

 virtual void Update(const FocusUpdateInfoList& updateInfoList, bool16 allowNotify) = 0;

 virtual void DeRegisterTextFoci() = 0;
};

#endif
 // __ITextFocusManager__