offapi/com/sun/star/util/SortField.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_util_SortField_idl__
  28 #define __com_sun_star_util_SortField_idl__
  29
  30 #ifndef __com_sun_star_util_SortFieldType_idl__
  31 #include <com/sun/star/util/SortFieldType.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module util {
  38
  39 //=============================================================================
  40 /** describes a single field in a sort descriptor.
  41
  42     @deprecated
  43  */
  44 published struct SortField
  45 {
  46     /** index of the field in the table; 0-based.
  47      */
  48     long Field;
  49
  50     //-------------------------------------------------------------------------
  51     /** <TRUE/> if data are sorted in ascending order,
  52         <FALSE/> if in descending order.
  53      */
  54     boolean SortAscending;
  55
  56     //-------------------------------------------------------------------------
  57     /** type of contents in the field.
  58      */
  59     com::sun::star::util::SortFieldType FieldType;
  60
  61 };
  62
  63 //=============================================================================
  64
  65 }; }; }; };
  66
  67 #endif