1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XSheetOutline_idl__ 25cdf0e10cSrcweir#define __com_sun_star_sheet_XSheetOutline_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_table_CellRangeAddress_idl__ 32cdf0e10cSrcweir#include <com/sun/star/table/CellRangeAddress.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir#ifndef __com_sun_star_table_TableOrientation_idl__ 36cdf0e10cSrcweir#include <com/sun/star/table/TableOrientation.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir 41cdf0e10cSrcweirmodule com { module sun { module star { module sheet { 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir 45cdf0e10cSrcweir/** provides methods to access the outlines of a sheet. 46cdf0e10cSrcweir */ 47cdf0e10cSrcweirpublished interface XSheetOutline: com::sun::star::uno::XInterface 48cdf0e10cSrcweir{ 49cdf0e10cSrcweir //------------------------------------------------------------------------- 50cdf0e10cSrcweir 51cdf0e10cSrcweir /** creates an outline group. 52cdf0e10cSrcweir 53cdf0e10cSrcweir @param aRange 54cdf0e10cSrcweir contains the range of rows or columns, depending on 55cdf0e10cSrcweir the parameter nOrientation. 56cdf0e10cSrcweir 57cdf0e10cSrcweir @param nOrientation 58cdf0e10cSrcweir the orientation of the new outline (columns or rows). 59cdf0e10cSrcweir */ 60cdf0e10cSrcweir void group( 61cdf0e10cSrcweir [in] com::sun::star::table::CellRangeAddress aRange, 62cdf0e10cSrcweir [in] com::sun::star::table::TableOrientation nOrientation ); 63cdf0e10cSrcweir 64cdf0e10cSrcweir //------------------------------------------------------------------------- 65cdf0e10cSrcweir 66cdf0e10cSrcweir /** removes outline groups. 67cdf0e10cSrcweir 68cdf0e10cSrcweir <p>In the specified range, all outline groups on the innermost 69cdf0e10cSrcweir level are removed.</p> 70cdf0e10cSrcweir 71cdf0e10cSrcweir @param aRange 72cdf0e10cSrcweir contains the range of rows or columns, depending on 73cdf0e10cSrcweir the parameter nOrientation. 74cdf0e10cSrcweir 75cdf0e10cSrcweir @param nOrientation 76cdf0e10cSrcweir the orientation of the outlines to remove (columns or rows). 77cdf0e10cSrcweir */ 78cdf0e10cSrcweir void ungroup( 79cdf0e10cSrcweir [in] com::sun::star::table::CellRangeAddress aRange, 80cdf0e10cSrcweir [in] com::sun::star::table::TableOrientation nOrientation ); 81cdf0e10cSrcweir 82cdf0e10cSrcweir //------------------------------------------------------------------------- 83cdf0e10cSrcweir 84cdf0e10cSrcweir /** creates outline groups from formula references in a range. 85cdf0e10cSrcweir 86cdf0e10cSrcweir @param aRange 87cdf0e10cSrcweir the cell range for which outlines are generated. 88cdf0e10cSrcweir */ 89cdf0e10cSrcweir void autoOutline( [in] com::sun::star::table::CellRangeAddress aRange ); 90cdf0e10cSrcweir 91cdf0e10cSrcweir //------------------------------------------------------------------------- 92cdf0e10cSrcweir 93cdf0e10cSrcweir /** removes all outline groups from the sheet. 94cdf0e10cSrcweir */ 95cdf0e10cSrcweir void clearOutline(); 96cdf0e10cSrcweir 97cdf0e10cSrcweir //------------------------------------------------------------------------- 98cdf0e10cSrcweir 99cdf0e10cSrcweir /** collapses an outline group. 100cdf0e10cSrcweir 101cdf0e10cSrcweir @param aRange 102cdf0e10cSrcweir the cell range for which the outlines are collapsed. 103cdf0e10cSrcweir */ 104cdf0e10cSrcweir void hideDetail( [in] com::sun::star::table::CellRangeAddress aRange ); 105cdf0e10cSrcweir 106cdf0e10cSrcweir //------------------------------------------------------------------------- 107cdf0e10cSrcweir 108cdf0e10cSrcweir /** reopens an outline group. 109cdf0e10cSrcweir 110cdf0e10cSrcweir @param aRange 111cdf0e10cSrcweir the cell range for which the outlines are reopened. 112cdf0e10cSrcweir */ 113cdf0e10cSrcweir void showDetail( [in] com::sun::star::table::CellRangeAddress aRange ); 114cdf0e10cSrcweir 115cdf0e10cSrcweir //------------------------------------------------------------------------- 116cdf0e10cSrcweir 117cdf0e10cSrcweir /** shows all outlined groups below a specific level. 118cdf0e10cSrcweir 119cdf0e10cSrcweir @param nLevel 120cdf0e10cSrcweir all outline levels from 1 to this value will be opened and 121cdf0e10cSrcweir the higher levels will be closed. 122cdf0e10cSrcweir 123cdf0e10cSrcweir @param nOrientation 124cdf0e10cSrcweir the orientation of the outlines (columns or rows). 125cdf0e10cSrcweir */ 126cdf0e10cSrcweir void showLevel( 127cdf0e10cSrcweir [in] short nLevel, 128cdf0e10cSrcweir [in] com::sun::star::table::TableOrientation nOrientation ); 129cdf0e10cSrcweir 130cdf0e10cSrcweir}; 131cdf0e10cSrcweir 132cdf0e10cSrcweir//============================================================================= 133cdf0e10cSrcweir 134cdf0e10cSrcweir}; }; }; }; 135cdf0e10cSrcweir 136cdf0e10cSrcweir#endif 137cdf0e10cSrcweir 138