offapi/com/sun/star/table/TableSortDescriptor.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
  28 #ifndef __com_sun_star_table_TableSortDescriptor_idl__
  29 #define __com_sun_star_table_TableSortDescriptor_idl__
  30
  31 #ifndef __com_sun_star_util_SortDescriptor_idl__
  32 #include <com/sun/star/util/SortDescriptor.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_util_SortField_idl__
  36 #include <com/sun/star/util/SortField.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_table_TableOrientation_idl__
  40 #include <com/sun/star/table/TableOrientation.idl>
  41 #endif
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {  module table {
  46
  47 //=============================================================================
  48
  49 /** contains properties which describe sorting of rows or columns in a table.
  50
  51     <p>It extends the general
  52     <type scope="com::sun::star::util">SortDescriptor</type> with
  53     table-specific properties.</p>
  54
  55     @deprecated
  56  */
  57 published service TableSortDescriptor
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     /** contains common sorting properties.
  62      */
  63     service com::sun::star::util::SortDescriptor;
  64
  65     //=========================================================================
  66
  67     /** specifies the descriptions of the individual sort fields.
  68      */
  69     [property] sequence<com::sun::star::util::SortField> SortFields;
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** contains the maximum number of sort fields the descriptor can hold.
  74      */
  75     [readonly, property] long MaxFieldCount;
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** specifies the sorting orientation (sort rows or columns).
  80
  81         <p>Some implementations may not support sorting columns.</p>
  82
  83         @deprecated
  84          use the property <member scope="com::sun::star::util">SortDescriptor::SortColumns</member>
  85          instead.
  86      */
  87     [property] com::sun::star::table::TableOrientation Orientation;
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** specifies whether the first row or column (depending on
  92         <member scope="com::sun::star::util">SortDescriptor::SortColumns</member>) is a
  93         header which should not be sorted.
  94      */
  95     [property] boolean ContainsHeader;
  96
  97 };
  98
  99 //=============================================================================
 100
 101 }; }; }; };
 102
 103 #endif
 104