offapi/com/sun/star/sheet/XSheetCellCursor.idl

   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 #ifndef __com_sun_star_sheet_XSheetCellCursor_idl__
  21 #define __com_sun_star_sheet_XSheetCellCursor_idl__
  22
  23 #include <com/sun/star/sheet/XSheetCellRange.idl>
  24
  25
  26 module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** provides advanced methods to control the position of a cursor in a
  30     spreadsheet.
  31
  32     @see com::sun::star::sheet::SheetCellCursor
  33  */
  34 published interface XSheetCellCursor: com::sun::star::sheet::XSheetCellRange
  35 {
  36
  37     /** expands the cursor into the region containing the cells to which
  38         it currently points.
  39
  40         <p>A region is a cell range bounded by empty cells.</p>
  41      */
  42     void collapseToCurrentRegion();
  43
  44
  45     /** collapses the cursor into the range of the array formula to which
  46         it is currently pointing.
  47
  48         <p>To get the correct result, the top left cell of the original
  49         cursor must point to any cell containing an array formula.
  50         If not, the cursor is left unchanged.</p>
  51      */
  52     void collapseToCurrentArray();
  53
  54
  55     /** expands the cursor to merged cell ranges.
  56
  57         <p>Expands the current cursor range in a way so that all merged
  58         cell ranges intersecting the current range will fit completely.
  59         If the cursor does not point to any range with merged cells, it
  60         is left unchanged.</p>
  61      */
  62     void collapseToMergedArea();
  63
  64
  65     /** expands the cursor to include the entire columns of the cells
  66         to which it is currently pointing.
  67      */
  68     void expandToEntireColumns();
  69
  70
  71     /** expands the cursor to include the entire rows of the cells to
  72         which it is currently pointing.
  73      */
  74     void expandToEntireRows();
  75
  76
  77     /** changes the size of a cursor range.
  78
  79         <p>The top left cell of the cursor keeps unmodified. </p>
  80
  81         @param nColumns
  82             the number of columns of the new cursor range.
  83         @param nRows
  84             the number of rows of the new cursor range.
  85      */
  86     void collapseToSize( [in] long nColumns, [in] long nRows );
  87
  88 };
  89
  90
  91 }; }; }; };
  92
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */