ITextMacroList.h

//========================================================================================
// 
// $File$
// 
// Owner: mramme
// 
// $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 __ITextMacroList__
#define __ITextMacroList__

#include "PMString.h"
#include "EditorHelperID.h"
#include "VirtualKey.h"
#include "K2SmartPtr.h"
#include "VOSSavedData.h"

class IControlView;

struct MacroAttribs
{
 typedef base_type data_type;
 int32 fAccessNum;
 bool16 fStyled;

 // We need to stash the Shortcut if there is one - lets just say this is a pain in the rump...
 VirtualKey fVKey;
 int16 fMods;
 
 bool16 operator==(const MacroAttribs&) const;
};


class ITextMacroList : public IPMUnknown
{

public:

 enum {kDefaultIID = IID_ITEXTMACROLIST};

 virtual void ProcessAddMacro(PMString key, PMString fullString) = 0;
 virtual void ProcessAddMacro(PMString key, UIDRef otherModel, TextIndex start, int32 length) = 0;
 virtual void ProcessAddMacro(PMString key, const boost::shared_ptr<PasteData>& vosData) = 0;
 virtual void ProcessRemoveMacro(PMString key) = 0;
 virtual void ProcessReplaceMacro(PMString oldKey, PMString newKey, PMString fullString) = 0;
 virtual void ProcessReplaceMacro(PMString oldKey, PMString newKey, UIDRef otherModel, TextIndex start, int32 length) = 0;
 virtual void ProcessSetMacroAction(PMString key, VirtualKey vKey, int16 mods) = 0;

 virtual void AddMacro(PMString key, PMString fullString) = 0;
 virtual void AddMacro(PMString key, UIDRef otherModel, TextIndex start, int32 length) = 0;
 virtual void AddMacro(PMString key, const boost::shared_ptr<PasteData>& vosData) = 0;
 virtual void ReplaceMacro(PMString oldKey, PMString newKey, PMString fullString) = 0;
 virtual void ReplaceMacro(PMString oldKey, PMString newKey, UIDRef otherModel, TextIndex start, int32 length) = 0;
 virtual void ReplaceMacro(PMString oldKey, PMString newKey, const boost::shared_ptr<PasteData>&vosData) = 0;
 virtual void RemoveMacro(PMString key) = 0;

 virtual void SetMacroAction(PMString key, ActionID actionID) = 0;

 virtual bool16 IsMacro(PMString key) = 0;

 virtual bool16 IsStyledMacroInsert(PMString key) = 0;
 virtual void SetStyledMacroInsert(PMString key, bool16 bStyled) = 0;

 virtual boost::shared_ptr<PasteData> GetMacroBinding(PMString key) = 0;
 virtual boost::shared_ptr<PasteData> GetMacroAt(int32 pos) = 0;
 virtual boost::shared_ptr<PasteData> GetMacroAtAction(ActionID actionID) = 0;
 virtual PMString GetStringMacroBinding(PMString key) = 0;
 virtual PMString GetStringMacroAt(int32 pos) = 0;
 virtual PMString GetStringMacroAtAction(ActionID actionID) = 0;

 virtual PMString GetKeyAt(int32 pos) = 0;
 virtual int32 GetKeyPos(PMString key) = 0;

 virtual ActionID GetActionAt(PMString key) = 0;
 virtual int32 GetActionPos(ActionID actionID) = 0;

 virtual int32 GetNumMacros() = 0;
 
 virtual void LoadMacros(UID storageUID = kInvalidUID) = 0;
 virtual void UnloadMacros() = 0;

 virtual bool16 AttachMacroToEditor(PMString macro, IControlView *editWidget, const boost::shared_ptr<PasteData>& selectedText) = 0;

 // NOTE: Never use this - I tried to make this protected, but the compiler whines...
 virtual void UpdateMacroShortcut(PMString key, VirtualKey vKey, int16 mods) = 0;

 virtual bool16 GetAutoExpand() const = 0;
 virtual void SetAutoExpand(const bool16 expand) = 0;
};

#endif