sc/source/ui/vba/vbapagebreaks.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 #include "vbapagebreaks.hxx"
  20 #include "vbapagebreak.hxx"
  21 #include <basic/sberrors.hxx>
  22 #include <cppuhelper/implbase.hxx>
  23 #include <ooo/vba/excel/XWorksheet.hpp>
  24 #include <com/sun/star/beans/XPropertySet.hpp>
  25 #include <com/sun/star/sheet/XSheetPageBreak.hpp>
  26 #include <com/sun/star/table/XColumnRowRange.hpp>
  27 #include <com/sun/star/uno/XComponentContext.hpp>
  28
  29 using namespace ::com::sun::star;
  30 using namespace ::ooo::vba;
  31
  32 class RangePageBreaks : public ::cppu::WeakImplHelper<container::XIndexAccess >
  33 {
  34 private:
  35     uno::Reference< XHelperInterface > mxParent;
  36     uno::Reference< uno::XComponentContext > mxContext;
  37     uno::Reference< sheet::XSheetPageBreak > mxSheetPageBreak;
  38     bool const m_bColumn;
  39
  40 public:
  41     RangePageBreaks( const uno::Reference< XHelperInterface >& xParent,
  42                      const uno::Reference< uno::XComponentContext >& xContext,
  43                      const uno::Reference< sheet::XSheetPageBreak >& xSheetPageBreak,
  44                      bool bColumn ) : mxParent( xParent ), mxContext( xContext ), mxSheetPageBreak( xSheetPageBreak ), m_bColumn( bColumn )
  45     {
  46     }
  47
  48     /// @throws css::uno::RuntimeException
  49     sal_Int32 getAPIStartofRange( const uno::Reference< excel::XRange >& xRange )
  50     {
  51         if( m_bColumn )
  52             return xRange->getColumn() - 1;
  53         return xRange->getRow() - 1;
  54     }
  55
  56     /// @throws uno::RuntimeException
  57     sal_Int32 getAPIEndIndexofRange( const uno::Reference< excel::XRange >& xRange, sal_Int32 nUsedStart )
  58     {
  59         if( m_bColumn )
  60             return nUsedStart + xRange->Columns( uno::Any() )->getCount() - 1;
  61         return nUsedStart + xRange->Rows( uno::Any() )->getCount();
  62     }
  63
  64     /// @throws uno::RuntimeException
  65     uno::Sequence<sheet::TablePageBreakData> getAllPageBreaks()
  66     {
  67         if( m_bColumn )
  68             return mxSheetPageBreak->getColumnPageBreaks();
  69         return mxSheetPageBreak->getRowPageBreaks();
  70     }
  71
  72     /// @throws uno::RuntimeException
  73     uno::Reference<container::XIndexAccess> getRowColContainer() const
  74     {
  75         uno::Reference< table::XColumnRowRange > xColumnRowRange( mxSheetPageBreak, uno::UNO_QUERY_THROW );
  76         uno::Reference<container::XIndexAccess> xIndexAccess;
  77         if( m_bColumn )
  78             xIndexAccess.set( xColumnRowRange->getColumns(), uno::UNO_QUERY_THROW );
  79         else
  80             xIndexAccess.set( xColumnRowRange->getRows(), uno::UNO_QUERY_THROW );
  81         return xIndexAccess;
  82     }
  83
  84     /// @throws uno::RuntimeException
  85     sheet::TablePageBreakData getTablePageBreakData( sal_Int32 nAPIItemIndex );
  86     /// @throws css::script::BasicErrorException
  87     /// @throws css::uno::RuntimeException
  88     uno::Any Add( const css::uno::Any& Before );
  89
  90     // XIndexAccess
  91     virtual sal_Int32 SAL_CALL getCount(  ) override;
  92     virtual uno::Any SAL_CALL getByIndex( sal_Int32 Index ) override;
  93     virtual uno::Type SAL_CALL getElementType(  ) override
  94     {
  95         if( m_bColumn )
  96              return cppu::UnoType<excel::XVPageBreak>::get();
  97         return  cppu::UnoType<excel::XHPageBreak>::get();
  98     }
  99     virtual sal_Bool SAL_CALL hasElements(  ) override
 100     {
 101         return true;
 102     }
 103 };
 104
 105 /** @TODO Unlike MS Excel this method only considers the pagebreaks that intersect the used range
 106 *  To become completely compatible the print area has to be considered. As far as I found out this printarea
 107 *  also considers the position and sizes of shapes and manually inserted page breaks
 108 *  Note: In MS  there is a limit of 1026 horizontal page breaks per sheet.
 109 */
 110 sal_Int32 SAL_CALL RangePageBreaks::getCount(  )
 111 {
 112     uno::Reference< excel::XWorksheet > xWorksheet( mxParent, uno::UNO_QUERY_THROW );
 113     uno::Reference< excel::XRange > xRange = xWorksheet->getUsedRange();
 114     sal_Int32 nUsedStart = getAPIStartofRange( xRange );
 115     sal_Int32 nUsedEnd = getAPIEndIndexofRange( xRange, nUsedStart );
 116     const uno::Sequence<sheet::TablePageBreakData> aTablePageBreakData = getAllPageBreaks();
 117
 118     auto pPageBreak = std::find_if(aTablePageBreakData.begin(), aTablePageBreakData.end(),
 119         [nUsedEnd](const sheet::TablePageBreakData& rPageBreak) { return rPageBreak.Position > nUsedEnd + 1; });
 120
 121     return static_cast<sal_Int32>(std::distance(aTablePageBreakData.begin(), pPageBreak));
 122 }
 123
 124 uno::Any SAL_CALL RangePageBreaks::getByIndex( sal_Int32 Index )
 125 {
 126     if( (Index < getCount()) && ( Index >= 0 ))
 127     {
 128         sheet::TablePageBreakData aTablePageBreakData = getTablePageBreakData( Index );
 129         uno::Reference< container::XIndexAccess > xIndexAccess = getRowColContainer();
 130         sal_Int32 nPos = aTablePageBreakData.Position;
 131         if( (nPos < xIndexAccess->getCount()) && (nPos > -1) )
 132         {
 133             uno::Reference< beans::XPropertySet > xRowColPropertySet( xIndexAccess->getByIndex(nPos), uno::UNO_QUERY_THROW );
 134             if( m_bColumn )
 135                 return uno::makeAny( uno::Reference< excel::XVPageBreak >( new ScVbaVPageBreak( mxParent, mxContext, xRowColPropertySet, aTablePageBreakData) ));
 136             return uno::makeAny( uno::Reference< excel::XHPageBreak >( new ScVbaHPageBreak( mxParent, mxContext, xRowColPropertySet, aTablePageBreakData) ));
 137         }
 138     }
 139     throw lang::IndexOutOfBoundsException();
 140 }
 141
 142 sheet::TablePageBreakData RangePageBreaks::getTablePageBreakData( sal_Int32 nAPIItemIndex )
 143 {
 144     sal_Int32 index = -1;
 145     sheet::TablePageBreakData aTablePageBreakData;
 146     uno::Reference< excel::XWorksheet > xWorksheet( mxParent, uno::UNO_QUERY_THROW );
 147     uno::Reference< excel::XRange > xRange = xWorksheet->getUsedRange();
 148     sal_Int32 nUsedStart = getAPIStartofRange( xRange );
 149     sal_Int32 nUsedEnd = getAPIEndIndexofRange( xRange, nUsedStart );
 150     const uno::Sequence<sheet::TablePageBreakData> aTablePageBreakDataList = getAllPageBreaks();
 151
 152     for( const auto& rTablePageBreakData : aTablePageBreakDataList )
 153     {
 154         aTablePageBreakData = rTablePageBreakData;
 155         sal_Int32 nPos = aTablePageBreakData.Position;
 156         if( nPos > nUsedEnd + 1 )
 157             DebugHelper::runtimeexception(ERRCODE_BASIC_METHOD_FAILED);
 158         index++;
 159         if( index == nAPIItemIndex )
 160             return aTablePageBreakData;
 161     }
 162
 163     return aTablePageBreakData;
 164 }
 165
 166 uno::Any RangePageBreaks::Add( const css::uno::Any& Before )
 167 {
 168     uno::Reference< excel::XRange > xRange;
 169     Before >>= xRange;
 170     if( !xRange.is() )
 171     {
 172         DebugHelper::basicexception(ERRCODE_BASIC_BAD_ARGUMENT, OUString());
 173     }
 174
 175     sal_Int32 nAPIRowColIndex = getAPIStartofRange( xRange );
 176     uno::Reference< container::XIndexAccess > xIndexAccess = getRowColContainer();
 177     uno::Reference< beans::XPropertySet > xRowColPropertySet( xIndexAccess->getByIndex(nAPIRowColIndex), uno::UNO_QUERY_THROW );
 178     xRowColPropertySet->setPropertyValue("IsStartOfNewPage", uno::makeAny(true));
 179     sheet::TablePageBreakData aTablePageBreakData;
 180     aTablePageBreakData.ManualBreak = true;
 181     aTablePageBreakData.Position = nAPIRowColIndex;
 182     if( m_bColumn )
 183         return uno::makeAny( uno::Reference< excel::XVPageBreak >( new ScVbaVPageBreak( mxParent, mxContext, xRowColPropertySet, aTablePageBreakData) ));
 184     return uno::makeAny( uno::Reference< excel::XHPageBreak >( new ScVbaHPageBreak( mxParent, mxContext, xRowColPropertySet, aTablePageBreakData) ));
 185 }
 186
 187 class RangePageBreaksEnumWrapper : public EnumerationHelper_BASE
 188 {
 189     uno::Reference<container::XIndexAccess > m_xIndexAccess;
 190     sal_Int32 nIndex;
 191 public:
 192     explicit RangePageBreaksEnumWrapper( const uno::Reference< container::XIndexAccess >& xIndexAccess ) : m_xIndexAccess( xIndexAccess ), nIndex( 0 ) {}
 193     virtual sal_Bool SAL_CALL hasMoreElements(  ) override
 194     {
 195         return ( nIndex < m_xIndexAccess->getCount() );
 196     }
 197
 198     virtual uno::Any SAL_CALL nextElement(  ) override
 199     {
 200         if ( nIndex < m_xIndexAccess->getCount() )
 201             return m_xIndexAccess->getByIndex( nIndex++ );
 202         throw container::NoSuchElementException();
 203     }
 204 };
 205
 206 ScVbaHPageBreaks::ScVbaHPageBreaks( const uno::Reference< XHelperInterface >& xParent,
 207                                     const uno::Reference< uno::XComponentContext >& xContext,
 208                                     const uno::Reference< sheet::XSheetPageBreak >& xSheetPageBreak):
 209                           ScVbaHPageBreaks_BASE( xParent,xContext, new RangePageBreaks( xParent, xContext, xSheetPageBreak, false ))
 210 {
 211 }
 212
 213 uno::Any SAL_CALL ScVbaHPageBreaks::Add( const uno::Any& Before)
 214 {
 215     RangePageBreaks* pPageBreaks = dynamic_cast< RangePageBreaks* >( m_xIndexAccess.get() );
 216     if( pPageBreaks )
 217     {
 218         return pPageBreaks->Add( Before );
 219     }
 220     return uno::Any();
 221 }
 222
 223 uno::Reference< container::XEnumeration >
 224 ScVbaHPageBreaks::createEnumeration()
 225 {
 226     return new RangePageBreaksEnumWrapper( m_xIndexAccess );
 227 }
 228
 229 uno::Any
 230 ScVbaHPageBreaks::createCollectionObject( const css::uno::Any& aSource )
 231 {
 232     return aSource; // it's already a pagebreak object
 233 }
 234
 235 uno::Type
 236 ScVbaHPageBreaks::getElementType()
 237 {
 238     return cppu::UnoType<excel::XHPageBreak>::get();
 239 }
 240
 241 OUString
 242 ScVbaHPageBreaks::getServiceImplName()
 243 {
 244     return "ScVbaHPageBreaks";
 245 }
 246
 247 uno::Sequence< OUString >
 248 ScVbaHPageBreaks::getServiceNames()
 249 {
 250     static uno::Sequence< OUString > const aServiceNames
 251     {
 252         "ooo.vba.excel.HPageBreaks"
 253     };
 254     return aServiceNames;
 255 }
 256
 257 //VPageBreak
 258 ScVbaVPageBreaks::ScVbaVPageBreaks( const uno::Reference< XHelperInterface >& xParent,
 259                                     const uno::Reference< uno::XComponentContext >& xContext,
 260                                     const uno::Reference< sheet::XSheetPageBreak >& xSheetPageBreak )
 261 :   ScVbaVPageBreaks_BASE( xParent, xContext, new RangePageBreaks( xParent, xContext, xSheetPageBreak, true ) )
 262 {
 263 }
 264
 265 ScVbaVPageBreaks::~ScVbaVPageBreaks()
 266 {
 267 }
 268
 269 uno::Any SAL_CALL
 270 ScVbaVPageBreaks::Add( const uno::Any& Before )
 271 {
 272     RangePageBreaks* pPageBreaks = dynamic_cast< RangePageBreaks* >( m_xIndexAccess.get() );
 273     if( pPageBreaks )
 274     {
 275         return pPageBreaks->Add( Before );
 276     }
 277     return uno::Any();
 278 }
 279
 280 uno::Reference< container::XEnumeration >
 281 ScVbaVPageBreaks::createEnumeration()
 282 {
 283     return new RangePageBreaksEnumWrapper( m_xIndexAccess );
 284 }
 285
 286 uno::Any
 287 ScVbaVPageBreaks::createCollectionObject( const css::uno::Any& aSource )
 288 {
 289     return aSource; // it's already a pagebreak object
 290 }
 291
 292 uno::Type
 293 ScVbaVPageBreaks::getElementType()
 294 {
 295     return cppu::UnoType<excel::XVPageBreak>::get();
 296 }
 297
 298 OUString
 299 ScVbaVPageBreaks::getServiceImplName()
 300 {
 301     return "ScVbaVPageBreaks";
 302 }
 303
 304 uno::Sequence< OUString >
 305 ScVbaVPageBreaks::getServiceNames()
 306 {
 307     static uno::Sequence< OUString > const aServiceNames
 308     {
 309         "ooo.vba.excel.VPageBreaks"
 310     };
 311     return aServiceNames;
 312 }
 313
 314 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */