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