binfilter/inc/bf_sfx2/evntconf.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: evntconf.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _SFX_EVENTCONF_HXX
  31 #define _SFX_EVENTCONF_HXX
  32
  33 #if _SOLAR__PRIVATE
  34
  35 #ifndef _FIXED_HXX //autogen
  36 #include <vcl/fixed.hxx>
  37 #endif
  38 #ifndef _SV_BUTTON_HXX
  39 #include <vcl/button.hxx>
  40 #endif
  41
  42 #endif
  43
  44 #define _SVSTDARR_USHORTS
  45 #include <bf_svtools/svstdarr.hxx>              // SvUShorts
  46 #include <bf_sfx2/cfgitem.hxx>
  47 #include <bf_sfx2/event.hxx>
  48
  49 #include <bf_sfx2/sfxsids.hrc>
  50 #ifdef ITEMID_MACRO
  51 #undef ITEMID_MACRO
  52 #endif
  53 #define ITEMID_MACRO SID_ATTR_MACROITEM
  54 #include <bf_svtools/macitem.hxx>
  55 namespace binfilter {
  56
  57 class SfxMacroInfo;
  58 class SfxMacroTabPage;
  59 class SfxMacroInfoArr_Impl;
  60 class SfxEventConfigItem_Impl;
  61 class SfxEventInfoArr_Impl;
  62 class SfxObjectShell;
  63
  64 #define SFX_NO_EVENT USHRT_MAX
  65
  66 #if _SOLAR__PRIVATE
  67 struct SfxEvent_Impl
  68 {
  69     String                                              aEventName;
  70     USHORT                                              nEventId;
  71
  72     SfxEvent_Impl(const String& rName, USHORT nId) :
  73         aEventName(rName),
  74         nEventId(nId)
  75     {}
  76 };
  77
  78 SV_DECL_PTRARR(SfxEventArr_Impl, SfxEvent_Impl*, 5, 5)//STRIP008 ;
  79
  80 // -----------------------------------------------------------------------
  81
  82 #define PROP_EVENT_TYPE         "EventType"
  83 #define PROP_LIBRARY            "Library"
  84 #define PROP_SCRIPT                     "Script"
  85 #define PROP_SCRIPT_URL         "URL"
  86 #define PROP_MACRO_NAME         "MacroName"
  87 #define STAR_BASIC                      "StarBasic"
  88 #define JAVA_SCRIPT                     "JavaScript"
  89
  90 // -----------------------------------------------------------------------
  91 #else
  92 typedef SvPtrarr SfxEventArr_Impl;
  93 #endif
  94
  95 class SfxEventConfiguration
  96 {
  97 friend class SfxEventConfigItem_Impl;
  98
  99     SfxMacroInfoArr_Impl*       pArr;
 100     SfxEventArr_Impl*           pEventArr;
 101     SfxEventConfigItem_Impl* pAppEventConfig;
 102     SfxEventConfigItem_Impl* pDocEventConfig;
 103     sal_Bool                            bIgnoreConfigure;
 104
 105 public:
 106                             SfxEventConfiguration();
 107                             ~SfxEventConfiguration();
 108
 109     void                                        RegisterEvent(USHORT nId, const String& rName);
 110     USHORT                                      GetEventCount() const
 111                             { return pEventArr->Count()-1; }
 112     void                                        ConfigureEvent(USHORT nId, const String& rMacro,
 113                                 SfxObjectShell* pObjSh);
 114
 115     SvxMacroTableDtor*          GetAppEventTable();
 116
 117     static void                         RegisterEvent( USHORT nId, const String& rName,
 118                                            const String& rMacroName );
 119
 120     static BOOL             Import( SvStream& rInStream, SvStream* pOutStream, SfxObjectShell* pDoc=NULL );
 121     static BOOL             Export( SvStream* pInStream, SvStream& rOutStream, SfxObjectShell* pDoc=NULL );
 122
 123 #if _SOLAR__PRIVATE
 124     SfxEventConfigItem_Impl*    GetAppEventConfig_Impl();
 125     const SfxEvent_Impl*                GetEvent_Impl(USHORT nPos) const
 126                                     { return (*pEventArr)[nPos+1]; }
 127     BOOL                                                Warn_Impl( SfxObjectShell *pDoc, const SvxMacro* pMacro );
 128     void                                                PropagateEvents_Impl( SfxObjectShell *pDoc,
 129                                                       const SvxMacroTableDtor& rTable );
 130     static ::rtl::OUString              GetEventName_Impl( ULONG nID );
 131     static ULONG                                GetEventId_Impl( const ::rtl::OUString& rEventName );
 132     ::com::sun::star::uno::Any  CreateEventData_Impl( const SvxMacro *pMacro );
 133
 134     static ULONG                                GetPos_Impl( USHORT nID, sal_Bool &rFound );
 135     static ULONG                                GetPos_Impl( const String& rName, sal_Bool &rFound );
 136 #endif
 137 };
 138
 139 #if _SOLAR__PRIVATE
 140 class SfxEventConfigItem_Impl : public SfxConfigItem
 141 {
 142 friend class SfxEventConfiguration;
 143
 144     SvxMacroTableDtor           aMacroTable;
 145     SfxEventConfiguration       *pEvConfig;
 146     SfxObjectShell                      *pObjShell;
 147     BOOL                                        bWarning;
 148     BOOL                                        bAlwaysWarning;
 149     BOOL                                        bInitialized;
 150
 151     void                                        ConstructMacroTable();
 152     int                     Load(SvStream&);
 153
 154 public:
 155                             SfxEventConfigItem_Impl( USHORT,
 156                                 SfxEventConfiguration*,
 157                                 SfxObjectShell* pObjSh = NULL );
 158                             ~SfxEventConfigItem_Impl();
 159
 160     void                                        Init( SfxConfigManager* );
 161     virtual int             Load(SotStorage&);
 162     virtual BOOL            Store(SotStorage&);
 163     virtual String          GetStreamName() const;
 164     virtual void                        UseDefault();
 165     void                                        ConfigureEvent( USHORT nPos, SvxMacro* );
 166 };
 167
 168 #endif
 169
 170 }//end of namespace binfilter
 171 #endif