TextRange.h

//========================================================================================
// 
// $File$
// 
// Owner: zwilliam
// 
// $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.
// 
// 
// Purpose:
// 
//========================================================================================

#ifndef __TextRange__
#define __TextRange__


#include "ITextModel.h"
#include "ITextFocus.h"
#include "RangeData.h"
#include "UIDRef.h"

namespace InDesign {


class TextRange
{
 public:
 typedef object_type data_type;

 TextRange() : fRange(0, RangeData::kLeanForward), fValid(kFalse)
 {}

 explicit TextRange(const ITextFocus * focus);

 TextRange(ITextModel * model, TextIndex start, int32 length, RangeData::Lean lean = RangeData::kLeanForward);
 TextRange(const UIDRef& modelRef, TextIndex start, int32 length, RangeData::Lean lean = RangeData::kLeanForward);
 TextRange(ITextModel * model, const RangeData& range);

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

 ITextModel * QueryModel() const;
 UIDRef GetModelRef() const
 { return fModel; }

 TextIndex Start() const
 { return fValid ? fRange.Start(nil) : kInvalidTextIndex; }
 int32 Length() const
 { return fValid ? fRange.Length() : 0; }
 TextIndex End() const
 { return fValid ? fRange.End() : kInvalidTextIndex; } // One off the end

 bool16 IsValid() const
 { return fValid && fModel != nil; }

 const RangeData& GetRange() const
 { return fRange; }

 private:
 UIDRef fModel;
 RangeData fRange;
 bool16 fValid;
};

}

#endif