sc/source/ui/vba/vbaworksheets.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: vbaworksheets.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 #include "vbaworksheets.hxx"
  31
  32 #include <sfx2/dispatch.hxx>
  33 #include <sfx2/app.hxx>
  34 #include <sfx2/bindings.hxx>
  35 #include <sfx2/request.hxx>
  36 #include <sfx2/viewfrm.hxx>
  37 #include <sfx2/itemwrapper.hxx>
  38 #include <svtools/itemset.hxx>
  39 #include <svtools/eitem.hxx>
  40
  41 #include <comphelper/processfactory.hxx>
  42 #include <cppuhelper/implbase3.hxx>
  43
  44 #include <com/sun/star/sheet/XSpreadsheetDocument.hpp>
  45 #include <com/sun/star/container/XEnumerationAccess.hpp>
  46 #include <com/sun/star/sheet/XSpreadsheetView.hpp>
  47 #include <com/sun/star/container/XNamed.hpp>
  48 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  49 #include <com/sun/star/beans/XPropertySet.hpp>
  50
  51 #include <ooo/vba/excel/XApplication.hpp>
  52 #include <tools/string.hxx>
  53 #include "tabvwsh.hxx"
  54
  55 #include "vbaglobals.hxx"
  56 #include "vbaworksheet.hxx"
  57 #include "vbaworkbook.hxx"
  58
  59 using namespace ::ooo::vba;
  60 using namespace ::com::sun::star;
  61
  62
  63 typedef ::cppu::WeakImplHelper1< container::XEnumeration > SheetEnumeration_BASE;
  64 typedef ::cppu::WeakImplHelper3< container::XNameAccess, container::XIndexAccess, container::XEnumerationAccess > SheetCollectionHelper_BASE;
  65 // a map ( or hashmap ) wont do as we need also to preserve the order
  66 // (as added ) of the items
  67 typedef std::vector< uno::Reference< sheet::XSpreadsheet > >  SheetMap;
  68
  69 class WorkSheetsEnumeration : public SheetEnumeration_BASE
  70 {
  71     SheetMap mSheetMap;
  72     SheetMap::iterator mIt;
  73 public:
  74     WorkSheetsEnumeration( const SheetMap& sMap ) : mSheetMap( sMap ), mIt( mSheetMap.begin() ) {}
  75     virtual ::sal_Bool SAL_CALL hasMoreElements(  ) throw (uno::RuntimeException)
  76     {
  77         return ( mIt != mSheetMap.end() );
  78     }
  79     virtual uno::Any SAL_CALL nextElement(  ) throw (container::NoSuchElementException, lang::WrappedTargetException, uno::RuntimeException)
  80     {
  81         if ( !hasMoreElements() )
  82             throw container::NoSuchElementException();
  83         uno::Reference< sheet::XSpreadsheet > xSheet( *mIt++ );
  84         return uno::makeAny( xSheet ) ;
  85     }
  86 };
  87
  88 class SheetCollectionHelper : public SheetCollectionHelper_BASE
  89 {
  90     SheetMap mSheetMap;
  91     SheetMap::iterator cachePos;
  92 public:
  93     SheetCollectionHelper( const SheetMap& sMap ) : mSheetMap( sMap ), cachePos(mSheetMap.begin()) {}
  94     // XElementAccess
  95     virtual uno::Type SAL_CALL getElementType(  ) throw (uno::RuntimeException) { return  sheet::XSpreadsheet::static_type(0); }
  96     virtual ::sal_Bool SAL_CALL hasElements(  ) throw (uno::RuntimeException) { return ( mSheetMap.size() > 0 ); }
  97     // XNameAcess
  98     virtual uno::Any SAL_CALL getByName( const ::rtl::OUString& aName ) throw (container::NoSuchElementException, lang::WrappedTargetException, uno::RuntimeException)
  99     {
 100         if ( !hasByName(aName) )
 101             throw container::NoSuchElementException();
 102         return uno::makeAny( *cachePos );
 103     }
 104     virtual uno::Sequence< ::rtl::OUString > SAL_CALL getElementNames(  ) throw (uno::RuntimeException)
 105     {
 106         uno::Sequence< rtl::OUString > sNames( mSheetMap.size() );
 107         rtl::OUString* pString = sNames.getArray();
 108         SheetMap::iterator it = mSheetMap.begin();
 109         SheetMap::iterator it_end = mSheetMap.end();
 110
 111         for ( ; it != it_end; ++it, ++pString )
 112         {
 113             uno::Reference< container::XNamed > xName( *it, uno::UNO_QUERY_THROW );
 114             *pString = xName->getName();
 115         }
 116         return sNames;
 117     }
 118     virtual ::sal_Bool SAL_CALL hasByName( const ::rtl::OUString& aName ) throw (uno::RuntimeException)
 119     {
 120         cachePos = mSheetMap.begin();
 121         SheetMap::iterator it_end = mSheetMap.end();
 122         for ( ; cachePos != it_end; ++cachePos )
 123         {
 124             uno::Reference< container::XNamed > xName( *cachePos, uno::UNO_QUERY_THROW );
 125             if ( aName.equals( xName->getName() ) )
 126                 break;
 127         }
 128         return ( cachePos != it_end );
 129     }
 130
 131     // XElementAccess
 132     virtual ::sal_Int32 SAL_CALL getCount(  ) throw (uno::RuntimeException) { return mSheetMap.size(); }
 133     virtual uno::Any SAL_CALL getByIndex( ::sal_Int32 Index ) throw (lang::IndexOutOfBoundsException, lang::WrappedTargetException, uno::RuntimeException )
 134     {
 135         if ( Index < 0 || Index >= getCount() )
 136             throw lang::IndexOutOfBoundsException();
 137
 138         return uno::makeAny( mSheetMap[ Index ] );
 139
 140     }
 141     // XEnumerationAccess
 142     virtual uno::Reference< container::XEnumeration > SAL_CALL createEnumeration(  ) throw (uno::RuntimeException)
 143     {
 144         return new WorkSheetsEnumeration( mSheetMap );
 145     }
 146 };
 147
 148 class SheetsEnumeration : public EnumerationHelperImpl
 149 {
 150     uno::Reference< frame::XModel > m_xModel;
 151     uno::WeakReference< XHelperInterface > m_xParent;
 152 public:
 153     SheetsEnumeration( const uno::Reference< XHelperInterface >& xParent, const uno::Reference< uno::XComponentContext >& xContext, const uno::Reference< container::XEnumeration >& xEnumeration,  const uno::Reference< frame::XModel >& xModel  ) throw ( uno::RuntimeException ) : EnumerationHelperImpl( xContext, xEnumeration ), m_xModel( xModel ), m_xParent( xParent ) {}
 154
 155     virtual uno::Any SAL_CALL nextElement(  ) throw (container::NoSuchElementException, lang::WrappedTargetException, uno::RuntimeException)
 156     {
 157         uno::Reference< sheet::XSpreadsheet > xSheet( m_xEnumeration->nextElement(), uno::UNO_QUERY_THROW );
 158         return uno::makeAny( uno::Reference< excel::XWorksheet > ( new ScVbaWorksheet( m_xParent, m_xContext, xSheet, m_xModel ) ) );
 159     }
 160
 161 };
 162
 163 ScVbaWorksheets::ScVbaWorksheets( const uno::Reference< XHelperInterface >& xParent, const uno::Reference< ::com::sun::star::uno::XComponentContext > & xContext, const uno::Reference< container::XIndexAccess >& xSheets, const uno::Reference< frame::XModel >& xModel ): ScVbaWorksheets_BASE( xParent, xContext,  xSheets ), mxModel( xModel ), m_xSheets( uno::Reference< sheet::XSpreadsheets >( xSheets, uno::UNO_QUERY ) )
 164 {
 165 }
 166
 167 ScVbaWorksheets::ScVbaWorksheets( const uno::Reference< XHelperInterface >& xParent, const uno::Reference< ::com::sun::star::uno::XComponentContext > & xContext, const uno::Reference< container::XEnumerationAccess >& xEnumAccess, const uno::Reference< frame::XModel >& xModel  ):  ScVbaWorksheets_BASE( xParent, xContext, uno::Reference< container::XIndexAccess >( xEnumAccess, uno::UNO_QUERY ) ), mxModel(xModel)
 168 {
 169 }
 170
 171 // XEnumerationAccess
 172 uno::Type
 173 ScVbaWorksheets::getElementType() throw (uno::RuntimeException)
 174 {
 175     return excel::XWorksheet::static_type(0);
 176 }
 177
 178 uno::Reference< container::XEnumeration >
 179 ScVbaWorksheets::createEnumeration() throw (uno::RuntimeException)
 180 {
 181     if ( !m_xSheets.is() )
 182     {
 183         uno::Reference< container::XEnumerationAccess > xAccess( m_xIndexAccess, uno::UNO_QUERY_THROW );
 184         return xAccess->createEnumeration();
 185     }
 186     uno::Reference< container::XEnumerationAccess > xEnumAccess( m_xSheets, uno::UNO_QUERY_THROW );
 187     return new SheetsEnumeration( this, mxContext, xEnumAccess->createEnumeration(), mxModel );
 188 }
 189
 190 uno::Any
 191 ScVbaWorksheets::createCollectionObject( const uno::Any& aSource )
 192 {
 193     uno::Reference< sheet::XSpreadsheet > xSheet( aSource, uno::UNO_QUERY );
 194     return uno::makeAny( uno::Reference< excel::XWorksheet > ( new ScVbaWorksheet( getParent(), mxContext, xSheet, mxModel ) ) );
 195 }
 196
 197 // XWorksheets
 198 uno::Any
 199 ScVbaWorksheets::Add( const uno::Any& Before, const uno::Any& After,
 200                      const uno::Any& Count, const uno::Any& Type ) throw (uno::RuntimeException)
 201 {
 202     if ( isSelectedSheets() )
 203         return uno::Any(); // or should we throw?
 204
 205     rtl::OUString aStringSheet;
 206     sal_Bool bBefore(sal_True);
 207     SCTAB nSheetIndex = 0;
 208     SCTAB nNewSheets = 1, nType = 0;
 209     Count >>= nNewSheets;
 210     Type >>= nType;
 211     SCTAB nCount = 0;
 212
 213         uno::Reference< excel::XWorksheet > xBeforeAfterSheet;
 214
 215         if ( Before.hasValue() )
 216         {
 217                 if ( Before >>= xBeforeAfterSheet )
 218                         aStringSheet = xBeforeAfterSheet->getName();
 219                 else
 220     Before >>= aStringSheet;
 221         }
 222
 223         if (!aStringSheet.getLength() && After.hasValue() )
 224     {
 225                 if ( After >>= xBeforeAfterSheet )
 226                         aStringSheet = xBeforeAfterSheet->getName();
 227                 else
 228         After >>= aStringSheet;
 229         bBefore = sal_False;
 230     }
 231     if (!aStringSheet.getLength())
 232     {
 233                 uno::Reference< excel::XApplication > xApplication( Application(), uno::UNO_QUERY_THROW );
 234                 aStringSheet = xApplication->getActiveWorkbook()->getActiveSheet()->getName();
 235         bBefore = sal_True;
 236     }
 237         nCount = static_cast< SCTAB >( m_xIndexAccess->getCount() );
 238         for (SCTAB i=0; i < nCount; i++)
 239         {
 240             uno::Reference< sheet::XSpreadsheet > xSheet(m_xIndexAccess->getByIndex(i), uno::UNO_QUERY);
 241             uno::Reference< container::XNamed > xNamed( xSheet, uno::UNO_QUERY_THROW );
 242             if (xNamed->getName() == aStringSheet)
 243             {
 244                 nSheetIndex = i;
 245                 break;
 246             }
 247         }
 248
 249     if(!bBefore)
 250         nSheetIndex++;
 251
 252     SCTAB nSheetName = nCount + 1L;
 253     String aStringBase( RTL_CONSTASCII_USTRINGPARAM("Sheet") );
 254     uno::Any result;
 255     for (SCTAB i=0; i < nNewSheets; i++, nSheetName++)
 256     {
 257         String aStringName = aStringBase;
 258         aStringName += String::CreateFromInt32(nSheetName);
 259         while (m_xNameAccess->hasByName(aStringName))
 260         {
 261             nSheetName++;
 262             aStringName = aStringBase;
 263             aStringName += String::CreateFromInt32(nSheetName);
 264         }
 265         m_xSheets->insertNewByName(aStringName, nSheetIndex + i);
 266         result = getItemByStringIndex( aStringName );
 267     }
 268         uno::Reference< excel::XWorksheet > xNewSheet( result, uno::UNO_QUERY );
 269         if ( xNewSheet.is() )
 270                 xNewSheet->Activate();
 271     return  result;
 272 }
 273
 274 void
 275 ScVbaWorksheets::Delete() throw (uno::RuntimeException)
 276 {
 277     // #TODO #INVESTIGATE
 278     // mmm this method could be trouble if the underlying
 279     // uno objects ( the m_xIndexAccess etc ) aren't aware of the
 280     // contents that are deleted
 281     sal_Int32 nElems = getCount();
 282     for ( sal_Int32 nItem = 1; nItem <= nElems; ++nItem )
 283     {
 284         uno::Reference< excel::XWorksheet > xSheet( Item( uno::makeAny( nItem ), uno::Any() ), uno::UNO_QUERY_THROW );
 285         xSheet->Delete();
 286     }
 287 }
 288
 289 bool
 290 ScVbaWorksheets::isSelectedSheets()
 291 {
 292     return !m_xSheets.is();
 293 }
 294
 295 void SAL_CALL
 296 ScVbaWorksheets::PrintOut( const uno::Any& From, const uno::Any& To, const uno::Any& Copies, const uno::Any& Preview, const uno::Any& ActivePrinter, const uno::Any& PrintToFile, const uno::Any& Collate, const uno::Any& PrToFileName ) throw (uno::RuntimeException)
 297 {
 298     sal_Int32 nTo = 0;
 299     sal_Int32 nFrom = 0;
 300     sal_Int16 nCopies = 1;
 301     sal_Bool bCollate = sal_False;
 302     sal_Bool bSelection = sal_False;
 303     From >>= nFrom;
 304     To >>= nTo;
 305     Copies >>= nCopies;
 306     if ( nCopies > 1 ) // Collate only useful when more that 1 copy
 307         Collate >>= bCollate;
 308
 309     if ( !( nFrom || nTo ) )
 310         if ( isSelectedSheets() )
 311             bSelection = sal_True;
 312
 313         PrintOutHelper( excel::getBestViewShell( mxModel ), From, To, Copies, Preview, ActivePrinter, PrintToFile, Collate, PrToFileName, bSelection );
 314 }
 315
 316 uno::Any SAL_CALL
 317 ScVbaWorksheets::getVisible() throw (uno::RuntimeException)
 318 {
 319     sal_Bool bVisible = sal_True;
 320     uno::Reference< container::XEnumeration > xEnum( createEnumeration(), uno::UNO_QUERY_THROW );
 321     while ( xEnum->hasMoreElements() )
 322     {
 323         uno::Reference< excel::XWorksheet > xSheet( xEnum->nextElement(), uno::UNO_QUERY_THROW );
 324         if ( xSheet->getVisible() == sal_False )
 325         {
 326                 bVisible = sal_False;
 327                 break;
 328         }
 329     }
 330     return uno::makeAny( bVisible );
 331 }
 332
 333 void SAL_CALL
 334 ScVbaWorksheets::setVisible( const uno::Any& _visible ) throw (uno::RuntimeException)
 335 {
 336     sal_Bool bState = sal_False;
 337     if ( _visible >>= bState )
 338     {
 339         uno::Reference< container::XEnumeration > xEnum( createEnumeration(), uno::UNO_QUERY_THROW );
 340         while ( xEnum->hasMoreElements() )
 341         {
 342             uno::Reference< excel::XWorksheet > xSheet( xEnum->nextElement(), uno::UNO_QUERY_THROW );
 343             xSheet->setVisible( bState );
 344         }
 345     }
 346     else
 347         throw uno::RuntimeException( rtl::OUString(
 348             RTL_CONSTASCII_USTRINGPARAM( "Visible property doesn't support non boolean #FIXME" ) ), uno::Reference< uno::XInterface >() );
 349 }
 350
 351 void SAL_CALL
 352 ScVbaWorksheets::Select( const uno::Any& Replace ) throw (uno::RuntimeException)
 353 {
 354         ScTabViewShell* pViewShell = excel::getBestViewShell( mxModel );
 355     if ( !pViewShell )
 356         throw uno::RuntimeException( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Cannot obtain view shell" ) ), uno::Reference< uno::XInterface >() );
 357
 358     ScMarkData& rMarkData = pViewShell->GetViewData()->GetMarkData();
 359     sal_Bool bReplace = sal_True;
 360     Replace >>= bReplace;
 361     // Replace is defaulted to True, meanining this current collection
 362     // becomes the Selection, if it were false then the current selection would
 363     // be extended
 364     bool bSelectSingle = bReplace;
 365     sal_Int32 nElems = getCount();
 366     for ( sal_Int32 nItem = 1; nItem <= nElems; ++nItem )
 367     {
 368         uno::Reference< excel::XWorksheet > xSheet( Item( uno::makeAny( nItem ), uno::Any() ), uno::UNO_QUERY_THROW );
 369         ScVbaWorksheet* pSheet = dynamic_cast< ScVbaWorksheet* >( xSheet.get() );
 370         if ( pSheet )
 371         {
 372             if ( bSelectSingle )
 373             {
 374                 rMarkData.SelectOneTable( static_cast< SCTAB >( pSheet->getSheetID() ) );
 375                 bSelectSingle = false;
 376             }
 377             else
 378                 rMarkData.SelectTable( static_cast< SCTAB >( pSheet->getSheetID() ), TRUE );
 379
 380         }
 381     }
 382
 383
 384 }
 385
 386 //ScVbaCollectionBaseImpl
 387 uno::Any SAL_CALL
 388 ScVbaWorksheets::Item( const uno::Any& Index, const uno::Any& Index2  ) throw (uno::RuntimeException)
 389 {
 390     if ( Index.getValueTypeClass() == uno::TypeClass_SEQUENCE )
 391     {
 392         uno::Reference< script::XTypeConverter > xConverter = getTypeConverter(mxContext);
 393         uno::Any aConverted;
 394         aConverted = xConverter->convertTo( Index, getCppuType((uno::Sequence< uno::Any >*)0) );
 395         SheetMap mSheets;
 396         uno::Sequence< uno::Any > sIndices;
 397         aConverted >>= sIndices;
 398         sal_Int32 nElems = sIndices.getLength();
 399         for( sal_Int32 index = 0; index < nElems; ++index )
 400         {
 401             uno::Reference< excel::XWorksheet > xWorkSheet( ScVbaWorksheets_BASE::Item( sIndices[ index ], Index2 ), uno::UNO_QUERY_THROW );
 402             ScVbaWorksheet* pWorkSheet = dynamic_cast< ScVbaWorksheet* >( xWorkSheet.get() );
 403             if ( pWorkSheet )
 404             {
 405                 uno::Reference< sheet::XSpreadsheet > xSheet( pWorkSheet->getSheet() , uno::UNO_QUERY_THROW );
 406                 uno::Reference< container::XNamed > xName( xSheet, uno::UNO_QUERY_THROW );
 407                 mSheets.push_back( xSheet );
 408             }
 409         }
 410         uno::Reference< container::XIndexAccess > xIndexAccess = new SheetCollectionHelper( mSheets );
 411         uno::Reference< XCollection > xSelectedSheets(  new ScVbaWorksheets( this->getParent(), mxContext, xIndexAccess, mxModel ) );
 412         return uno::makeAny( xSelectedSheets );
 413     }
 414     return      ScVbaWorksheets_BASE::Item( Index, Index2 );
 415 }
 416
 417 uno::Any
 418 ScVbaWorksheets::getItemByStringIndex( const rtl::OUString& sIndex ) throw (uno::RuntimeException)
 419 {
 420     return ScVbaWorksheets_BASE::getItemByStringIndex( sIndex );
 421 }
 422
 423 rtl::OUString&
 424 ScVbaWorksheets::getServiceImplName()
 425 {
 426     static rtl::OUString sImplName( RTL_CONSTASCII_USTRINGPARAM("ScVbaWorksheets") );
 427     return sImplName;
 428 }
 429
 430 css::uno::Sequence<rtl::OUString>
 431 ScVbaWorksheets::getServiceNames()
 432 {
 433     static uno::Sequence< rtl::OUString > sNames;
 434     if ( sNames.getLength() == 0 )
 435     {
 436         sNames.realloc( 1 );
 437         sNames[0] = rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("ooo.vba.excel.Worksheets") );
 438     }
 439     return sNames;
 440 }