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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sheet_SheetSortDescriptor_idl__
  28 #define __com_sun_star_sheet_SheetSortDescriptor_idl__
  29
  30 #ifndef __com_sun_star_table_TableSortDescriptor_idl__
  31 #include <com/sun/star/table/TableSortDescriptor.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_table_CellAddress_idl__
  35 #include <com/sun/star/table/CellAddress.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module sheet {
  41
  42 //=============================================================================
  43
  44 /** a description of how a cell range is to be sorted.
  45
  46     <p>This service extends the <type scope="com::sun::star::table">TableSortDescriptor</type>
  47     service with spreadsheet specific properties.</p>
  48  */
  49 published service SheetSortDescriptor
  50 {
  51     //-------------------------------------------------------------------------
  52
  53     /** provides common table sorting properties.
  54      */
  55     service com::sun::star::table::TableSortDescriptor;
  56
  57     //=========================================================================
  58
  59     /** specifies if cell formats are moved with the contents
  60         they belong to.
  61      */
  62     [property] boolean BindFormatsToContent;
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** specifies if a user defined sorting list is used.
  67      */
  68     [property] boolean IsUserListEnabled;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** specifies which user defined sorting list is used.
  73
  74         <p>This property is only used, if
  75         <member>SheetSortDescriptor::IsUserListEnabled</member> is <TRUE/>.</p>
  76      */
  77     [property] long UserListIndex;
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** specifies if the sorted data should be copied to another
  82         position in the document.
  83      */
  84     [property] boolean CopyOutputData;
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** specifies the position where sorted data are to be copied.
  89
  90         <p>This property is only used, if
  91         <member>SheetSortDescriptor::CopyOutputData</member> is <TRUE/>.</p>
  92      */
  93     [property] com::sun::star::table::CellAddress OutputPosition;
  94
  95 };
  96
  97 //=============================================================================
  98
  99 }; }; }; };
 100
 101 #endif
 102