merge the formfield patch from ooo-build
[ooovba.git] / offapi / com / sun / star / sheet / XSheetOutline.idl
blob885bb06f6c6149b0aa5821fb4fb5539373d0f8ed
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XSheetOutline.idl,v $
10 * $Revision: 1.8 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
31 #ifndef __com_sun_star_sheet_XSheetOutline_idl__
32 #define __com_sun_star_sheet_XSheetOutline_idl__
34 #ifndef __com_sun_star_uno_XInterface_idl__
35 #include <com/sun/star/uno/XInterface.idl>
36 #endif
38 #ifndef __com_sun_star_table_CellRangeAddress_idl__
39 #include <com/sun/star/table/CellRangeAddress.idl>
40 #endif
42 #ifndef __com_sun_star_table_TableOrientation_idl__
43 #include <com/sun/star/table/TableOrientation.idl>
44 #endif
46 //=============================================================================
48 module com { module sun { module star { module sheet {
50 //=============================================================================
52 /** provides methods to access the outlines of a sheet.
54 published interface XSheetOutline: com::sun::star::uno::XInterface
56 //-------------------------------------------------------------------------
58 /** creates an outline group.
60 @param aRange
61 contains the range of rows or columns, depending on
62 the parameter nOrientation.
64 @param nOrientation
65 the orientation of the new outline (columns or rows).
67 void group(
68 [in] com::sun::star::table::CellRangeAddress aRange,
69 [in] com::sun::star::table::TableOrientation nOrientation );
71 //-------------------------------------------------------------------------
73 /** removes outline groups.
75 <p>In the specified range, all outline groups on the innermost
76 level are removed.</p>
78 @param aRange
79 contains the range of rows or columns, depending on
80 the parameter nOrientation.
82 @param nOrientation
83 the orientation of the outlines to remove (columns or rows).
85 void ungroup(
86 [in] com::sun::star::table::CellRangeAddress aRange,
87 [in] com::sun::star::table::TableOrientation nOrientation );
89 //-------------------------------------------------------------------------
91 /** creates outline groups from formula references in a range.
93 @param aRange
94 the cell range for which outlines are generated.
96 void autoOutline( [in] com::sun::star::table::CellRangeAddress aRange );
98 //-------------------------------------------------------------------------
100 /** removes all outline groups from the sheet.
102 void clearOutline();
104 //-------------------------------------------------------------------------
106 /** collapses an outline group.
108 @param aRange
109 the cell range for which the outlines are collapsed.
111 void hideDetail( [in] com::sun::star::table::CellRangeAddress aRange );
113 //-------------------------------------------------------------------------
115 /** reopens an outline group.
117 @param aRange
118 the cell range for which the outlines are reopened.
120 void showDetail( [in] com::sun::star::table::CellRangeAddress aRange );
122 //-------------------------------------------------------------------------
124 /** shows all outlined groups below a specific level.
126 @param nLevel
127 all outline levels from 1 to this value will be opened and
128 the higher levels will be closed.
130 @param nOrientation
131 the orientation of the outlines (columns or rows).
133 void showLevel(
134 [in] short nLevel,
135 [in] com::sun::star::table::TableOrientation nOrientation );
139 //=============================================================================
141 }; }; }; };
143 #endif