1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28#ifndef __com_sun_star_sheet_XSheetOutline_idl__ 29#define __com_sun_star_sheet_XSheetOutline_idl__ 30 31#ifndef __com_sun_star_uno_XInterface_idl__ 32#include <com/sun/star/uno/XInterface.idl> 33#endif 34 35#ifndef __com_sun_star_table_CellRangeAddress_idl__ 36#include <com/sun/star/table/CellRangeAddress.idl> 37#endif 38 39#ifndef __com_sun_star_table_TableOrientation_idl__ 40#include <com/sun/star/table/TableOrientation.idl> 41#endif 42 43//============================================================================= 44 45module com { module sun { module star { module sheet { 46 47//============================================================================= 48 49/** provides methods to access the outlines of a sheet. 50 */ 51published interface XSheetOutline: com::sun::star::uno::XInterface 52{ 53 //------------------------------------------------------------------------- 54 55 /** creates an outline group. 56 57 @param aRange 58 contains the range of rows or columns, depending on 59 the parameter nOrientation. 60 61 @param nOrientation 62 the orientation of the new outline (columns or rows). 63 */ 64 void group( 65 [in] com::sun::star::table::CellRangeAddress aRange, 66 [in] com::sun::star::table::TableOrientation nOrientation ); 67 68 //------------------------------------------------------------------------- 69 70 /** removes outline groups. 71 72 <p>In the specified range, all outline groups on the innermost 73 level are removed.</p> 74 75 @param aRange 76 contains the range of rows or columns, depending on 77 the parameter nOrientation. 78 79 @param nOrientation 80 the orientation of the outlines to remove (columns or rows). 81 */ 82 void ungroup( 83 [in] com::sun::star::table::CellRangeAddress aRange, 84 [in] com::sun::star::table::TableOrientation nOrientation ); 85 86 //------------------------------------------------------------------------- 87 88 /** creates outline groups from formula references in a range. 89 90 @param aRange 91 the cell range for which outlines are generated. 92 */ 93 void autoOutline( [in] com::sun::star::table::CellRangeAddress aRange ); 94 95 //------------------------------------------------------------------------- 96 97 /** removes all outline groups from the sheet. 98 */ 99 void clearOutline(); 100 101 //------------------------------------------------------------------------- 102 103 /** collapses an outline group. 104 105 @param aRange 106 the cell range for which the outlines are collapsed. 107 */ 108 void hideDetail( [in] com::sun::star::table::CellRangeAddress aRange ); 109 110 //------------------------------------------------------------------------- 111 112 /** reopens an outline group. 113 114 @param aRange 115 the cell range for which the outlines are reopened. 116 */ 117 void showDetail( [in] com::sun::star::table::CellRangeAddress aRange ); 118 119 //------------------------------------------------------------------------- 120 121 /** shows all outlined groups below a specific level. 122 123 @param nLevel 124 all outline levels from 1 to this value will be opened and 125 the higher levels will be closed. 126 127 @param nOrientation 128 the orientation of the outlines (columns or rows). 129 */ 130 void showLevel( 131 [in] short nLevel, 132 [in] com::sun::star::table::TableOrientation nOrientation ); 133 134}; 135 136//============================================================================= 137 138}; }; }; }; 139 140#endif 141 142