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