diff options
Diffstat (limited to 'sfx2/inc/sfx2/msg.hxx')
| -rw-r--r-- | sfx2/inc/sfx2/msg.hxx | 344 |
1 files changed, 344 insertions, 0 deletions
diff --git a/sfx2/inc/sfx2/msg.hxx b/sfx2/inc/sfx2/msg.hxx new file mode 100644 index 000000000000..efbc2d2c75af --- /dev/null +++ b/sfx2/inc/sfx2/msg.hxx @@ -0,0 +1,344 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef _SFXMSG_HXX +#define _SFXMSG_HXX + +#include <tools/rtti.hxx> +#include <sfx2/shell.hxx> + +//-------------------------------------------------------------------- + +#define SFX_SLOT_CACHABLE 0x0001L // exklusiv zu VOLATILE, default +#define SFX_SLOT_VOLATILE 0x0002L // per Timer alle 2s neu geholt, exklusiv zu CACHABLE +#define SFX_SLOT_TOGGLE 0x0004L // invertiert bei Execute alten Wert +#define SFX_SLOT_AUTOUPDATE 0x0008L // invalidiert den Status nach Execute automatisch + +#define SFX_SLOT_SYNCHRON 0x0010L // exklusiv zu ASYNCHRON, default +#define SFX_SLOT_ASYNCHRON 0x0020L // via Post-Message, exklusiv zu SYNCHRON + +#define SFX_SLOT_HASCOREID 0x0040L // Slot-ID/Which-ID Mappting durchf"uhren +#define SFX_SLOT_HASDIALOG 0x0080L // Punkte fuer Dialog nach recofig + +#define SFX_SLOT_NORECORD 0x0100L // kein Recording +#define SFX_SLOT_RECORDPERITEM 0x0200L // je Item ein Statement +#define SFX_SLOT_RECORDPERSET 0x0400L // das ganze Set ist ein Statement, def. +#define SFX_SLOT_RECORDMANUAL 0x0800L // Recording vom Applikationsentwickler iss-default + +#define SFX_SLOT_RECORDABSOLUTE 0x1000000L // Recording mit absolutem Target +#define SFX_SLOT_STANDARD ( SFX_SLOT_CACHABLE | \ + SFX_SLOT_SYNCHRON | \ + SFX_SLOT_RECORDPERSET ) + +#define SFX_SLOT_PROPGET 0x1000L // abfragbares Property +#define SFX_SLOT_PROPSET 0x2000L // setzbares Property, exklusiv zu SFX_SLOT_METHOD +#define SFX_SLOT_METHOD 0x4000L // Methode, exklusiv zu SFX_SLOT_PROPSET + +#define SFX_SLOT_FASTCALL 0x8000L // vor Execute keine Pr"ufung, ob disabled + +#define SFX_SLOT_STATUSBARCONFIG 0x10000L // konfigurierbar in Statuszeile +#define SFX_SLOT_MENUCONFIG 0x20000L // konfigurierbar im Men"u +#define SFX_SLOT_TOOLBOXCONFIG 0x40000L // konfigurierbar in Toolboxen +#define SFX_SLOT_ACCELCONFIG 0x80000L // konfigurierbar auf Tasten + +#define SFX_SLOT_CONTAINER 0x100000L // beim InPlace vom Container bedient +#define SFX_SLOT_READONLYDOC 0x200000L // auch bei readonly-Docs verf"ugbar +#define SFX_SLOT_IMAGEROTATION 0x400000L // bei Vertical/Bidi writing Image drehen +#define SFX_SLOT_IMAGEREFLECTION 0x800000L // bei Vertical/Bidi writing Image spiegeln + +//-------------------------------------------------------------------- + +class SfxRequest; +class SfxItemSet; + +#define SFX_EXEC_STUB( aShellClass, aExecMethod) \ + void __EXPORT SfxStub##aShellClass##aExecMethod( \ + SfxShell *pShell, SfxRequest& rReq) \ + { \ + (( aShellClass* ) pShell )->aExecMethod( rReq ); \ + } + +#define SFX_STATE_STUB( aShellClass, aStateMethod) \ + void __EXPORT SfxStub##aShellClass##aStateMethod( \ + SfxShell *pShell, SfxItemSet& rSet) \ + { \ + (( aShellClass* ) pShell )->aStateMethod( rSet ); \ + } + +#define SFX_STUB_PTR( aShellClass, aMethod ) \ + &SfxStub##aShellClass##aMethod + +#define SFX_STUB_PTR_EXEC_NONE &SfxShell::EmptyExecStub + +#define SFX_STUB_PTR_STATE_NONE &SfxShell::EmptyStateStub + +//-------------------------------------------------------------------- + +enum SfxSlotKind +{ + SFX_KIND_STANDARD, + SFX_KIND_ENUM, + SFX_KIND_ATTR +}; + +//========================================================================= + +struct SfxTypeAttrib +{ + USHORT nAID; + const char __FAR_DATA* pName; +}; + +struct SfxType +{ + TypeId aTypeId; + USHORT nAttribs; + SfxTypeAttrib aAttrib[16]; + + const TypeId& Type() const + { return aTypeId; } + SfxPoolItem* CreateItem() const + { return (SfxPoolItem*) aTypeId(); } +}; + +struct SfxType0 +{ + TypeId aTypeId; + USHORT nAttribs; + + const TypeId& Type() const + { return aTypeId; } + SfxPoolItem* CreateItem() const + { return (SfxPoolItem*) aTypeId(); } +}; + +#define SFX_DECL_TYPE(n) struct SfxType##n \ + { \ + TypeId aTypeId; \ + USHORT nAttribs; \ + SfxTypeAttrib aAttrib[n]; \ + } + +#define SFX_TYPE(Class) &a##Class##_Impl + +SFX_DECL_TYPE(1); +SFX_DECL_TYPE(2); +SFX_DECL_TYPE(3); +SFX_DECL_TYPE(4); +SFX_DECL_TYPE(5); +SFX_DECL_TYPE(6); +SFX_DECL_TYPE(7); +SFX_DECL_TYPE(8); +SFX_DECL_TYPE(10); // for SfxDocInfoItem +SFX_DECL_TYPE(11); + +SFX_DECL_TYPE(13); // for SwAddPrinterItem, Sd... +SFX_DECL_TYPE(14); +SFX_DECL_TYPE(16); // for SwDocDisplayItem +SFX_DECL_TYPE(17); // for SvxAddressItem +SFX_DECL_TYPE(18); // for SvxSearchItem + +// all SfxTypes must be in this header +#undef SFX_DECL_TYPE + +#define SFX_SLOT_ARG( aShellClass, id, GroupId, ExecMethodPtr, StateMethodPtr, Flags, ItemClass, nArg0, nArgs, Name, Prop ) \ + { id, GroupId, id, Flags | Prop, \ + USHRT_MAX, 0, \ + ExecMethodPtr, \ + StateMethodPtr, \ + (const SfxType*) &a##ItemClass##_Impl, \ + Name, Name, 0, 0, \ + &a##aShellClass##Args_Impl[nArg0], nArgs, 0, Name \ + } + +#define SFX_SLOT( aShellClass, id, GroupId, ExecMethodPtr, StateMethodPtr, Flags, ItemClass ) \ + { id, GroupId, id, Flags, \ + 0, 0, \ + ExecMethodPtr, \ + StateMethodPtr, \ + (const SfxType*) &a##ItemClass##_Impl, \ + 0, 0, 0, 0, 0, 0, 0 \ + } + +#define SFX_SLOT_ATTR( id, GroupId, Dummy, ExecMethodPtr, StateMethodPtr, Flags, ItemClass ) \ + { id, GroupId, id, Flags, \ + USHRT_MAX, 0, \ + ExecMethodPtr, \ + StateMethodPtr, \ + (const SfxType*) &a##ItemClass##_Impl, \ + 0, 0, 0, 0, 0, 0, 0 \ + } + +#define SFX_SLOT_ENUM( SlaveId, GroupId, MasterId, Value, Flags ) \ + { SlaveId, GroupId, id, Flags, \ + MasterId, Value, 0, 0, \ + (const SfxType*) &aSfxBoolItem_Impl, \ + 0, 0, 0, 0, 0, 0, 0 \ + } +#define SFX_NEW_SLOT_ARG( aShellClass, id, hid, GroupId, pLinked, pNext, ExecMethodPtr, StateMethodPtr, Flags, DisableFlags, ItemClass, nArg0, nArgs, Name, Prop, UnoName ) \ + { id, GroupId, hid, Flags | Prop, \ + USHRT_MAX, 0, \ + ExecMethodPtr, \ + StateMethodPtr, \ + (const SfxType*) &a##ItemClass##_Impl, \ + Name, Name, \ + pLinked, pNext, \ + &a##aShellClass##Args_Impl[nArg0], nArgs, DisableFlags, UnoName \ + } + +#define SFX_NEW_SLOT_ENUM( SlaveId, hid, GroupId, pMaster, pNext, MasterId, Value, Flags, DisableFlags, UnoName ) \ + { SlaveId, GroupId, hid, Flags, \ + MasterId, Value, \ + 0, \ + 0, \ + (const SfxType*) &aSfxBoolItem_Impl, \ + 0, 0, \ + pMaster, \ + pNext, \ + 0, 0, DisableFlags, UnoName \ + } + +#define SFX_SLOTMAP_NONE(ShellClass) \ + static SfxFormalArgument __FAR_DATA a##ShellClass##Args_Impl[1]; \ + static SfxSlot __FAR_DATA a##ShellClass##Slots_Impl[] = \ + { { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } } + +#define SFX_ARGUMENT( ArgSlotId, ArgName, ArgTypeId ) \ + { (const SfxType*) &a##ArgTypeId##_Impl, ArgName, ArgSlotId } + +//-------------------------------------------------------------------- + +class SfxPoolItem; + +struct SfxFormalArgument +{ + const SfxType* pType; // Typ des Parameters (SfxPoolItem Subklasse) + const char __FAR_DATA* pName; // Name des Parameters + USHORT nSlotId;// Slot-Id zur Identifikation des Parameters + + const TypeId& Type() const + { return pType->aTypeId; } + SfxPoolItem* CreateItem() const + { return (SfxPoolItem*) pType->aTypeId(); } +}; + +//-------------------------------------------------------------------- + +class SfxSlot +{ +public: + USHORT nSlotId; // in Shell eindeutige Slot-Id + USHORT nGroupId; // f"ur Konfigurations-Bereich + ULONG nHelpId; // i.d.R. == nSlotId + ULONG nFlags; // artihm. veroderte Flags + + USHORT nMasterSlotId; // Enum-Slot bzw. Which-Id + USHORT nValue; // Wert, falls Enum-Slot + + SfxExecFunc fnExec; // Funktion zum Ausf"uhren + SfxStateFunc fnState; // Funktion f"ur Status + + const SfxType* pType; // SfxPoolItem-Typ (Status) + const char __FAR_DATA* pName; // Name des Slots + const char __FAR_DATA* pMethodName; // Name der Method falls anders + + const SfxSlot* pLinkedSlot; // Master-Slot f"ur Enum-Werte + const SfxSlot* pNextSlot; // mit derselben Status-Methode + + const SfxFormalArgument* pFirstArgDef; // erste formale Argument-Definition + USHORT nArgDefCount; // Anzahl der formalen Argumente + long nDisableFlags; // DisableFlags, die vorhanden sein + // m"ussen, damit der Slot enabled ist + const char __FAR_DATA* pUnoName; // UnoName des Slots + +public: + + SfxSlotKind GetKind() const; + USHORT GetSlotId() const; + ULONG GetHelpId() const; + ULONG GetMode() const; + BOOL IsMode( ULONG nMode ) const; + USHORT GetGroupId() const; + USHORT GetMasterSlotId() const { return nMasterSlotId; } + USHORT GetWhich( const SfxItemPool &rPool ) const; + USHORT GetValue() const { return nValue; } + const SfxType* GetType() const { return pType; } + const char* GetUnoName() const { return pUnoName; } + + USHORT GetFormalArgumentCount() const { return nArgDefCount; } + const SfxFormalArgument& GetFormalArgument( USHORT nNo ) const + { return pFirstArgDef[nNo]; } + + SfxExecFunc GetExecFnc() const { return fnExec; } + SfxStateFunc GetStateFnc() const { return fnState; } + + const SfxSlot* GetLinkedSlot() const { return pLinkedSlot; } + const SfxSlot* GetNextSlot() const { return pNextSlot; } +}; + +//========================================================================= + +// returns the id of the function + +inline USHORT SfxSlot::GetSlotId() const +{ + return nSlotId; +} +//-------------------------------------------------------------------- +// returns the help-id of the slot + +inline ULONG SfxSlot::GetHelpId() const +{ + return nHelpId; +} + +//-------------------------------------------------------------------- + +// returns a bitfield with flags + +inline ULONG SfxSlot::GetMode() const +{ + return nFlags; +} +//-------------------------------------------------------------------- + +// determines if the specified mode is assigned + +inline BOOL SfxSlot::IsMode( ULONG nMode ) const +{ + return (nFlags & nMode) != 0; +} +//-------------------------------------------------------------------- + +// returns the id of the associated group + +inline USHORT SfxSlot::GetGroupId() const +{ + return nGroupId; + +} + +#endif |