vbahelper/source/msforms/vbacontrols.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$
  10  * $Revision$
  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 #include "vbacontrols.hxx"
  32 #include <cppuhelper/implbase2.hxx>
  33 #include <com/sun/star/awt/XControlContainer.hpp>
  34 #include <ooo/vba//XControlProvider.hpp>
  35 #include <hash_map>
  36
  37 using namespace com::sun::star;
  38 using namespace ooo::vba;
  39
  40
  41 typedef ::cppu::WeakImplHelper2< container::XNameAccess, container::XIndexAccess > ArrayWrapImpl;
  42
  43 typedef  std::hash_map< rtl::OUString, sal_Int32, ::rtl::OUStringHash,
  44     ::std::equal_to< ::rtl::OUString >  > ControlIndexMap;
  45 typedef  std::vector< uno::Reference< awt::XControl > > ControlVec;
  46
  47 class ControlArrayWrapper : public ArrayWrapImpl
  48 {
  49     uno::Reference< awt::XControlContainer > mxDialog;
  50     uno::Sequence< ::rtl::OUString > msNames;
  51     ControlVec mControls;
  52     ControlIndexMap mIndices;
  53
  54     rtl::OUString getControlName( const uno::Reference< awt::XControl >& xCtrl )
  55     {
  56         uno::Reference< beans::XPropertySet > xProp( xCtrl->getModel(), uno::UNO_QUERY );
  57         rtl::OUString sName;
  58         xProp->getPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Name" ) ) ) >>= sName;
  59         return sName;
  60     }
  61
  62 public:
  63
  64     ControlArrayWrapper( const uno::Reference< awt::XControl >& xDialog )
  65     {
  66         mxDialog.set( xDialog, uno::UNO_QUERY_THROW );
  67         uno::Sequence< uno::Reference< awt::XControl > > sXControls = mxDialog->getControls();
  68
  69         msNames.realloc( sXControls.getLength() );
  70         for ( sal_Int32 i = 0; i < sXControls.getLength(); ++i )
  71         {
  72             uno::Reference< awt::XControl > xCtrl = sXControls[ i ];
  73             msNames[ i ] = getControlName( xCtrl );
  74             mControls.push_back( xCtrl );
  75             mIndices[ msNames[ i ] ] = i;
  76         }
  77     }
  78
  79     // XElementAccess
  80     virtual uno::Type SAL_CALL getElementType(  ) throw (uno::RuntimeException)
  81     {
  82         return awt::XControl::static_type(0);
  83     }
  84
  85     virtual ::sal_Bool SAL_CALL hasElements(  ) throw (uno::RuntimeException)
  86     {
  87         return ( mControls.size() > 0 );
  88     }
  89
  90     // XNameAcess
  91     virtual uno::Any SAL_CALL getByName( const ::rtl::OUString& aName ) throw (container::NoSuchElementException, lang::WrappedTargetException, uno::RuntimeException)
  92     {
  93         if ( !hasByName( aName ) )
  94             throw container::NoSuchElementException();
  95         return getByIndex( mIndices[ aName ] );
  96     }
  97
  98     virtual uno::Sequence< ::rtl::OUString > SAL_CALL getElementNames(  ) throw (uno::RuntimeException)
  99     {
 100         return msNames;
 101     }
 102
 103     virtual ::sal_Bool SAL_CALL hasByName( const ::rtl::OUString& aName ) throw (css::uno::RuntimeException)
 104     {
 105         ControlIndexMap::iterator it = mIndices.find( aName );
 106         return it != mIndices.end();
 107     }
 108
 109     // XElementAccess
 110     virtual ::sal_Int32 SAL_CALL getCount(  ) throw (css::uno::RuntimeException)
 111     {
 112         return mControls.size();
 113     }
 114
 115     virtual uno::Any SAL_CALL getByIndex( ::sal_Int32 Index ) throw (lang::IndexOutOfBoundsException, lang::WrappedTargetException, uno::RuntimeException )
 116     {
 117         if ( Index < 0 || Index >= static_cast< sal_Int32 >( mControls.size() ) )
 118             throw lang::IndexOutOfBoundsException();
 119         return uno::makeAny( mControls[ Index ] );
 120     }
 121 };
 122
 123
 124 class ControlsEnumWrapper : public EnumerationHelper_BASE
 125 {
 126     uno::Reference<XHelperInterface > m_xParent;
 127     uno::Reference<uno::XComponentContext > m_xContext;
 128     uno::Reference<container::XIndexAccess > m_xIndexAccess;
 129     uno::Reference<awt::XControl > m_xDlg;
 130     sal_Int32 nIndex;
 131
 132 public:
 133
 134     ControlsEnumWrapper(  const uno::Reference< XHelperInterface >& xParent, const uno::Reference< uno::XComponentContext >& xContext, const uno::Reference< container::XIndexAccess >& xIndexAccess, const uno::Reference< awt::XControl >& xDlg ) :  m_xParent( xParent ), m_xContext( xContext), m_xIndexAccess( xIndexAccess ), m_xDlg( xDlg ), nIndex( 0 ) {}
 135
 136     virtual ::sal_Bool SAL_CALL hasMoreElements(  ) throw (uno::RuntimeException)
 137     {
 138         return ( nIndex < m_xIndexAccess->getCount() );
 139     }
 140
 141     virtual uno::Any SAL_CALL nextElement(  ) throw (container::NoSuchElementException, lang::WrappedTargetException, uno::RuntimeException)
 142     {
 143         if ( nIndex < m_xIndexAccess->getCount() )
 144         {
 145             uno::Reference< frame::XModel > xModel;
 146             uno::Reference< awt::XControl > xControl;
 147             m_xIndexAccess->getByIndex( nIndex++ ) >>= xControl;
 148
 149         uno::Reference<lang::XMultiComponentFactory > xServiceManager( m_xContext->getServiceManager(), uno::UNO_QUERY_THROW );
 150         uno::Reference< XControlProvider > xControlProvider( xServiceManager->createInstanceWithContext( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "ooo.vba.ControlProvider" ) ), m_xContext ), uno::UNO_QUERY_THROW );
 151
 152         uno::Reference< msforms::XControl > xVBAControl( xControlProvider->createUserformControl(  xControl, m_xDlg, xModel ) );
 153             return uno::makeAny( xVBAControl );
 154         }
 155         throw container::NoSuchElementException();
 156     }
 157
 158 };
 159
 160
 161 uno::Reference<container::XIndexAccess >
 162 lcl_controlsWrapper( const uno::Reference< awt::XControl >& xDlg )
 163 {
 164     return new ControlArrayWrapper( xDlg );
 165 }
 166
 167 ScVbaControls::ScVbaControls( const uno::Reference< XHelperInterface >& xParent, const uno::Reference< uno::XComponentContext >& xContext,
 168                 const css::uno::Reference< awt::XControl >& xDialog )
 169             : ControlsImpl_BASE( xParent, xContext, lcl_controlsWrapper( xDialog  ) )
 170 {
 171     mxDialog.set( xDialog, uno::UNO_QUERY_THROW );
 172 }
 173
 174 uno::Reference< container::XEnumeration >
 175 ScVbaControls::createEnumeration() throw (uno::RuntimeException)
 176 {
 177     uno::Reference< container::XEnumeration > xEnum( new ControlsEnumWrapper( mxParent, mxContext, m_xIndexAccess, mxDialog ) );
 178     if ( !xEnum.is() )
 179         throw uno::RuntimeException();
 180     return xEnum;
 181 }
 182
 183 uno::Any
 184 ScVbaControls::createCollectionObject( const css::uno::Any& aSource )
 185 {
 186     // Create control from awt::XControl
 187     uno::Reference< awt::XControl > xControl;
 188     aSource >>= xControl;
 189     uno::Reference< frame::XModel > xModel;
 190     uno::Reference<lang::XMultiComponentFactory > xServiceManager( mxContext->getServiceManager(), uno::UNO_QUERY_THROW );
 191     uno::Reference< XControlProvider > xControlProvider( xServiceManager->createInstanceWithContext( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "ooo.vba.ControlProvider" ) ), mxContext ), uno::UNO_QUERY_THROW );
 192
 193     uno::Reference< msforms::XControl > xVBAControl( xControlProvider->createUserformControl(  xControl, mxDialog, xModel ) );
 194
 195     return uno::makeAny( xVBAControl );
 196 }
 197
 198 void SAL_CALL
 199 ScVbaControls::Move( double cx, double cy ) throw (uno::RuntimeException)
 200 {
 201     uno::Reference< container::XEnumeration > xEnum( createEnumeration() );
 202     while ( xEnum->hasMoreElements() )
 203     {
 204         uno::Reference< msforms::XControl > xControl( xEnum->nextElement(), uno::UNO_QUERY_THROW );
 205         xControl->setLeft( xControl->getLeft() + cx );
 206         xControl->setTop( xControl->getTop() + cy );
 207     }
 208 }
 209
 210 uno::Type
 211 ScVbaControls::getElementType() throw (uno::RuntimeException)
 212 {
 213     return ooo::vba::msforms::XControl::static_type(0);
 214 }
 215 rtl::OUString&
 216 ScVbaControls::getServiceImplName()
 217 {
 218         static rtl::OUString sImplName( RTL_CONSTASCII_USTRINGPARAM("ScVbaControls") );
 219         return sImplName;
 220 }
 221
 222 uno::Sequence< rtl::OUString >
 223 ScVbaControls::getServiceNames()
 224 {
 225         static uno::Sequence< rtl::OUString > aServiceNames;
 226         if ( aServiceNames.getLength() == 0 )
 227         {
 228                 aServiceNames.realloc( 1 );
 229                 aServiceNames[ 0 ] = rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("ooo.vba.excel.Controls" ) );
 230         }
 231         return aServiceNames;
 232 }