offapi/com/sun/star/table/TableSortField.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: TableSortField.idl,v $
  10  * $Revision: 1.8 $
  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 #ifndef __com_sun_star_table_TableSortField_idl__
  31 #define __com_sun_star_table_TableSortField_idl__
  32
  33 #ifndef __com_sun_star_lang_Locale_idl__
  34 #include <com/sun/star/lang/Locale.idl>
  35 #endif
  36 #ifndef __com_sun_star_table_TableSortFieldType_idl__
  37 #include <com/sun/star/table/TableSortFieldType.idl>
  38 #endif
  39
  40
  41 //=============================================================================
  42
  43 module com {  module sun {  module star {  module table {
  44
  45 //=============================================================================
  46 /** describes how to sort a single field (row/column) in a tables
  47     sort descriptor.
  48
  49     @see com::sun::star::table::TableSortDescriptor2
  50
  51     @since OOo 1.1.2
  52  */
  53 published struct TableSortField
  54 {
  55     //-------------------------------------------------------------------------
  56     /** index of the row or column in the table to be sorted; 0-based.
  57      */
  58     long Field;
  59
  60     //-------------------------------------------------------------------------
  61     /** <TRUE/> if data are sorted in ascending order,
  62         <FALSE/> if in descending order.
  63      */
  64     boolean IsAscending;
  65
  66     //-------------------------------------------------------------------------
  67     /** specifies if the case of letters is important when comparing entries.
  68      */
  69     boolean IsCaseSensitive;
  70
  71     //-------------------------------------------------------------------------
  72     /** type of contents in the field.
  73
  74         <p>If the value is
  75         <member scope="com::sun::star::table::TableSortFieldType">AUTOMATIC</member>
  76         the algorithm used for sorting is application specific.
  77         Especially it may or may not use the values given by
  78         'CollatorLocale' and 'CollatorAlgorithm'.</p>
  79      */
  80     com::sun::star::table::TableSortFieldType FieldType;
  81
  82     //-------------------------------------------------------------------------
  83     /** the locale used by the collator when comparing/sorting text.
  84
  85         <p>This property will not be used when the 'FieldType' is
  86         <member scope="com::sun::star::table::TableSortFieldType">NUMERIC</member>
  87         </p>
  88
  89         @ see   com::sun::star::i18n::XCollator
  90      */
  91     com::sun::star::lang::Locale CollatorLocale;
  92
  93     //-------------------------------------------------------------------------
  94     /** the algorithm used by the collator when comparing/sorting text.
  95
  96         <p>This property will not be used when the 'FieldType' is
  97         <member scope="com::sun::star::table::TableSortFieldType">NUMERIC</member>
  98         </p>
  99
 100         @ see   com::sun::star::i18n::XCollator
 101      */
 102     string CollatorAlgorithm;
 103
 104 };
 105
 106 //=============================================================================
 107
 108 }; }; }; };
 109
 110 #endif