sc/source/ui/vba/vbaformatconditions.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: vbaformatconditions.cxx,v $
  10  * $Revision: 1.3 $
  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 <ooo/vba/excel/XRange.hpp>
  32 #include <com/sun/star/sheet/XCellRangeAddressable.hpp>
  33 #include <com/sun/star/sheet/XSheetConditionalEntry.hpp>
  34 #include <vector>
  35 #include "vbaformatconditions.hxx"
  36 #include "vbaformatcondition.hxx"
  37 #include "vbaworkbook.hxx"
  38 #include "vbastyles.hxx"
  39 #include "vbaglobals.hxx"
  40 using namespace ::ooo::vba;
  41 using namespace ::com::sun::star;
  42
  43 typedef std::vector< beans::PropertyValue > VecPropValues;
  44
  45 static rtl::OUString OPERATOR( RTL_CONSTASCII_USTRINGPARAM("Operator") );
  46 static rtl::OUString FORMULA1( RTL_CONSTASCII_USTRINGPARAM("Formula1") );
  47 static rtl::OUString FORMULA2( RTL_CONSTASCII_USTRINGPARAM("Formula2") );
  48 static rtl::OUString STYLENAME( RTL_CONSTASCII_USTRINGPARAM("StyleName") );
  49 static rtl::OUString sStyleNamePrefix( RTL_CONSTASCII_USTRINGPARAM("Excel_CondFormat") );
  50
  51 ScVbaFormatConditions::ScVbaFormatConditions( const uno::Reference< XHelperInterface >& xParent, const uno::Reference< uno::XComponentContext > & xContext, const uno::Reference< sheet::XSheetConditionalEntries >& _xSheetConditionalEntries, const uno::Reference< frame::XModel >& xModel ) : ScVbaFormatConditions_BASE( xParent, xContext, uno::Reference< container::XIndexAccess >( _xSheetConditionalEntries, uno::UNO_QUERY_THROW ) ), mxSheetConditionalEntries( _xSheetConditionalEntries )
  52 {
  53     mxRangeParent.set( xParent, uno::UNO_QUERY_THROW );
  54         uno::Reference< excel::XWorkbook > xWorkbook = new ScVbaWorkbook(  uno::Reference< XHelperInterface >( Application(), uno::UNO_QUERY_THROW ), xContext, xModel );
  55     mxStyles.set( xWorkbook->Styles( uno::Any() ), uno::UNO_QUERY_THROW );
  56     uno::Reference< sheet::XCellRangeAddressable > xCellRange( mxRangeParent->getCellRange(), uno::UNO_QUERY_THROW );
  57     mxParentRangePropertySet.set( xCellRange, uno::UNO_QUERY_THROW );
  58
  59     table::CellRangeAddress rangeAddress = xCellRange->getRangeAddress();
  60     maCellAddress = table::CellAddress( rangeAddress.Sheet, rangeAddress.StartColumn,  rangeAddress.StartRow );
  61 }
  62
  63 void SAL_CALL
  64 ScVbaFormatConditions::Delete(  ) throw (script::BasicErrorException, uno::RuntimeException)
  65 {
  66     try
  67     {
  68         ScVbaStyles* pStyles = static_cast< ScVbaStyles* >( mxStyles.get() );
  69         if ( !pStyles )
  70             DebugHelper::exception(SbERR_METHOD_FAILED, rtl::OUString() );
  71         sal_Int32 nCount = mxSheetConditionalEntries->getCount();
  72         for (sal_Int32 i = nCount - 1; i >= 0; i--)
  73         {
  74             uno::Reference< sheet::XSheetConditionalEntry > xSheetConditionalEntry( mxSheetConditionalEntries->getByIndex(i), uno::UNO_QUERY_THROW );
  75             pStyles->Delete(xSheetConditionalEntry->getStyleName());
  76             mxSheetConditionalEntries->removeByIndex(i);
  77         }
  78         notifyRange();
  79     }
  80     catch (uno::Exception& )
  81     {
  82         DebugHelper::exception(SbERR_METHOD_FAILED, rtl::OUString());
  83     }
  84 }
  85
  86 uno::Type SAL_CALL
  87 ScVbaFormatConditions::getElementType() throw (css::uno::RuntimeException)
  88 {
  89     return excel::XFormatCondition::static_type(0);
  90 }
  91
  92
  93 uno::Any xSheetConditionToFormatCondition( const uno::Reference< XHelperInterface >& xRangeParent, const uno::Reference< uno::XComponentContext >& xContext, const uno::Reference< excel::XStyles >& xStyles, const uno::Reference< excel::XFormatConditions >& xFormatConditions, const uno::Reference< beans::XPropertySet >& xRangeProps,  const uno::Any& aObject )
  94 {
  95     uno::Reference< sheet::XSheetConditionalEntry > xSheetConditionalEntry;
  96     aObject >>= xSheetConditionalEntry;
  97
  98     uno::Reference< excel::XStyle > xStyle( xStyles->Item( uno::makeAny( xSheetConditionalEntry->getStyleName() ), uno::Any() ), uno::UNO_QUERY_THROW );
  99     uno::Reference< excel::XFormatCondition > xCondition = new ScVbaFormatCondition( xRangeParent, xContext,  xSheetConditionalEntry, xStyle, xFormatConditions, xRangeProps );
 100     return uno::makeAny( xCondition );
 101 }
 102
 103 uno::Any
 104 ScVbaFormatConditions::createCollectionObject(const uno::Any& aObject )
 105 {
 106     return xSheetConditionToFormatCondition( uno::Reference< XHelperInterface >( mxRangeParent, uno::UNO_QUERY_THROW ), mxContext, mxStyles, this, mxParentRangePropertySet, aObject );
 107 }
 108
 109 class EnumWrapper : public EnumerationHelper_BASE
 110 {
 111         uno::Reference<container::XIndexAccess > m_xIndexAccess;
 112         uno::Reference<excel::XRange > m_xParentRange;
 113         uno::Reference<uno::XComponentContext > m_xContext;
 114         uno::Reference<excel::XStyles > m_xStyles;
 115         uno::Reference<excel::XFormatConditions > m_xParentCollection;
 116         uno::Reference<beans::XPropertySet > m_xProps;
 117
 118         sal_Int32 nIndex;
 119 public:
 120         EnumWrapper( const uno::Reference< container::XIndexAccess >& xIndexAccess, const uno::Reference<excel::XRange >& xRange, const uno::Reference<uno::XComponentContext >& xContext, const uno::Reference<excel::XStyles >& xStyles, const uno::Reference< excel::XFormatConditions >& xCollection, const uno::Reference<beans::XPropertySet >& xProps  ) : m_xIndexAccess( xIndexAccess ), m_xParentRange( xRange ), m_xContext( xContext ), m_xStyles( xStyles ), m_xParentCollection( xCollection ), m_xProps( xProps ), nIndex( 0 ) {}
 121         virtual ::sal_Bool SAL_CALL hasMoreElements(  ) throw (uno::RuntimeException)
 122         {
 123                 return ( nIndex < m_xIndexAccess->getCount() );
 124         }
 125
 126         virtual uno::Any SAL_CALL nextElement(  ) throw (container::NoSuchElementException, lang::WrappedTargetException, uno::RuntimeException)
 127         {
 128                 if ( nIndex < m_xIndexAccess->getCount() )
 129                         return xSheetConditionToFormatCondition( uno::Reference< XHelperInterface >( m_xParentRange, uno::UNO_QUERY_THROW ), m_xContext, m_xStyles, m_xParentCollection, m_xProps, m_xIndexAccess->getByIndex( nIndex++ ) );
 130                 throw container::NoSuchElementException();
 131         }
 132 };
 133
 134 uno::Reference< excel::XFormatCondition > SAL_CALL
 135 ScVbaFormatConditions::Add( ::sal_Int32 _nType, const uno::Any& _aOperator, const uno::Any& _aFormula1, const uno::Any& _aFormula2 ) throw (script::BasicErrorException, uno::RuntimeException)
 136 {
 137     return Add( _nType, _aOperator, _aFormula1, _aFormula2, uno::Reference< excel::XStyle >() );
 138 }
 139
 140 uno::Reference< excel::XFormatCondition >
 141 ScVbaFormatConditions::Add( ::sal_Int32 _nType, const uno::Any& _aOperator, const uno::Any& _aFormula1, const uno::Any& _aFormula2, const css::uno::Reference< excel::XStyle >& _xStyle  ) throw (script::BasicErrorException, uno::RuntimeException)
 142 {
 143     // #TODO
 144     // #FIXME
 145     // This method will NOT handle r1c1 formulas [*]and only assumes that
 146     // the formulas are _xlA1 based ( need to hook into calc work ths should
 147     // address this )
 148     // [*] reason: getA1Formula method below is just a hook and just
 149     // returns whats it gets ( e.g. doesn't convert anything )
 150     uno::Reference< excel::XStyle > xStyle( _xStyle );
 151     uno::Reference< excel::XFormatCondition > xFormatCondition;
 152     try
 153     {
 154         rtl::OUString sStyleName;
 155         if ( !xStyle.is() )
 156         {
 157             sStyleName = getStyleName();
 158             xStyle = mxStyles->Add(sStyleName, uno::Any() );
 159         }
 160         else
 161         {
 162             sStyleName = xStyle->getName();
 163         }
 164
 165         VecPropValues aPropertyValueVector;
 166         sheet::ConditionOperator aType = ScVbaFormatCondition::retrieveAPIType(_nType, uno::Reference< sheet::XSheetCondition >() );
 167         uno::Any aValue;
 168
 169         if ( aType == sheet::ConditionOperator_FORMULA)
 170             aValue = uno::makeAny( sheet::ConditionOperator_FORMULA );
 171         else
 172             aValue = uno::makeAny( ScVbaFormatCondition::retrieveAPIOperator(_aOperator) );
 173
 174         beans::PropertyValue aProperty( OPERATOR, 0, aValue, beans::PropertyState_DIRECT_VALUE );
 175         aPropertyValueVector.push_back( aProperty );
 176
 177         if ( _aFormula1.hasValue() )
 178         {
 179             beans::PropertyValue aProp( FORMULA1, 0, uno::makeAny( getA1Formula( _aFormula1 ) ), beans::PropertyState_DIRECT_VALUE );
 180             aPropertyValueVector.push_back( aProp );
 181         }
 182         if ( _aFormula2.hasValue() )
 183         {
 184             beans::PropertyValue aProp( FORMULA2, 0, uno::makeAny( getA1Formula( _aFormula2 ) ), beans::PropertyState_DIRECT_VALUE );
 185             aPropertyValueVector.push_back( aProp );
 186         }
 187         aProperty.Name = STYLENAME;
 188         aProperty.Value = uno::makeAny( sStyleName );
 189
 190         // convert vector to sequence
 191         uno::Sequence< beans::PropertyValue > aPropertyValueList(aPropertyValueVector.size());
 192         VecPropValues::iterator it = aPropertyValueVector.begin();
 193         VecPropValues::iterator it_end = aPropertyValueVector.end();
 194         for ( sal_Int32 index=0; it != it_end; ++it )
 195             aPropertyValueList[ index++ ] = *it;
 196
 197         mxSheetConditionalEntries->addNew(aPropertyValueList);
 198         for (sal_Int32 i = mxSheetConditionalEntries->getCount()-1; i >= 0; i--)
 199         {
 200             uno::Reference< sheet::XSheetConditionalEntry > xSheetConditionalEntry( mxSheetConditionalEntries->getByIndex(i), uno::UNO_QUERY_THROW );
 201             if (xSheetConditionalEntry->getStyleName().equals(sStyleName))
 202             {
 203                 xFormatCondition =  new ScVbaFormatCondition(uno::Reference< XHelperInterface >( mxRangeParent, uno::UNO_QUERY_THROW ), mxContext, xSheetConditionalEntry, xStyle, this, mxParentRangePropertySet);
 204                 notifyRange();
 205                 return xFormatCondition;
 206             }
 207         }
 208     }
 209     catch (uno::Exception& )
 210     {
 211     }
 212     DebugHelper::exception(SbERR_METHOD_FAILED, rtl::OUString() );
 213     return xFormatCondition;
 214 }
 215
 216
 217 uno::Reference< container::XEnumeration > SAL_CALL
 218 ScVbaFormatConditions::createEnumeration() throw (uno::RuntimeException)
 219 {
 220     return new EnumWrapper( m_xIndexAccess, mxRangeParent, mxContext, mxStyles, this, mxParentRangePropertySet  );
 221 }
 222
 223
 224 void
 225 ScVbaFormatConditions::notifyRange() throw ( script::BasicErrorException )
 226 {
 227     try
 228     {
 229         mxParentRangePropertySet->setPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("ConditionalFormat")), uno::makeAny( mxSheetConditionalEntries ));
 230     }
 231     catch (uno::Exception& )
 232     {
 233         DebugHelper::exception(SbERR_METHOD_FAILED, rtl::OUString());
 234     }
 235 }
 236
 237 rtl::OUString
 238 ScVbaFormatConditions::getA1Formula(const css::uno::Any& _aFormula) throw ( script::BasicErrorException )
 239 {
 240     // #TODO, #FIXME hook-in proper formula conversion detection & logic
 241     rtl::OUString sFormula;
 242     if ( !( _aFormula >>= sFormula ) )
 243         DebugHelper::exception(SbERR_BAD_PARAMETER, rtl::OUString() );
 244     return sFormula;
 245 }
 246
 247 rtl::OUString
 248 ScVbaFormatConditions::getStyleName()
 249 {
 250     ScVbaStyles* pStyles = static_cast< ScVbaStyles* >( mxStyles.get() );
 251     if ( !pStyles )
 252         DebugHelper::exception(SbERR_METHOD_FAILED, rtl::OUString() );
 253     uno::Sequence< rtl::OUString > sCellStyleNames = pStyles->getStyleNames();
 254     return ContainerUtilities::getUniqueName(sCellStyleNames, sStyleNamePrefix, rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("_") ));
 255 }
 256
 257 void
 258 ScVbaFormatConditions::removeFormatCondition( const rtl::OUString& _sStyleName, sal_Bool _bRemoveStyle) throw ( script::BasicErrorException )
 259 {
 260     try
 261     {
 262         sal_Int32 nElems = mxSheetConditionalEntries->getCount();
 263         for (sal_Int32 i = 0; i < nElems; i++)
 264         {
 265             uno::Reference< sheet::XSheetConditionalEntry > xSheetConditionalEntry( mxSheetConditionalEntries->getByIndex(i), uno::UNO_QUERY_THROW );
 266             if (_sStyleName.equals(xSheetConditionalEntry->getStyleName()))
 267             {
 268                 mxSheetConditionalEntries->removeByIndex(i);
 269                 if (_bRemoveStyle)
 270                 {
 271                     ScVbaStyles* pStyles = static_cast< ScVbaStyles* >( mxStyles.get() );
 272                     if ( !pStyles )
 273                         DebugHelper::exception(SbERR_METHOD_FAILED, rtl::OUString());
 274                     pStyles->Delete( _sStyleName );
 275                 }
 276                 return;
 277             }
 278         }
 279     }
 280     catch (uno::Exception& )
 281     {
 282         DebugHelper::exception(SbERR_METHOD_FAILED, rtl::OUString());
 283     }
 284 }
 285
 286 rtl::OUString&
 287 ScVbaFormatConditions::getServiceImplName()
 288 {
 289     static rtl::OUString sImplName( RTL_CONSTASCII_USTRINGPARAM("ScVbaFormatConditions") );
 290     return sImplName;
 291 }
 292
 293 uno::Sequence< rtl::OUString >
 294 ScVbaFormatConditions::getServiceNames()
 295 {
 296     static uno::Sequence< rtl::OUString > aServiceNames;
 297     if ( aServiceNames.getLength() == 0 )
 298     {
 299         aServiceNames.realloc( 1 );
 300         aServiceNames[ 0 ] = rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("ooo.vba.excel.FormatConditions" ) );
 301     }
 302     return aServiceNames;
 303 }
 304