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