offapi/com/sun/star/table/TableSortField.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_table_TableSortField_idl__
  20 #define __com_sun_star_table_TableSortField_idl__
  21
  22 #include <com/sun/star/lang/Locale.idl>
  23 #include <com/sun/star/table/TableSortFieldType.idl>
  24
  25
  26
  27 module com {  module sun {  module star {  module table {
  28
  29 /** describes how to sort a single field (row/column) in a tables
  30     sort descriptor.
  31
  32     @see com::sun::star::table::TableSortDescriptor2
  33
  34     @since OOo 1.1.2
  35  */
  36 published struct TableSortField
  37 {
  38     /** index of the row or column in the table to be sorted; 0-based.
  39      */
  40     long Field;
  41
  42     /** `TRUE` if data are sorted in ascending order,
  43         `FALSE` if in descending order.
  44      */
  45     boolean IsAscending;
  46
  47     /** specifies if the case of letters is important when comparing entries.
  48      */
  49     boolean IsCaseSensitive;
  50
  51     /** type of contents in the field.
  52
  53         <p>If the value is
  54         com::sun::star::table::TableSortFieldType::AUTOMATIC
  55         the algorithm used for sorting is application specific.
  56         Especially it may or may not use the values given by
  57         "CollatorLocale" and "CollatorAlgorithm".</p>
  58      */
  59     com::sun::star::table::TableSortFieldType FieldType;
  60
  61     /** the locale used by the collator when comparing/sorting text.
  62
  63         <p>This property will not be used when the "FieldType" is
  64         com::sun::star::table::TableSortFieldType::NUMERIC
  65         </p>
  66
  67         @see   com::sun::star::i18n::XCollator
  68      */
  69     com::sun::star::lang::Locale CollatorLocale;
  70
  71     /** the algorithm used by the collator when comparing/sorting text.
  72
  73         <p>This property will not be used when the "FieldType" is
  74         com::sun::star::table::TableSortFieldType::NUMERIC
  75         </p>
  76
  77         @see   com::sun::star::i18n::XCollator
  78      */
  79     string CollatorAlgorithm;
  80
  81 };
  82
  83
  84 }; }; }; };
  85
  86 #endif
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */