offapi/com/sun/star/sheet/SheetSortDescriptor2.idl

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