sfx2/source/config/evntconf.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 #include <boost/scoped_ptr.hpp>
  22
  23 #include <vcl/msgbox.hxx>
  24 #include <svl/lstner.hxx>
  25 #include <basic/basmgr.hxx>
  26 #include <basic/sbmod.hxx>
  27 #include <basic/sbx.hxx>
  28 #include <sot/storage.hxx>
  29 #include <unotools/securityoptions.hxx>
  30
  31 #include <rtl/ustring.h>
  32 #include <com/sun/star/uno/Any.hxx>
  33 #include <framework/eventsconfiguration.hxx>
  34 #include <comphelper/processfactory.hxx>
  35 #include <sfx2/evntconf.hxx>
  36
  37 #include <sfx2/docfile.hxx>
  38 #include <sfx2/app.hxx>
  39 #include <sfx2/objsh.hxx>
  40 #include <sfx2/dispatch.hxx>
  41 #include "sfx2/sfxresid.hxx"
  42 #include "eventsupplier.hxx"
  43
  44 #include <com/sun/star/beans/PropertyValue.hpp>
  45 #include <com/sun/star/container/XNameReplace.hpp>
  46 #include <com/sun/star/document/XEventsSupplier.hpp>
  47 #include <com/sun/star/frame/GlobalEventBroadcaster.hpp>
  48 #include <com/sun/star/uno/Sequence.hxx>
  49 #include <com/sun/star/uno/Reference.hxx>
  50
  51 // -----------------------------------------------------------------------
  52 TYPEINIT1(SfxEventHint, SfxHint);
  53 TYPEINIT1(SfxEventNamesItem, SfxPoolItem);
  54 TYPEINIT1(SfxViewEventHint, SfxEventHint);
  55
  56 using namespace com::sun::star;
  57
  58 SfxEventNamesList& SfxEventNamesList::operator=( const SfxEventNamesList& rTbl )
  59 {
  60     DelDtor();
  61     for ( size_t i = 0, n = rTbl.size(); i < n; ++i )
  62     {
  63         SfxEventName* pTmp = rTbl.at( i );
  64         SfxEventName* pNew = new SfxEventName( *pTmp );
  65         aEventNamesList.push_back( pNew );
  66     }
  67     return *this;
  68 }
  69
  70 void SfxEventNamesList::DelDtor()
  71 {
  72     for ( size_t i = 0, n = aEventNamesList.size(); i < n; ++i )
  73         delete aEventNamesList[ i ];
  74     aEventNamesList.clear();
  75 }
  76
  77 int SfxEventNamesItem::operator==( const SfxPoolItem& rAttr ) const
  78 {
  79     DBG_ASSERT( SfxPoolItem::operator==(rAttr), "unequal types" );
  80
  81     const SfxEventNamesList& rOwn = aEventsList;
  82     const SfxEventNamesList& rOther = ( (SfxEventNamesItem&) rAttr ).aEventsList;
  83
  84     if ( rOwn.size() != rOther.size() )
  85         return sal_False;
  86
  87     for ( size_t nNo = 0, nCnt = rOwn.size(); nNo < nCnt; ++nNo )
  88     {
  89         const SfxEventName *pOwn = rOwn.at( nNo );
  90         const SfxEventName *pOther = rOther.at( nNo );
  91         if (    pOwn->mnId != pOther->mnId ||
  92                 pOwn->maEventName != pOther->maEventName ||
  93                 pOwn->maUIName != pOther->maUIName )
  94             return sal_False;
  95     }
  96
  97     return sal_True;
  98
  99 }
 100
 101 SfxItemPresentation SfxEventNamesItem::GetPresentation( SfxItemPresentation,
 102                                     SfxMapUnit,
 103                                     SfxMapUnit,
 104                                     OUString &rText,
 105                                     const IntlWrapper* ) const
 106 {
 107     rText = OUString();
 108     return SFX_ITEM_PRESENTATION_NONE;
 109 }
 110
 111 SfxPoolItem* SfxEventNamesItem::Clone( SfxItemPool *) const
 112 {
 113     return new SfxEventNamesItem(*this);
 114 }
 115
 116 SfxPoolItem* SfxEventNamesItem::Create(SvStream &, sal_uInt16) const
 117 {
 118     OSL_FAIL("not streamable!");
 119     return new SfxEventNamesItem(Which());
 120 }
 121
 122 SvStream& SfxEventNamesItem::Store(SvStream &rStream, sal_uInt16 ) const
 123 {
 124     OSL_FAIL("not streamable!");
 125     return rStream;
 126 }
 127
 128 sal_uInt16 SfxEventNamesItem::GetVersion( sal_uInt16 ) const
 129 {
 130     OSL_FAIL("not streamable!");
 131     return 0;
 132 }
 133
 134 void SfxEventNamesItem::AddEvent( const String& rName, const String& rUIName, sal_uInt16 nID )
 135 {
 136     aEventsList.push_back( new SfxEventName( nID, rName, rUIName.Len() ? rUIName : rName ) );
 137 }
 138
 139
 140 //==========================================================================
 141
 142 //--------------------------------------------------------------------------
 143 uno::Any CreateEventData_Impl( const SvxMacro *pMacro )
 144 {
 145 /*
 146     This function converts a SvxMacro into an Any containing three
 147     properties. These properties are EventType and Script. Possible
 148     values for EventType ar StarBasic, JavaScript, ...
 149     The Script property should contain the URL to the macro and looks
 150     like "macro://./standard.module1.main()"
 151
 152     If pMacro is NULL, we return an empty property sequence, so PropagateEvent_Impl
 153     can delete an event binding.
 154 */
 155     uno::Any aEventData;
 156
 157     if ( pMacro )
 158     {
 159         if ( pMacro->GetScriptType() == STARBASIC )
 160         {
 161             uno::Sequence < beans::PropertyValue > aProperties(3);
 162             beans::PropertyValue *pValues = aProperties.getArray();
 163
 164             OUString aType(STAR_BASIC );
 165             OUString aLib  = pMacro->GetLibName();
 166             OUString aMacro = pMacro->GetMacName();
 167
 168             pValues[ 0 ].Name = OUString(PROP_EVENT_TYPE );
 169             pValues[ 0 ].Value <<= aType;
 170
 171             pValues[ 1 ].Name = OUString(PROP_LIBRARY );
 172             pValues[ 1 ].Value <<= aLib;
 173
 174             pValues[ 2 ].Name = OUString(PROP_MACRO_NAME );
 175             pValues[ 2 ].Value <<= aMacro;
 176
 177             aEventData <<= aProperties;
 178         }
 179         else if ( pMacro->GetScriptType() == EXTENDED_STYPE )
 180         {
 181             uno::Sequence < beans::PropertyValue > aProperties(2);
 182             beans::PropertyValue *pValues = aProperties.getArray();
 183
 184             OUString aLib   = pMacro->GetLibName();
 185             OUString aMacro = pMacro->GetMacName();
 186
 187             pValues[ 0 ].Name = OUString(PROP_EVENT_TYPE );
 188             pValues[ 0 ].Value <<= aLib;
 189
 190             pValues[ 1 ].Name = OUString(PROP_SCRIPT );
 191             pValues[ 1 ].Value <<= aMacro;
 192
 193             aEventData <<= aProperties;
 194         }
 195         else if ( pMacro->GetScriptType() == JAVASCRIPT )
 196         {
 197             uno::Sequence < beans::PropertyValue > aProperties(2);
 198             beans::PropertyValue *pValues = aProperties.getArray();
 199
 200             OUString aMacro  = pMacro->GetMacName();
 201
 202             pValues[ 0 ].Name = OUString(PROP_EVENT_TYPE );
 203             pValues[ 0 ].Value <<= OUString(SVX_MACRO_LANGUAGE_JAVASCRIPT);
 204
 205             pValues[ 1 ].Name = OUString(PROP_MACRO_NAME );
 206             pValues[ 1 ].Value <<= aMacro;
 207
 208             aEventData <<= aProperties;
 209         }
 210         else
 211         {
 212             SAL_WARN( "sfx2.config", "CreateEventData_Impl(): ScriptType not supported!");
 213         }
 214     }
 215     else
 216     {
 217         uno::Sequence < beans::PropertyValue > aProperties;
 218         aEventData <<= aProperties;
 219     }
 220
 221     return aEventData;
 222 }
 223
 224 //--------------------------------------------------------------------------
 225 void PropagateEvent_Impl( SfxObjectShell *pDoc, OUString aEventName, const SvxMacro* pMacro )
 226 {
 227     uno::Reference < document::XEventsSupplier > xSupplier;
 228     if ( pDoc )
 229     {
 230         xSupplier = uno::Reference < document::XEventsSupplier >( pDoc->GetModel(), uno::UNO_QUERY );
 231     }
 232     else
 233     {
 234         xSupplier = uno::Reference < document::XEventsSupplier >
 235                 ( frame::GlobalEventBroadcaster::create(::comphelper::getProcessComponentContext()),
 236                   uno::UNO_QUERY );
 237     }
 238
 239     if ( xSupplier.is() )
 240     {
 241         uno::Reference < container::XNameReplace > xEvents = xSupplier->getEvents();
 242         if ( !aEventName.isEmpty() )
 243         {
 244             uno::Any aEventData = CreateEventData_Impl( pMacro );
 245
 246             try
 247             {
 248                 xEvents->replaceByName( aEventName, aEventData );
 249             }
 250             catch( const ::com::sun::star::lang::IllegalArgumentException& )
 251             {
 252                 SAL_WARN( "sfx2.config", "PropagateEvents_Impl: caught IllegalArgumentException" );
 253             }
 254             catch( const ::com::sun::star::container::NoSuchElementException& )
 255             {
 256                 SAL_WARN( "sfx2.config", "PropagateEvents_Impl: caught NoSuchElementException" );
 257             }
 258         }
 259         else {
 260             DBG_WARNING( "PropagateEvents_Impl: Got unknown event" );
 261         }
 262     }
 263 }
 264
 265 //--------------------------------------------------------------------------------------------------------
 266 void SfxEventConfiguration::ConfigureEvent( OUString aName, const SvxMacro& rMacro, SfxObjectShell *pDoc )
 267 {
 268     boost::scoped_ptr<SvxMacro> pMacro;
 269     if ( rMacro.HasMacro() )
 270         pMacro.reset( new SvxMacro( rMacro.GetMacName(), rMacro.GetLibName(), rMacro.GetScriptType() ) );
 271     PropagateEvent_Impl( pDoc ? pDoc : 0, aName, pMacro.get() );
 272 }
 273
 274 // -------------------------------------------------------------------------------------------------------
 275 SvxMacro* SfxEventConfiguration::ConvertToMacro( const com::sun::star::uno::Any& rElement, SfxObjectShell* pDoc, sal_Bool bBlowUp )
 276 {
 277     return SfxEvents_Impl::ConvertToMacro( rElement, pDoc, bBlowUp );
 278 }
 279
 280 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */