offapi/com/sun/star/sheet/SheetSortDescriptor.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: SheetSortDescriptor.idl,v $
  10  * $Revision: 1.12 $
  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_SheetSortDescriptor_idl__
  31 #define __com_sun_star_sheet_SheetSortDescriptor_idl__
  32
  33 #ifndef __com_sun_star_table_TableSortDescriptor_idl__
  34 #include <com/sun/star/table/TableSortDescriptor.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">TableSortDescriptor</type>
  50     service with spreadsheet specific properties.</p>
  51  */
  52 published service SheetSortDescriptor
  53 {
  54     //-------------------------------------------------------------------------
  55
  56     /** provides common table sorting properties.
  57      */
  58     service com::sun::star::table::TableSortDescriptor;
  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 //=============================================================================
 101
 102 }; }; }; };
 103
 104 #endif
 105