ITextScriptUtils.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 __ITextScriptUtils__
#define __ITextScriptUtils__

#include "K2SmartPtr.h"
#include "RangeData.h"
#include "ScriptData.h"
#include "ShuksanID.h"
#include "TextID.h"
#include "Utils.h"
#include "IPMFont.h"
#include "IAnchoredObjectData.h"

class ITextModel;
class ITableModel;
class IDocument ;
class IStyleInfo;
class ICommand;
class IScript;
class IAttrReport;
class AttributeBossList;
class IStyleNameTable;
class IHierarchy;
class IScriptCellRef;
class WideString;
class GridAddress;
class RangeData;
class IFontFamily;
class ITextTarget;
class IScriptRequestData;
class ITextFrameColumn;
class ITextVariable;
class ITextVariableTable;

typedef boost::shared_ptr<AttributeBossList> AddAttributeList ;
typedef K2Vector<ClassID> RemoveAttributeList ;

class ITextScriptUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITEXTSCRIPTUTILS };

 virtual ScriptID GetTextType( IScript* script ) = 0;

 virtual IScript* QueryTextObject( const RequestContext& context, ITextModel* model, const RangeData& range, const ScriptID& type = kInvalidScriptID ) = 0;

 virtual ICommand* CreateEditFindChangePrefCmd( const ScriptID& propID,
 IDataBase* targetDB,
 const IPMUnknown* addAttribute = nil,
 ClassID removeAttribute = kInvalidClass ) = 0;

 virtual ICommand* CreateEditFindChangePrefCmd( const ScriptID& propID,
 IDataBase* targetDB,
 const AddAttributeList& addAttrList,
 const RemoveAttributeList& removeAttrList ) = 0;

 virtual ICommand* CreateEditFindChangePrefCmd( const ScriptID& propID,
 const ScriptID& objectType,
 IDataBase* targetDB,
 const UID& styleUID ) = 0 ;

 virtual ITextModel* QueryTextModel(IScript* script) = 0;


 virtual bool16 IsTextFrame( const IScript* script, const RequestContext& context ) = 0;

 virtual IPMUnknown* QueryFirstTextFrame ( const IPMUnknown* gframe, PMIID iid = IID_IUNKNOWN ) const = 0;

 virtual IPMUnknown* QueryLastTextFrame ( const IPMUnknown* gframe, PMIID iid = IID_IUNKNOWN ) const = 0;

 virtual IPMUnknown* QueryGraphicFrame( const IPMUnknown* tframe, PMIID iid = IID_IUNKNOWN ) const = 0;

 virtual IPMUnknown* QueryChildMultiColFrame( const IPMUnknown* gframe, PMIID iid = IID_IUNKNOWN ) const = 0;

 virtual IPMUnknown* QueryFirstChildTextFrame( const IPMUnknown* mcframe, PMIID iid = IID_IUNKNOWN ) const = 0;

 virtual IPMUnknown* QueryLastChildTextFrame( const IPMUnknown* mcframe, PMIID iid = IID_IUNKNOWN ) const = 0;

 virtual IPMUnknown* QueryParentMultiColFrame( const IPMUnknown* tframe, PMIID iid = IID_IUNKNOWN ) const = 0;

 virtual IPMUnknown* QueryParentGraphicFrame( const IPMUnknown* mcframe, PMIID iid = IID_IUNKNOWN ) const = 0;

 virtual ITextFrameColumn* QueryTextFrameColumnContaining( ITextModel* textModel, TextIndex index, bool16 ifNoneReturnLastFrame = kFalse ) = 0;

 virtual ErrorCode GetParentTextFrames( IScript* script, ScriptList& parentList ) = 0;

 virtual IScript* QueryParentTextFrame( IScript* textTarget ) = 0;

 virtual IPMUnknown* QueryParentTextFrame( const ITextModel* textModel, TextIndex index, PMIID iid = IID_IUNKNOWN ) = 0;

 virtual ErrorCode Recompose( IScript* script ) = 0;

 virtual bool16 DefaultIsWordChar( const UTF32TextChar& aStart, const UTF32TextChar& aEnd ) = 0;
 virtual bool16 TestIsSpace( const UTF32TextChar& aStart, const UTF32TextChar& aEnd ) = 0;
 virtual bool16 TestIsPunctuation( const UTF32TextChar& aStart, const UTF32TextChar& aEnd ) = 0;

 virtual bool16 AreTextRunAttributesEqual( ITextModel* model1, TextIndex start1, ITextModel* model2, TextIndex start2 ) = 0;

 virtual const IAttrReport* QueryChildTextAttribute( const RequestContext& context, IScript* script, const ScriptID& childType, const ClassID& attrID, AttributeBossList* attrList ) = 0;

 virtual ICommand* QueryChildTextCommand( IScriptRequestData* data, IScript* script, const ScriptID& childType, const IAttrReport* attrReport ) = 0;

 virtual ErrorCode GetFrameStartEnd(const IHierarchy* hierarchy, UIDRef& textModel, TextIndex& frameStart, TextIndex& frameEnd) = 0;

 virtual ErrorCode GetCellStartEnd(const InterfacePtr<ITableModel>& table, GridAddress cellAddress, InterfacePtr<ITextModel>& textModel, TextIndex& cellStart, TextIndex& cellEnd, bool16 includeOverset = kTrue) const = 0;

 virtual ErrorCode ConvertEnumToWideString( const RequestContext& context, const ScriptData& scriptData, WideString& outString ) = 0 ;
 virtual ErrorCode ConvertWideStringToEnum( const RequestContext& context, const WideString& inString, ScriptData& scriptData ) = 0 ;

 virtual ErrorCode GetSpecialChar( IScriptRequestData* data, ScriptData& scriptData, IScript* script, ITextModel* model, TextIndex start, int32 length ) = 0 ;
 virtual ErrorCode SetSpecialChar( IScriptRequestData* data, const ScriptData& scriptData, ITextModel* model, TextIndex start, int32& length ) = 0 ;

 virtual void ExcludeNUACharacters( ITextModel* model, int32& start, int32& length, const RequestContext& context ) const = 0 ;

 virtual void IncludeNUACharacters( ITextModel* model, int32& start, int32& length, const RequestContext& context ) const = 0 ;

 virtual int32 StripNUACharacters( PMString& string, const RequestContext& context ) const = 0 ;

 virtual IPMFont* QueryFont (const RequestContext& context, IScript* script) = 0 ;

 virtual IScript* QueryFontObject( const RequestContext& context, const PMString& familyName, const PMString& styleName, IScript* parent, PMString *psName = nil, IPMFont::FontType fontType = IPMFont::kUnknownFontType ) = 0;

 virtual ErrorCode DeleteText( IScriptRequestData* data, IScript* script ) = 0 ;

 virtual ErrorCode AccessOverset( IScriptRequestData* data, IScript* script, const ScriptID& propID ) = 0 ;

 virtual RangeData GetScriptTextRange( IScript* script ) = 0 ;

 virtual ErrorCode AccessTextContents( IScriptRequestData* data, IScript* script, const ScriptID& propID ) = 0 ;
 virtual ErrorCode AccessFrameTextContents( IScriptRequestData* data, IScript* script, const ScriptID& propID ) = 0 ;

 virtual ErrorCode ReleaseAnchoredObjects(const UIDList& anchors) = 0;

 virtual ErrorCode ConvertCharacterToEnum( const RequestContext& context, const UTF32TextChar inChar, ScriptData& scriptData, ITextModel* model, TextIndex start ) = 0 ;

 /*
 Given a text variable script proxy script object, query the associated text variable table in the object model
 @param script is the proxy object
 @param context is the request context
 @return the text variable table
 */
 virtual ITextVariableTable* QueryTextVariableTableFromScript( const IScript* script, const RequestContext& context ) const = 0 ;
 /*
 Given a text variable script proxy script object, query the associated text variable in the object model
 @param script is the proxy object
 @param context is the request context
 @return the text variable
 */
 virtual ITextVariable* QueryTextVariableFromScript( const IScript* script, const RequestContext& context ) const = 0 ;
 /*
 Given a text variable script proxy script object, return the associated text variable name in the object model
 @param script is the proxy object
 @param context is the request context
 @return the text variable name
 */
 virtual PMString GetTextVariableNameFromScript( const IScript* script, const RequestContext& context ) const = 0 ;

 /*
 Return the text model and text range for the parent of an object being created in text
 @param data is the script event data for the create event IN
 @param parent is the parent for the create event IN
 @param modelRange is the result OUT
 */
 virtual ErrorCode GetModelRangeFromParent( const IScriptRequestData* data, const IScript* parent, const ScriptID& insertionLocation, ModelRange& modelRange ) const = 0 ;

 /*
 Handles scripting support for MultiColumnTextFrame linking/unlinking. Works for
 both regular and TextOnPath.
 */
 virtual ErrorCode AccessLinkedTextFrame(IScriptRequestData* data, const IScript* script, const ScriptID propID) = 0;

 /*
 Convert the passed in pageitem into an anchored object or inline
 @param objectToAnchorUIDRef pageItem to convert. can be inline already.
 @param destStoryUIDRef story to anchor into.
 @param textRange text index to place anchor
 @param anchorPosition inline, aboveline or anchor.
 @return kCannotReAnchorMemberOfGroupError, kRequestNotHandledError or kSuccess
 */
 virtual ErrorCode ConvertToAnchoredObject(UIDRef objectToAnchorUIDRef, UIDRef destStoryUIDRef, const RangeData& textRange, IAnchoredObjectData::AnchoredPosition anchorPosition) const = 0;

 /*
 Return true if it is valid anchor destination
 @param objectToAnchorUIDRef pageItem to anchor. can be inline already.
 @param destStoryUIDRef story to anchor into.
 @param destTextIndex text index to place anchor
 @param anchorPosition inline, aboveline or anchor.
 @return kTrue if valid anchor destination
 */
 virtual bool16 IsValidAnchorDestination(UIDRef objectToAnchorUIDRef, UIDRef destStoryUIDRef, TextIndex destTextIndex, IAnchoredObjectData::AnchoredPosition anchorPosition) const = 0;
};

#endif // __ITextScriptUtils__