TextAttributeRunIterator.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 __TextAttributeRunIterator__
#define __TextAttributeRunIterator__

#include "TextRange.h"
#include "K2Vector.h"
#include "AttributeBossList.h"
#include "K2SmartPtr.h"

class TextAttributeRunIterator
{
 public:
 TextAttributeRunIterator(K2Vector<InDesign::TextRange>::const_iterator firstRange,
 K2Vector<InDesign::TextRange>::const_iterator endOfRanges,
 K2Vector<ClassID>::const_iterator firstAttributeClass,
 K2Vector<ClassID>::const_iterator endOfAttributeClasses);

 TextAttributeRunIterator(const TextAttributeRunIterator& other)
 : fCurrentRange(other.fCurrentRange),
 fEndOfRanges(other.fEndOfRanges),
 fRunStart(other.fRunStart),
 fRunEnd(other.fRunEnd),
 fFirstClass(other.fFirstClass),
 fEndOfClasses(other.fEndOfClasses),
 fAttributes(other.fAttributes)
 {}

 ~TextAttributeRunIterator()
 {}

 const AttributeBossList& operator * () const;
 
 const AttributeBossList * operator -> () const;

 TextAttributeRunIterator& operator ++ ();

 bool16 operator < (const TextAttributeRunIterator& other) const
 {
 if (fCurrentRange < other.fCurrentRange)
 return kTrue;

 if (fCurrentRange > other.fCurrentRange)
 return kFalse;

 // Both iterators are in the same range of the same text model.
 if (fRunStart < other.fRunStart)
 return kTrue;

 return kFalse;
 }

 operator bool()
 { return fCurrentRange < fEndOfRanges; }

 ErrorCode ApplyAttributes(const boost::shared_ptr<AttributeBossList>& attributes, const ClassID& which = kCharAttrStrandBoss);
 
 ErrorCode ApplyAttribute(IPMUnknown * attribute, const ClassID& which = kCharAttrStrandBoss);

 RangeData GetRunRange() const
 { return RangeData( fRunStart, fRunEnd, RangeData::kLeanForward);}
 
 private:
 void UpdateRunEnd(bool16 calledFromConstructor);

 K2Vector<InDesign::TextRange>::const_iterator fCurrentRange;
 K2Vector<InDesign::TextRange>::const_iterator fEndOfRanges;

 TextIndex fRunStart;
 TextIndex fRunEnd;

 K2Vector<ClassID>::const_iterator fFirstClass;
 K2Vector<ClassID>::const_iterator fEndOfClasses;

 AttributeBossList fAttributes;
};

#endif