offapi/com/sun/star/sheet/XUsedAreaCursor.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_XUsedAreaCursor_idl__
  21 #define __com_sun_star_sheet_XUsedAreaCursor_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25
  26 module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** provides methods to find the used area of the entire sheet.
  30
  31     <p>The used area is the smallest cell range that contains all cells
  32     of the spreadsheet with any contents (values, text, formulas) or
  33     visible formatting (borders and background color).</p>
  34
  35     @see com::sun::star::sheet::SheetCellCursor
  36  */
  37 published interface XUsedAreaCursor: com::sun::star::uno::XInterface
  38 {
  39
  40     /** points the cursor to the start of the used area.
  41
  42         @param bExpand
  43             `TRUE` = expands the current cursor range,
  44             `FALSE` = sets size of the cursor to a single cell.
  45      */
  46     void gotoStartOfUsedArea( [in] boolean bExpand );
  47
  48
  49     /** points the cursor to the end of the used area.
  50
  51         @param bExpand
  52             `TRUE` = expands the current cursor range,
  53             `FALSE` = sets size of the cursor to a single cell.
  54      */
  55     void gotoEndOfUsedArea( [in] boolean bExpand );
  56
  57 };
  58
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */