ITextAttrUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __ITextAttrUtils__
#define __ITextAttrUtils__

#include "TextID.h"
#include "IPMUnknown.h"
#include "IRunInStylesUtils.h"
#include "Utils.h"

#include "BaseType.h"
#include "K2SmartPtr.h"

class IPMUnknown;
class ITextModel;
class ICommand;
class AttributeBossList;
class RangeData;


class ITextAttrUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITEXTATTRUTILS };

 virtual ICommand* BuildApplyTextAttrCmd(ITextModel *model, TextIndex start, uint32 len, const IPMUnknown *attr, const ClassID& which) = 0;


 virtual ICommand* BuildApplyTextAttrCmd(ITextModel *model, const RangeData& range, const IPMUnknown *attr, const ClassID& which) = 0;


 virtual ICommand* BuildApplyTextAttrCmd(ITextModel *model, TextIndex start, uint32 len, const ClassID& which, const boost::shared_ptr<AttributeBossList>& attrList) = 0;


 virtual ICommand* BuildApplyTextAttrCmd(ITextModel *mod, const RangeData& range, const ClassID& which, const boost::shared_ptr<AttributeBossList>& attrList) = 0;


 virtual ICommand* BuildApplyUserTextAttrCmd(ITextModel *mod, TextIndex start, uint32 len, const IPMUnknown *attr, const ClassID& which) = 0;


 virtual ICommand* BuildApplyUserTextAttrCmd(ITextModel *mod, const RangeData& range, const IPMUnknown *attr, const ClassID& which) = 0;


 virtual ICommand* BuildClearTextAttrCmd(ITextModel *mod, TextIndex start, uint32 len, const ClassID& attrClass, const ClassID& which) = 0;


 virtual ICommand* BuildClearTextAttrCmd(ITextModel *mod, const RangeData& range, const ClassID& attrClass, const ClassID& which) = 0;


 // NOTE: It is the responsibility of the caller to ensure that all Text
 // within the range is fully composed as possible BEFORE calling. In
 // practice the top level container, usually the MultiColumnFrame should
 // be the only one required to force composition.
 virtual ErrorCode ProcessScaleTextMeasures( ITextModel *model, TextIndex start, TextIndex endPosition, PMReal xScale, PMReal yScale) = 0;


 virtual void GetTotalAttributesAtIndex( ITextModel * model, TextIndex index, bool16 includeTextState, bool16 leanleft,
 AttributeBossList & results, int32 * start = nil, int32 * end = nil,
 UID * paraStyle = nil, int32 * plen = nil, bool16 * paraStyleOverridden = nil,
 UID * charStyle = nil, int32 * clen = nil, bool16 * charStyleOverridden = nil,
 RunInStyleResult::CharStyleList * nestedStyles = nil, int32 * nestedStyleLen = nil, bool16 * nestedStyleOverridden = nil
 )= 0;
};


#endif // __ITextAttrUtils__