diff options
Diffstat (limited to 'sfx2/inc/macro.hxx')
| -rw-r--r-- | sfx2/inc/macro.hxx | 183 |
1 files changed, 183 insertions, 0 deletions
diff --git a/sfx2/inc/macro.hxx b/sfx2/inc/macro.hxx new file mode 100644 index 000000000000..79af6b7302dc --- /dev/null +++ b/sfx2/inc/macro.hxx @@ -0,0 +1,183 @@ +#ifndef _SFXMACRO_HXX +#define _SFXMACRO_HXX + +//==================================================================== +#include <com/sun/star/beans/PropertyValue.hpp> +#include <com/sun/star/uno/Sequence.hxx> + +#include <tools/string.hxx> + +class SfxSlot; +class SfxShell; +struct SfxMacro_Impl; +class SfxMacro; + +//==================================================================== + +class SfxMacroStatement +{ + USHORT nSlotId; // ausgef"uhrte Slot-Id oder 0, wenn manuell + ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue > aArgs; // aktuelle Parameter, falls nSlotId != 0 + String aStatement; // Statement in BASIC-Syntax (ggf. mit CR/LF) + BOOL bDone; // auskommentieren wenn kein Done() gerufen + void* pDummy; // f"ur alle F"alle zum kompatibel bleiben + +#ifdef _SFXMACRO_HXX +private: + void GenerateNameAndArgs_Impl( SfxMacro *pMacro, + const SfxSlot &rSlot, + BOOL bRequestDone, + ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue >& aArgs ); +#endif + +public: + SfxMacroStatement( const SfxMacroStatement &rOrig ); + + SfxMacroStatement( const String &rTarget, + const SfxSlot &rSlot, + BOOL bRequestDone, + ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue >& aArgs ); + + SfxMacroStatement( const SfxShell &rShell, + const String &rTarget, + BOOL bAbsolute, + const SfxSlot &rSlot, + BOOL bRequestDone, + ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue >& aArgs ); + + SfxMacroStatement( const String &rStatment ); + ~SfxMacroStatement(); + + USHORT GetSlotId() const; + const ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue >& GetArgs() const; + BOOL IsDone() const; + const String& GetStatement() const; +}; + +//-------------------------------------------------------------------- + +inline USHORT SfxMacroStatement::GetSlotId() const + +/* [Beschreibung] + + Liefert die Slot-Id die das Statement beim Abspielen wieder ausf"uhren + soll oder 0, falls das Statement manuell (<SFX_SLOT_RECORDMANUAL>) + aufgezeichnet wurde. +*/ + +{ + return nSlotId; +} + +//-------------------------------------------------------------------- + +inline const ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue >& SfxMacroStatement::GetArgs() const + +/* [Beschreibung] + + Liefert die Parameter mit denen Statement ausgef"uhrt wurde oder 0, + falls das Statement manuell (<SFX_SLOT_RECORDMANUAL>) aufgezeichnet + wurde. + + Der R"uckgabewert geh"ort dem SfxMacroStatement und ist nur im + unmittelbar aufrufenden Stackframe g"ultig. +*/ + +{ + return aArgs; +} + +//-------------------------------------------------------------------- + +inline BOOL SfxMacroStatement::IsDone() const + +/* [Beschreibung] + + Liefert TRUE, wenn das Statement wirklich ausgef"uhrt wurde, + also z.B. nicht vom Benutzer abgebrochen wurde. Wurde es nicht + wirklich ausgef"uhrt, dann wird es im BASIC-Source auskommentiert. +*/ + +{ + return bDone; +} + +//-------------------------------------------------------------------- + +/* [Beschreibung] + + Liefert das Statement in BASIC-Syntax. Wurde das Makro manuell erzeugt, + wird genau der im Konstruktor angegebene String zur"uckgegeben, sonst + der generierte Source-Code. + + Bei beiden Arten ist es m"oglich, da\s mehrere BASIC-Statements, jeweils + mit CR/LF getrennt in dem String enthalten sind, da ein SFx-Statement + ggf. in mehrere BASIC-Statements "ubersetzt wird. + + Statements f"ur die nicht <SfxRequest::Done()> gerufen wurde, werden + mit einem vorangestellten 'rem' gekennzeichnet. +*/ + +inline const String& SfxMacroStatement::GetStatement() const +{ + return aStatement; +} + +//==================================================================== + +enum SfxMacroMode + +/* [Beschreibung] + + Mit diesem enum wird bestimmt, ob eine <SfxMacro>-Instanz zum + absoluten oder relativen Recorden erzeugt wurde, oder um ein + existierendendes Makro zu Referenzieren. +*/ + +{ + SFX_MACRO_EXISTING, /* es handelt sich um ein bereits + exitistierendes Makro, welches lediglich + referenziert wird */ + + SFX_MACRO_RECORDINGABSOLUTE,/* dieses Makro soll aufgezeichnet werden, + wobei die betroffenen Objekte m"oglichst + direkt angesprochen werden sollen + (Beispiel: "[doc.sdc]") */ + + SFX_MACRO_RECORDINGRELATIVE/* dieses Makro soll aufgezeichnet werden, + wobei die betroffenen Objekte so + angesprochen werden sollen, da\s sich das + Abspielen auf die dann g"ultige Selektion + bezieht (Beispiel: "ActiveDocument()") */ +}; + +//==================================================================== + +class SfxMacro + +/* [Beschreibung] + + "Uber diese Klasse (bzw. genaugenommen ihre Subklassen) wird zum + einen die Lokation einer BASIC-Funktion (also in welcher Library, + in welchem Modul sowie der Funktions-Name) beschrieben, als auch + ein aufzuzeichnendes Makro w"ahrend der Aufzeichnung zwischen- + gespeichert. +*/ + +{ + SfxMacro_Impl* pImp; + +public: + SfxMacro( SfxMacroMode eMode = SFX_MACRO_RECORDINGRELATIVE ); + virtual ~SfxMacro(); + + SfxMacroMode GetMode() const; + void Record( SfxMacroStatement *pStatement ); + void Replace( SfxMacroStatement *pStatement ); + void Remove(); + const SfxMacroStatement*GetLastStatement() const; + + String GenerateSource() const; +}; + +#endif |