sc/source/ui/unoobj/cursuno.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
  20 #include <vcl/svapp.hxx>
  21 #include <comphelper/sequence.hxx>
  22 #include <cppuhelper/supportsservice.hxx>
  23 #include <cppuhelper/queryinterface.hxx>
  24 #include <cursuno.hxx>
  25 #include <cellsuno.hxx>
  26 #include <docsh.hxx>
  27 #include <markdata.hxx>
  28
  29 using namespace com::sun::star;
  30
  31 constexpr OUString SCSHEETCELLCURSOR_SERVICE = u"com.sun.star.sheet.SheetCellCursor"_ustr;
  32 constexpr OUString SCCELLCURSOR_SERVICE = u"com.sun.star.table.CellCursor"_ustr;
  33
  34 ScCellCursorObj::ScCellCursorObj(ScDocShell* pDocSh, const ScRange& rR) :
  35     ScCellCursorObj_BASE( pDocSh, rR )
  36 {
  37 }
  38
  39 ScCellCursorObj::~ScCellCursorObj()
  40 {
  41 }
  42
  43 // XSheetCellCursor
  44
  45 void SAL_CALL ScCellCursorObj::collapseToCurrentRegion()
  46 {
  47     SolarMutexGuard aGuard;
  48     const ScRangeList& rRanges = GetRangeList();
  49     OSL_ENSURE( rRanges.size() == 1, "Range? Ranges?" );
  50     ScRange aOneRange( rRanges[ 0 ] );
  51
  52     aOneRange.PutInOrder();
  53     ScDocShell* pDocSh = GetDocShell();
  54     if ( !pDocSh )
  55         return;
  56
  57     SCCOL nStartCol = aOneRange.aStart.Col();
  58     SCROW nStartRow = aOneRange.aStart.Row();
  59     SCCOL nEndCol = aOneRange.aEnd.Col();
  60     SCROW nEndRow = aOneRange.aEnd.Row();
  61     SCTAB nTab = aOneRange.aStart.Tab();
  62
  63     pDocSh->GetDocument().GetDataArea(
  64                     nTab, nStartCol, nStartRow, nEndCol, nEndRow, true, false );
  65
  66     ScRange aNew( nStartCol, nStartRow, nTab, nEndCol, nEndRow, nTab );
  67     SetNewRange( aNew );
  68 }
  69
  70 void SAL_CALL ScCellCursorObj::collapseToCurrentArray()
  71 {
  72     SolarMutexGuard aGuard;
  73     const ScRangeList& rRanges = GetRangeList();
  74     OSL_ENSURE( rRanges.size() == 1, "Range? Ranges?" );
  75     ScRange aOneRange( rRanges[ 0 ] );
  76
  77     aOneRange.PutInOrder();
  78     ScAddress aCursor(aOneRange.aStart);        //  use the start address of the range
  79
  80     ScDocShell* pDocSh = GetDocShell();
  81     if ( pDocSh )
  82     {
  83         ScDocument& rDoc = pDocSh->GetDocument();
  84         ScRange aMatrix;
  85
  86         // finding the matrix range is now in GetMatrixFormulaRange in the document
  87         if ( rDoc.GetMatrixFormulaRange( aCursor, aMatrix ) )
  88         {
  89             SetNewRange( aMatrix );
  90         }
  91     }
  92     // that's a Bug, that this assertion comes; the API Reference says, that
  93     // if there is no Matrix, the Range is left unchanged; they say nothing
  94     // about an exception
  95     /*if (!bFound)
  96     {
  97         OSL_FAIL("no matrix");
  98         //! Exception, or what?
  99     }*/
 100 }
 101
 102 void SAL_CALL ScCellCursorObj::collapseToMergedArea()
 103 {
 104     SolarMutexGuard aGuard;
 105     ScDocShell* pDocSh = GetDocShell();
 106     if ( pDocSh )
 107     {
 108         const ScRangeList& rRanges = GetRangeList();
 109         OSL_ENSURE( rRanges.size() == 1, "Range? Ranges?" );
 110         ScRange aNewRange( rRanges[ 0 ] );
 111
 112         ScDocument& rDoc = pDocSh->GetDocument();
 113         rDoc.ExtendOverlapped( aNewRange );
 114         rDoc.ExtendMerge( aNewRange );                 // after ExtendOverlapped!
 115
 116         SetNewRange( aNewRange );
 117     }
 118 }
 119
 120 void SAL_CALL ScCellCursorObj::expandToEntireColumns()
 121 {
 122     SolarMutexGuard aGuard;
 123     const ScRangeList& rRanges = GetRangeList();
 124     OSL_ENSURE( rRanges.size() == 1, "Range? Ranges?" );
 125     ScRange aNewRange( rRanges[ 0 ] );
 126
 127     aNewRange.aStart.SetRow( 0 );
 128     aNewRange.aEnd.SetRow( GetDocShell()->GetDocument().MaxRow() );
 129
 130     SetNewRange( aNewRange );
 131 }
 132
 133 void SAL_CALL ScCellCursorObj::expandToEntireRows()
 134 {
 135     SolarMutexGuard aGuard;
 136     const ScRangeList& rRanges = GetRangeList();
 137     OSL_ENSURE( rRanges.size() == 1, "Range? Ranges?" );
 138     ScRange aNewRange( rRanges[ 0 ] );
 139
 140     aNewRange.aStart.SetCol( 0 );
 141     aNewRange.aEnd.SetCol( GetDocShell()->GetDocument().MaxCol() );
 142
 143     SetNewRange( aNewRange );
 144 }
 145
 146 void SAL_CALL ScCellCursorObj::collapseToSize( sal_Int32 nColumns, sal_Int32 nRows )
 147 {
 148     SolarMutexGuard aGuard;
 149     if ( nColumns <= 0 || nRows <= 0 )
 150     {
 151         OSL_FAIL("Empty range not allowed");
 152         //! and then?
 153     }
 154     else
 155     {
 156         const ScRangeList& rRanges = GetRangeList();
 157         OSL_ENSURE( rRanges.size() == 1, "Range? Ranges?" );
 158         ScRange aNewRange( rRanges[ 0 ] );
 159
 160         aNewRange.PutInOrder();    //! really?
 161
 162         const auto & rDoc = GetDocShell()->GetDocument();
 163         tools::Long nEndX = aNewRange.aStart.Col() + nColumns - 1;
 164         tools::Long nEndY = aNewRange.aStart.Row() + nRows - 1;
 165         if ( nEndX < 0 )      nEndX = 0;
 166         if ( nEndX > rDoc.MaxCol() ) nEndX = rDoc.MaxCol();
 167         if ( nEndY < 0 )      nEndY = 0;
 168         if ( nEndY > rDoc.MaxRow() ) nEndY = rDoc.MaxRow();
 169         //! error/exception or so, if too big/small
 170
 171         aNewRange.aEnd.SetCol(static_cast<SCCOL>(nEndX));
 172         aNewRange.aEnd.SetRow(static_cast<SCROW>(nEndY));
 173
 174         aNewRange.PutInOrder();    //! really?
 175
 176         SetNewRange( aNewRange );
 177     }
 178 }
 179
 180 // XUsedAreaCursor
 181
 182 void SAL_CALL ScCellCursorObj::gotoStartOfUsedArea(sal_Bool bExpand)
 183 {
 184     SolarMutexGuard aGuard;
 185     ScDocShell* pDocSh = GetDocShell();
 186     if ( !pDocSh )
 187         return;
 188
 189     const ScRangeList& rRanges = GetRangeList();
 190     OSL_ENSURE( rRanges.size() == 1, "Range? Ranges?" );
 191     ScRange aNewRange( rRanges[0] );
 192     SCTAB nTab = aNewRange.aStart.Tab();
 193
 194     SCCOL nUsedX = 0;       // fetch the beginning
 195     SCROW nUsedY = 0;
 196     if (!pDocSh->GetDocument().GetDataStart( nTab, nUsedX, nUsedY ))
 197     {
 198         nUsedX = 0;
 199         nUsedY = 0;
 200     }
 201
 202     aNewRange.aStart.SetCol( nUsedX );
 203     aNewRange.aStart.SetRow( nUsedY );
 204     if (!bExpand)
 205         aNewRange.aEnd = aNewRange.aStart;
 206     SetNewRange( aNewRange );
 207 }
 208
 209 void SAL_CALL ScCellCursorObj::gotoEndOfUsedArea( sal_Bool bExpand )
 210 {
 211     SolarMutexGuard aGuard;
 212     ScDocShell* pDocSh = GetDocShell();
 213     if ( !pDocSh )
 214         return;
 215
 216     const ScRangeList& rRanges = GetRangeList();
 217     OSL_ENSURE( rRanges.size() == 1, "Range? Ranges?" );
 218     ScRange aNewRange( rRanges[ 0 ]);
 219     SCTAB nTab = aNewRange.aStart.Tab();
 220
 221     SCCOL nUsedX = 0;       // fetch the end
 222     SCROW nUsedY = 0;
 223     if (!pDocSh->GetDocument().GetTableArea( nTab, nUsedX, nUsedY, true ))
 224     {
 225         nUsedX = 0;
 226         nUsedY = 0;
 227     }
 228
 229     aNewRange.aEnd.SetCol( nUsedX );
 230     aNewRange.aEnd.SetRow( nUsedY );
 231     if (!bExpand)
 232         aNewRange.aStart = aNewRange.aEnd;
 233     SetNewRange( aNewRange );
 234 }
 235
 236 // XCellCursor
 237
 238 void SAL_CALL ScCellCursorObj::gotoStart()
 239 {
 240     //  this is similar to collapseToCurrentRegion
 241     //! something like gotoEdge with 4 possible directions is needed
 242
 243     SolarMutexGuard aGuard;
 244     const ScRangeList& rRanges = GetRangeList();
 245     OSL_ENSURE( rRanges.size() == 1, "Range? Ranges?" );
 246     ScRange aOneRange( rRanges[ 0 ]);
 247
 248     aOneRange.PutInOrder();
 249     ScDocShell* pDocSh = GetDocShell();
 250     if ( !pDocSh )
 251         return;
 252
 253     SCCOL nStartCol = aOneRange.aStart.Col();
 254     SCROW nStartRow = aOneRange.aStart.Row();
 255     SCCOL nEndCol = aOneRange.aEnd.Col();
 256     SCROW nEndRow = aOneRange.aEnd.Row();
 257     SCTAB nTab = aOneRange.aStart.Tab();
 258
 259     pDocSh->GetDocument().GetDataArea(
 260                     nTab, nStartCol, nStartRow, nEndCol, nEndRow, false, false );
 261
 262     ScRange aNew( nStartCol, nStartRow, nTab );
 263     SetNewRange( aNew );
 264 }
 265
 266 void SAL_CALL ScCellCursorObj::gotoEnd()
 267 {
 268     //  this is similar to collapseToCurrentRegion
 269     //! something like gotoEdge with 4 possible directions is needed
 270
 271     SolarMutexGuard aGuard;
 272     const ScRangeList& rRanges = GetRangeList();
 273     OSL_ENSURE( rRanges.size() == 1, "Range? Ranges?" );
 274     ScRange aOneRange( rRanges[ 0 ] );
 275
 276     aOneRange.PutInOrder();
 277     ScDocShell* pDocSh = GetDocShell();
 278     if ( !pDocSh )
 279         return;
 280
 281     SCCOL nStartCol = aOneRange.aStart.Col();
 282     SCROW nStartRow = aOneRange.aStart.Row();
 283     SCCOL nEndCol = aOneRange.aEnd.Col();
 284     SCROW nEndRow = aOneRange.aEnd.Row();
 285     SCTAB nTab = aOneRange.aStart.Tab();
 286
 287     pDocSh->GetDocument().GetDataArea(
 288                     nTab, nStartCol, nStartRow, nEndCol, nEndRow, false, false );
 289
 290     ScRange aNew( nEndCol, nEndRow, nTab );
 291     SetNewRange( aNew );
 292 }
 293
 294 void SAL_CALL ScCellCursorObj::gotoNext()
 295 {
 296     SolarMutexGuard aGuard;
 297     const ScRangeList& rRanges = GetRangeList();
 298     OSL_ENSURE( rRanges.size() == 1, "Range? Ranges?" );
 299     ScRange aOneRange( rRanges[ 0 ] );
 300
 301     aOneRange.PutInOrder();
 302     ScAddress aCursor(aOneRange.aStart);        //  always use start of block
 303
 304     ScMarkData aMark(GetDocument()->GetSheetLimits());   // not used with bMarked=FALSE
 305     SCCOL nNewX = aCursor.Col();
 306     SCROW nNewY = aCursor.Row();
 307     SCTAB nTab  = aCursor.Tab();
 308     ScDocShell* pDocSh = GetDocShell();
 309     if ( pDocSh )
 310         pDocSh->GetDocument().GetNextPos( nNewX,nNewY, nTab,  1,0, false,true, aMark );
 311     //! otherwise exception or so
 312
 313     SetNewRange( ScRange( nNewX, nNewY, nTab ) );
 314 }
 315
 316 void SAL_CALL ScCellCursorObj::gotoPrevious()
 317 {
 318     SolarMutexGuard aGuard;
 319     const ScRangeList& rRanges = GetRangeList();
 320     OSL_ENSURE( rRanges.size() == 1, "Range? Ranges?" );
 321     ScRange aOneRange( rRanges[ 0 ] );
 322
 323     aOneRange.PutInOrder();
 324     ScAddress aCursor(aOneRange.aStart);        //  always use start of block
 325
 326     ScMarkData aMark(GetDocument()->GetSheetLimits());   // not used with bMarked=FALSE
 327     SCCOL nNewX = aCursor.Col();
 328     SCROW nNewY = aCursor.Row();
 329     SCTAB nTab  = aCursor.Tab();
 330     ScDocShell* pDocSh = GetDocShell();
 331     if ( pDocSh )
 332         pDocSh->GetDocument().GetNextPos( nNewX,nNewY, nTab, -1,0, false,true, aMark );
 333     //! otherwise exception or so
 334
 335     SetNewRange( ScRange( nNewX, nNewY, nTab ) );
 336 }
 337
 338 void SAL_CALL ScCellCursorObj::gotoOffset( sal_Int32 nColumnOffset, sal_Int32 nRowOffset )
 339 {
 340     SolarMutexGuard aGuard;
 341     const ScRangeList& rRanges = GetRangeList();
 342     OSL_ENSURE( rRanges.size() == 1, "Range? Ranges?" );
 343     ScRange aOneRange( rRanges[ 0 ] );
 344     aOneRange.PutInOrder();
 345
 346     const auto & rDoc = GetDocShell()->GetDocument();
 347     if ( aOneRange.aStart.Col() + nColumnOffset >= 0 &&
 348          aOneRange.aEnd.Col()   + nColumnOffset <= rDoc.MaxCol() &&
 349          aOneRange.aStart.Row() + nRowOffset    >= 0 &&
 350          aOneRange.aEnd.Row()   + nRowOffset    <= rDoc.MaxRow() )
 351     {
 352         ScRange aNew( static_cast<SCCOL>(aOneRange.aStart.Col() + nColumnOffset),
 353                       static_cast<SCROW>(aOneRange.aStart.Row() + nRowOffset),
 354                       aOneRange.aStart.Tab(),
 355                       static_cast<SCCOL>(aOneRange.aEnd.Col() + nColumnOffset),
 356                       static_cast<SCROW>(aOneRange.aEnd.Row() + nRowOffset),
 357                       aOneRange.aEnd.Tab() );
 358         SetNewRange( aNew );
 359     }
 360 }
 361
 362 // XSheetCellRange
 363
 364 uno::Reference<sheet::XSpreadsheet> SAL_CALL ScCellCursorObj::getSpreadsheet()
 365 {
 366     SolarMutexGuard aGuard;
 367     return ScCellRangeObj::getSpreadsheet();
 368 }
 369
 370 // XCellRange
 371
 372 uno::Reference<table::XCell> SAL_CALL ScCellCursorObj::getCellByPosition(
 373                                         sal_Int32 nColumn, sal_Int32 nRow )
 374 {
 375     SolarMutexGuard aGuard;
 376     return ScCellRangeObj::getCellByPosition(nColumn,nRow);
 377 }
 378
 379 uno::Reference<table::XCellRange> SAL_CALL ScCellCursorObj::getCellRangeByPosition(
 380                 sal_Int32 nLeft, sal_Int32 nTop, sal_Int32 nRight, sal_Int32 nBottom )
 381 {
 382     SolarMutexGuard aGuard;
 383     return ScCellRangeObj::getCellRangeByPosition(nLeft,nTop,nRight,nBottom);
 384 }
 385
 386 uno::Reference<table::XCellRange> SAL_CALL ScCellCursorObj::getCellRangeByName(
 387                         const OUString& rRange )
 388 {
 389     SolarMutexGuard aGuard;
 390     return ScCellRangeObj::getCellRangeByName(rRange);
 391 }
 392
 393 // XServiceInfo
 394
 395 OUString SAL_CALL ScCellCursorObj::getImplementationName()
 396 {
 397     return u"ScCellCursorObj"_ustr;
 398 }
 399
 400 sal_Bool SAL_CALL ScCellCursorObj::supportsService( const OUString& rServiceName )
 401 {
 402     return cppu::supportsService(this, rServiceName);
 403 }
 404
 405 uno::Sequence<OUString> SAL_CALL ScCellCursorObj::getSupportedServiceNames()
 406 {
 407     //  SheetCellCursor should be first (?)
 408     return comphelper::concatSequences<OUString>(
 409         { SCSHEETCELLCURSOR_SERVICE, SCCELLCURSOR_SERVICE },
 410         ScCellRangeObj::getSupportedServiceNames());
 411 }
 412
 413 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */