sfx2/source/doc/plugin.cxx

   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: plugin.cxx,v $
  10  * $Revision: 1.7 $
  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
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_sfx2.hxx"
  33
  34 #include "plugin.hxx"
  35 #include <com/sun/star/plugin/XPluginManager.hpp>
  36 #include <com/sun/star/plugin/PluginMode.hpp>
  37 #include <com/sun/star/awt/XControl.hpp>
  38
  39 #include <tools/debug.hxx>
  40 #include <rtl/ustring.hxx>
  41 #include <toolkit/helper/vclunohelper.hxx>
  42 #include <svtools/miscopt.hxx>
  43 #include <vcl/window.hxx>
  44
  45 using namespace ::com::sun::star;
  46
  47 namespace sfx2
  48 {
  49
  50 class PluginWindow_Impl : public Window
  51 {
  52 public:
  53     uno::Reference < awt::XWindow > xWindow;
  54     PluginWindow_Impl( Window* pParent )
  55      : Window( pParent, WB_CLIPCHILDREN )
  56      {}
  57
  58      virtual void Resize();
  59 };
  60
  61 void PluginWindow_Impl::Resize()
  62 {
  63     Size aSize( GetOutputSizePixel() );
  64     if ( xWindow.is() )
  65         xWindow->setPosSize( 0, 0, aSize.Width(), aSize.Height(), WINDOW_POSSIZE_SIZE );
  66 }
  67
  68 #define PROPERTY_UNBOUND 0
  69
  70 #define WID_COMMANDS    1
  71 #define WID_MIMETYPE    2
  72 #define WID_URL         3
  73 const SfxItemPropertyMapEntry* lcl_GetPluginPropertyMap_Impl()
  74 {
  75     static SfxItemPropertyMapEntry aPluginPropertyMap_Impl[] =
  76     {
  77         { MAP_CHAR_LEN("PluginCommands"), WID_COMMANDS, &::getCppuType((::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >*)0), PROPERTY_UNBOUND, 0},
  78         { MAP_CHAR_LEN("PluginMimeType"), WID_MIMETYPE, &::getCppuType((const ::rtl::OUString*)0), PROPERTY_UNBOUND, 0 },
  79         { MAP_CHAR_LEN("PluginURL"),      WID_URL     , &::getCppuType((const ::rtl::OUString*)0), PROPERTY_UNBOUND, 0 },
  80         {0,0,0,0,0,0}
  81     };
  82     return aPluginPropertyMap_Impl;
  83 }
  84
  85 SFX_IMPL_XSERVICEINFO( PluginObject, "com.sun.star.embed.SpecialEmbeddedObject", "com.sun.star.comp.sfx2.PluginObject" )
  86 SFX_IMPL_SINGLEFACTORY( PluginObject );
  87
  88 PluginObject::PluginObject( const uno::Reference < lang::XMultiServiceFactory >& rFact )
  89     : mxFact( rFact )
  90     , maPropMap( lcl_GetPluginPropertyMap_Impl() )
  91 {
  92 }
  93
  94 PluginObject::~PluginObject()
  95 {
  96 }
  97
  98 void SAL_CALL PluginObject::initialize( const uno::Sequence< uno::Any >& aArguments ) throw ( uno::Exception, uno::RuntimeException )
  99 {
 100     if ( aArguments.getLength() )
 101         aArguments[0] >>= mxObj;
 102 }
 103
 104 sal_Bool SAL_CALL PluginObject::load(
 105     const uno::Sequence < com::sun::star::beans::PropertyValue >& /*lDescriptor*/,
 106     const uno::Reference < frame::XFrame >& xFrame )
 107 throw( uno::RuntimeException )
 108 {
 109     uno::Reference< plugin::XPluginManager > xPMgr( mxFact->createInstance( ::rtl::OUString::createFromAscii("com.sun.star.plugin.PluginManager") ), uno::UNO_QUERY );
 110     if (!xPMgr.is() )
 111         return FALSE;
 112
 113     if ( SvtMiscOptions().IsPluginsEnabled() )
 114     {
 115         Window* pParent = VCLUnoHelper::GetWindow( xFrame->getContainerWindow() );
 116         PluginWindow_Impl* pWin = new PluginWindow_Impl( pParent );
 117         pWin->SetSizePixel( pParent->GetOutputSizePixel() );
 118         pWin->SetBackground();
 119         pWin->Show();
 120
 121         ULONG nCount = maCmdList.Count();
 122         uno::Sequence < ::rtl::OUString > aCmds( nCount ), aArgs( nCount );
 123         ::rtl::OUString *pCmds = aCmds.getArray(), *pArgs = aArgs.getArray();
 124         for( ULONG i = 0; i < nCount; i++ )
 125         {
 126             SvCommand & rCmd = maCmdList.GetObject( i );
 127             pCmds[i] = rCmd.GetCommand();
 128             pArgs[i] = rCmd.GetArgument();
 129         }
 130
 131         mxPlugin = xPMgr->createPluginFromURL(
 132             xPMgr->createPluginContext(), plugin::PluginMode::EMBED, aCmds, aArgs, uno::Reference< awt::XToolkit >(),
 133             uno::Reference< awt::XWindowPeer >( pWin->GetComponentInterface() ), maURL );
 134
 135         if ( mxPlugin.is() )
 136         {
 137             uno::Reference< awt::XWindow > xWindow( mxPlugin, uno::UNO_QUERY );
 138             if ( xWindow.is() )
 139             {
 140                 pWin->xWindow = xWindow;
 141                 pWin->Resize();
 142                 xWindow->setVisible( TRUE );
 143             }
 144
 145             try
 146             {
 147                 uno::Reference< awt::XControl > xControl( mxPlugin, uno::UNO_QUERY );
 148                 if( xControl.is() )
 149                 {
 150                     uno::Reference< awt::XControlModel > xModel = xControl->getModel();
 151                     uno::Reference< beans::XPropertySet > xProp( xModel, ::uno::UNO_QUERY );
 152                     if( xProp.is() )
 153                     {
 154                         uno::Any aValue = xProp->getPropertyValue( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "URL" ) ) );
 155                         aValue >>= maURL;
 156                         aValue = xProp->getPropertyValue( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "TYPE" ) ) );
 157                         aValue >>= maMimeType;
 158                     }
 159                 }
 160             }
 161             catch( uno::Exception& )
 162             {
 163             }
 164         }
 165
 166         uno::Reference < awt::XWindow > xWindow( pWin->GetComponentInterface(), uno::UNO_QUERY );
 167
 168         // we must destroy the plugin before the parent is destroyed
 169         xWindow->addEventListener( this );
 170         xFrame->setComponent( xWindow, uno::Reference < frame::XController >() );
 171         return mxPlugin.is() ? TRUE : FALSE;
 172     }
 173
 174     return FALSE;
 175 }
 176
 177 void SAL_CALL PluginObject::cancel() throw( com::sun::star::uno::RuntimeException )
 178 {
 179     uno::Reference< lang::XComponent > xComp( mxPlugin, uno::UNO_QUERY );
 180     if (xComp.is())
 181         xComp->dispose();
 182     mxPlugin = 0;
 183 }
 184
 185 void SAL_CALL PluginObject::close( sal_Bool /*bDeliverOwnership*/ ) throw( com::sun::star::util::CloseVetoException, com::sun::star::uno::RuntimeException )
 186 {
 187 }
 188
 189 void SAL_CALL PluginObject::addCloseListener( const com::sun::star::uno::Reference < com::sun::star::util::XCloseListener >& ) throw( com::sun::star::uno::RuntimeException )
 190 {
 191 }
 192
 193 void SAL_CALL PluginObject::removeCloseListener( const com::sun::star::uno::Reference < com::sun::star::util::XCloseListener >& ) throw( com::sun::star::uno::RuntimeException )
 194 {
 195 }
 196
 197 void SAL_CALL PluginObject::disposing( const com::sun::star::lang::EventObject& ) throw (com::sun::star::uno::RuntimeException)
 198 {
 199     cancel();
 200 }
 201
 202 uno::Reference< beans::XPropertySetInfo > SAL_CALL PluginObject::getPropertySetInfo() throw( ::com::sun::star::uno::RuntimeException )
 203 {
 204     static uno::Reference< beans::XPropertySetInfo > xInfo = new SfxItemPropertySetInfo( &maPropMap );
 205     return xInfo;
 206 }
 207
 208 void SAL_CALL PluginObject::setPropertyValue(const ::rtl::OUString& aPropertyName, const uno::Any& aAny)
 209     throw ( beans::UnknownPropertyException, beans::PropertyVetoException, lang::IllegalArgumentException, lang::WrappedTargetException, uno::RuntimeException)
 210 {
 211     if ( aPropertyName.equalsAscii("PluginURL") )
 212     {
 213         aAny >>= maURL;
 214     }
 215     else if ( aPropertyName.equalsAscii("PluginMimeType") )
 216     {
 217         aAny >>= maMimeType;
 218     }
 219     else if ( aPropertyName.equalsAscii("PluginCommands") )
 220     {
 221         maCmdList.Clear();
 222         uno::Sequence < beans::PropertyValue > aCommandSequence;
 223         if( aAny >>= aCommandSequence )
 224             maCmdList.FillFromSequence( aCommandSequence );
 225     }
 226     else
 227          throw beans::UnknownPropertyException();
 228 }
 229
 230 uno::Any SAL_CALL PluginObject::getPropertyValue(const ::rtl::OUString& aPropertyName)
 231         throw ( beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException)
 232 {
 233     uno::Any aAny;
 234     if ( aPropertyName.equalsAscii("PluginURL") )
 235     {
 236         aAny <<= maURL;
 237     }
 238     else if ( aPropertyName.equalsAscii("PluginMimeType") )
 239     {
 240         aAny <<= maMimeType;
 241     }
 242     else if ( aPropertyName.equalsAscii("PluginCommands") )
 243     {
 244         uno::Sequence< beans::PropertyValue > aCommandSequence;
 245         maCmdList.FillSequence( aCommandSequence );
 246         aAny <<= aCommandSequence;
 247     }
 248     else
 249          throw beans::UnknownPropertyException();
 250     return aAny;
 251 }
 252
 253 void SAL_CALL PluginObject::addPropertyChangeListener(const ::rtl::OUString&, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener > & ) throw( ::com::sun::star::uno::RuntimeException )
 254 {
 255 }
 256
 257 void SAL_CALL PluginObject::removePropertyChangeListener(const ::rtl::OUString&, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener > & ) throw( ::com::sun::star::uno::RuntimeException )
 258 {
 259 }
 260
 261 void SAL_CALL PluginObject::addVetoableChangeListener(const ::rtl::OUString&, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener > & ) throw( ::com::sun::star::uno::RuntimeException )
 262 {
 263 }
 264
 265 void SAL_CALL PluginObject::removeVetoableChangeListener(const ::rtl::OUString&, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener > & ) throw( ::com::sun::star::uno::RuntimeException )
 266 {
 267 }
 268
 269 }