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