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_SheetSortDescriptor_idl__ 24#define __com_sun_star_sheet_SheetSortDescriptor_idl__ 25 26#ifndef __com_sun_star_table_TableSortDescriptor_idl__ 27#include <com/sun/star/table/TableSortDescriptor.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">TableSortDescriptor</type> 43 service with spreadsheet specific properties.</p> 44 */ 45published service SheetSortDescriptor 46{ 47 //------------------------------------------------------------------------- 48 49 /** provides common table sorting properties. 50 */ 51 service com::sun::star::table::TableSortDescriptor; 52 53 //========================================================================= 54 55 /** specifies if cell formats are moved with the contents 56 they belong to. 57 */ 58 [property] boolean BindFormatsToContent; 59 60 //------------------------------------------------------------------------- 61 62 /** specifies if a user defined sorting list is used. 63 */ 64 [property] boolean IsUserListEnabled; 65 66 //------------------------------------------------------------------------- 67 68 /** specifies which user defined sorting list is used. 69 70 <p>This property is only used, if 71 <member>SheetSortDescriptor::IsUserListEnabled</member> is <TRUE/>.</p> 72 */ 73 [property] long UserListIndex; 74 75 //------------------------------------------------------------------------- 76 77 /** specifies if the sorted data should be copied to another 78 position in the document. 79 */ 80 [property] boolean CopyOutputData; 81 82 //------------------------------------------------------------------------- 83 84 /** specifies the position where sorted data are to be copied. 85 86 <p>This property is only used, if 87 <member>SheetSortDescriptor::CopyOutputData</member> is <TRUE/>.</p> 88 */ 89 [property] com::sun::star::table::CellAddress OutputPosition; 90 91}; 92 93//============================================================================= 94 95}; }; }; }; 96 97#endif 98 99