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#ifndef __com_sun_star_sheet_SheetSortDescriptor2_idl__
24#define __com_sun_star_sheet_SheetSortDescriptor2_idl__
25
26#ifndef __com_sun_star_table_TableSortDescriptor2_idl__
27#include <com/sun/star/table/TableSortDescriptor2.idl>
28#endif
29
30#ifndef __com_sun_star_table_CellAddress_idl__
31#include <com/sun/star/table/CellAddress.idl>
32#endif
33
34//=============================================================================
35
36module com {  module sun {  module star {  module sheet {
37
38//=============================================================================
39
40/** a description of how a cell range is to be sorted.
41
42	<p>This service extends the <type scope="com::sun::star::table">TableSortDescriptor2</type>
43	service with spreadsheet specific properties.</p>
44
45	@since OpenOffice 1.1.2
46 */
47published service SheetSortDescriptor2
48{
49	//-------------------------------------------------------------------------
50
51	/** provides common sorting properties.
52
53    The fields in the SortFields property are not fully supported at the moment.
54    IsCaseSensitive, CollatorLocale and CollatorAlgorithm are only supported once and if
55    every field contains different of this it gives undefined results.
56
57	 */
58	service com::sun::star::table::TableSortDescriptor2;
59
60	//=========================================================================
61
62	/** specifies if cell formats are moved with the contents
63		they belong to.
64	 */
65	[property] boolean BindFormatsToContent;
66
67	//-------------------------------------------------------------------------
68
69	/** specifies if a user defined sorting list is used.
70	 */
71	[property] boolean IsUserListEnabled;
72
73	//-------------------------------------------------------------------------
74
75	/** specifies which user defined sorting list is used.
76
77		<p>This property is only used, if
78		<member>SheetSortDescriptor::IsUserListEnabled</member> is <TRUE/>.</p>
79	 */
80	[property] long UserListIndex;
81
82	//-------------------------------------------------------------------------
83
84	/** specifies if the sorted data should be copied to another
85		position in the document.
86	 */
87	[property] boolean CopyOutputData;
88
89	//-------------------------------------------------------------------------
90
91	/** specifies the position where sorted data are to be copied.
92
93		<p>This property is only used, if
94		<member>SheetSortDescriptor::CopyOutputData</member> is <TRUE/>.</p>
95	 */
96	[property] com::sun::star::table::CellAddress OutputPosition;
97
98	//-------------------------------------------------------------------------
99
100	/** specifies whether the first row or column (depending on
101		<member scope="com::sun::star::table">TableSortDescriptor::Orientation</member>) is a header which
102		should not be sorted.
103	 */
104	[property] boolean ContainsHeader;
105};
106
107//=============================================================================
108
109}; }; }; };
110
111#endif
112
113