#include <ITextMacroList.h>

Inheritance diagram for ITextMacroList:

Public Types
enum	{ kDefaultIID = IID_ITEXTMACROLIST }

Public Member Functions
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

virtual void	UpdateMacroShortcut (PMString key, VirtualKey vKey, int16 mods)=0

virtual bool16	GetAutoExpand () const =0

virtual void	SetAutoExpand (const bool16 expand)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Interface responsible for manipulating the macro keys and their associated text Information is saved to a separate file in the Prefs directory

Member Function Documentation

virtual void ITextMacroList::AddMacro	(	PMString	key,
		PMString	fullString
	)

pure virtual

These are for direct non-command access Add a macro that is just a string

virtual void ITextMacroList::AddMacro	(	PMString	key,
		UIDRef	otherModel,
		TextIndex	start,
		int32	length
	)

pure virtual

Add a macro from another textmodel

virtual void ITextMacroList::AddMacro	(	PMString	key,
		const boost::shared_ptr< PasteData > &	vosData
	)

pure virtual

Add a macro from another textmodel (using PasteData)

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

pure virtual

Seems to be the only way to hook up the dialog's writing widget with a macro This most likely never needs to be called by anybody for data reasons, this is only to set up the UI

virtual ActionID ITextMacroList::GetActionAt ( PMString key )

pure virtual

Returns the action associated with this key

virtual bool16 ITextMacroList::GetAutoExpand ( ) const

pure virtual

These are getting and setting the auto expand flag

virtual boost::shared_ptr<PasteData> ITextMacroList::GetMacroBinding ( PMString key )

pure virtual

Get the data for this text macro - caller must delete return saved data

virtual PMString ITextMacroList::GetStringMacroBinding ( PMString key )

pure virtual

Get a string representation (for tool tips, non-styled inserting, etc)

virtual bool16 ITextMacroList::IsStyledMacroInsert ( PMString key )

pure virtual

Use these methods to get and set whether the macro should be inserted with or without style information

virtual void ITextMacroList::LoadMacros ( UID storageUID = kInvalidUID )

pure virtual

These are for loading and unloading the private storage (if applicable)

virtual void ITextMacroList::ProcessAddMacro	(	PMString	key,
		PMString	fullString
	)

pure virtual

Use these to modify the macros - will create commands

Parameters

key	specifies name of new macro

virtual void ITextMacroList::ReplaceMacro	(	PMString	oldKey,
		PMString	newKey,
		PMString	fullString
	)

pure virtual

Replace a macro that is just a string

virtual void ITextMacroList::ReplaceMacro	(	PMString	oldKey,
		PMString	newKey,
		UIDRef	otherModel,
		TextIndex	start,
		int32	length
	)

pure virtual

Replace a macro from another textmodel

virtual void ITextMacroList::ReplaceMacro	(	PMString	oldKey,
		PMString	newKey,
		const boost::shared_ptr< PasteData > &	vosData
	)

pure virtual

Replace a macro from another textmodel (using PasteData)

virtual void ITextMacroList::SetMacroAction	(	PMString	key,
		ActionID	actionID
	)

pure virtual

Add an actionID to this macro, so it can be executed with it's own key command Send kInvalidActionID to remove an action from this key

Public Types

Public Member Functions

Detailed Description

Member Function Documentation