IComposeScanner.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 __IComposeScanner__
#define __IComposeScanner__

#include "IPMUnknown.h"
#include "TextID.h"
#include "K2Vector.h"
#include "PMTextUtils.h"
#include "textiterator.h"
#include "IRunInStylesUtils.h"

class AttributeBossList;
class IDrawingStyle;
class WideString;
class IAttrReport;
class RangeData;

class IComposeScanner : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ICOMPOSESCANNER };

 //-----------------------------------------------------------------------------------------
 virtual TextIndex CopySurroundingWord(TextIndex position, WideString *copy, UID *pLanguageUID = nil, FuncIsWordChar func = nil ) = 0;

 virtual TextIndex CopyText(TextIndex position, int32 length, WideString *copy) const = 0;
 virtual TextIndex CopyText(const RangeData& range, WideString *copy) const = 0;

 //-----------------------------------------------------------------------------------------
 virtual TextIndex FindSurroundingWord(TextIndex position, int32 *length, UID *pLanguageUID = nil, FuncIsWordChar wordFunc = nil ) = 0;
 virtual RangeData FindSurroundingWord(TextIndex position, UID *pLanguageUID = nil, FuncIsWordChar wordFunc = nil ) = 0;

 virtual TextIndex FindSurroundingWordUsingWordCharFuncOnly(TextIndex position, int32 *length, UID *pLanguageUID = nil, FuncIsWordChar wordFunc = nil ) = 0;
 virtual RangeData FindSurroundingWordUsingWordCharFuncOnly(TextIndex position, UID *pLanguageUID = nil, FuncIsWordChar wordFunc = nil ) = 0;

 //-----------------------------------------------------------------------------------------
 virtual TextIndex FindSurroundingParagraph(TextIndex position, int32 *length, bool16 excludeEOS = kTrue, bool16 validatePara = kTrue) const = 0;
 virtual RangeData FindSurroundingParagraph(TextIndex position, bool16 excludeEOS = kTrue, bool16 validatePara = kTrue) const = 0;


 //-----------------------------------------------------------------------------------------
 virtual const IAttrReport* QueryAttributeAt(int32 startPosition, int32 endPosition,
 ClassID typeAttribute, int32 *length = nil, bool16 moveBackwards = kFalse) const = 0;
 virtual const IAttrReport* QueryAttributeAt( const RangeData& range,
 ClassID typeAttribute, int32 *length = nil, bool16 moveBackwards = kFalse) const = 0;

 virtual void QueryAttributeAt(
 int32 startPosition,
 int32 endPosition,
 K2Vector<ClassID>::const_iterator firstAttribute,
 K2Vector<ClassID>::const_iterator endAttribute,
 AttributeBossList* results, // output: AttributeBossList of att
 int32* length = nil, // output: can be nil on input
 bool16 moveBackwards = kFalse
 ) const = 0;

 //-----------------------------------------------------------------------------------------
 virtual IDrawingStyle* GetCompleteStyleAt(TextIndex position, int32 *lenleft = nil) = 0;

 virtual IDrawingStyle* GetParagraphStyleAt(TextIndex position, int32 *lenleft = nil, TextIndex *paragraphStart = nil) = 0;

 virtual const RunInStyleResults& GetRunInStylesResultsAt(TextIndex position, TextIndex *paragraphStart = nil) = 0;

 virtual TextIterator QueryDataAt(TextIndex position, IDrawingStyle **newstyle, int32 *numChars) = 0;

 //-----------------------------------------------------------------------------------------
 virtual void AttributesChanged(TextIndex start, int32 length) = 0;
 virtual void Clear() = 0;

 virtual void StartComposingNestedStyles() = 0;
 virtual void StopComposingNestedStyles() = 0;
};




#endif // __IComposeScanner__