offapi/com/sun/star/table/TableSortDescriptor2.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: TableSortDescriptor2.idl,v $
  10  * $Revision: 1.7 $
  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_TableSortDescriptor2_idl__
  32 #define __com_sun_star_table_TableSortDescriptor2_idl__
  33
  34 #ifndef __com_sun_star_util_SortDescriptor2_idl__
  35 #include <com/sun/star/util/SortDescriptor2.idl>
  36 #endif
  37 #ifndef __com_sun_star_beans_XPropertySet_idl__
  38 #include <com/sun/star/beans/XPropertySet.idl>
  39 #endif
  40 #ifndef __com_sun_star_table_TableSortField_idl__
  41 #include <com/sun/star/table/TableSortField.idl>
  42 #endif
  43
  44 //=============================================================================
  45
  46 module com {  module sun {  module star {  module table {
  47
  48 //=============================================================================
  49
  50 /** specifies properties which describe sorting of fields (rows or columns)
  51     in a table.
  52
  53     @since OOo 1.1.2
  54  */
  55 published service TableSortDescriptor2
  56 {
  57     service com::sun::star::util::SortDescriptor2;
  58
  59     //-------------------------------------------------------------------------
  60     /** specifies a list of individual sort fields.
  61
  62         <p>Each entry specifies properties that state the
  63         row/column to be sorted and how that should be done.</p>
  64      */
  65     [property] sequence< com::sun::star::table::TableSortField > SortFields;
  66
  67     //-------------------------------------------------------------------------
  68     /** contains the maximum number of sort fields the descriptor can hold.
  69      */
  70     [readonly, property] long MaxSortFieldsCount;
  71
  72     //-------------------------------------------------------------------------
  73     /** specifies if the columns or rows are to be sorted.
  74
  75         <dl>
  76             <dt><TRUE/></dt>
  77             <dd>The columns are to be sorted.</dd>
  78             <dt><FALSE/></dt>
  79             <dd>The rows are to be sorted.</dd>
  80         </dl>
  81      */
  82     [property] boolean IsSortColumns;
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif
  90