offapi/com/sun/star/sheet/XSheetOutline.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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** provides methods to access the outlines of a sheet.
  25  */
  26 published interface XSheetOutline: com::sun::star::uno::XInterface
  27 {
  28
  29     /** creates an outline group.
  30
  31         @param aRange
  32             contains the range of rows or columns, depending on
  33             the parameter nOrientation.
  34
  35         @param nOrientation
  36             the orientation of the new outline (columns or rows).
  37      */
  38     void group(
  39             [in] com::sun::star::table::CellRangeAddress aRange,
  40             [in] com::sun::star::table::TableOrientation nOrientation );
  41
  42
  43     /** removes outline groups.
  44
  45         <p>In the specified range, all outline groups on the innermost
  46         level are removed.</p>
  47
  48         @param aRange
  49             contains the range of rows or columns, depending on
  50             the parameter nOrientation.
  51
  52         @param nOrientation
  53             the orientation of the outlines to remove (columns or rows).
  54      */
  55     void ungroup(
  56             [in] com::sun::star::table::CellRangeAddress aRange,
  57             [in] com::sun::star::table::TableOrientation nOrientation );
  58
  59
  60     /** creates outline groups from formula references in a range.
  61
  62         @param aRange
  63             the cell range for which outlines are generated.
  64      */
  65     void autoOutline( [in] com::sun::star::table::CellRangeAddress aRange );
  66
  67
  68     /** removes all outline groups from the sheet.
  69      */
  70     void clearOutline();
  71
  72
  73     /** collapses an outline group.
  74
  75         @param aRange
  76             the cell range for which the outlines are collapsed.
  77      */
  78     void hideDetail( [in] com::sun::star::table::CellRangeAddress aRange );
  79
  80
  81     /** reopens an outline group.
  82
  83         @param aRange
  84             the cell range for which the outlines are reopened.
  85      */
  86     void showDetail( [in] com::sun::star::table::CellRangeAddress aRange );
  87
  88
  89     /** shows all outlined groups below a specific level.
  90
  91         @param nLevel
  92             all outline levels from 1 to this value will be opened and
  93             the higher levels will be closed.
  94
  95         @param nOrientation
  96             the orientation of the outlines (columns or rows).
  97      */
  98     void showLevel(
  99             [in] short nLevel,
 100             [in] com::sun::star::table::TableOrientation nOrientation );
 101
 102 };
 103
 104
 105 }; }; }; };
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */