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
  20
  21
  22 module com {  module sun {  module star {  module table {
  23
  24 /** describes how to sort a single field (row/column) in a tables
  25     sort descriptor.
  26
  27     @see com::sun::star::table::TableSortDescriptor2
  28
  29     @since OOo 1.1.2
  30  */
  31 published struct TableSortField
  32 {
  33     /** index of the row or column in the table to be sorted; 0-based.
  34      */
  35     long Field;
  36
  37     /** `TRUE` if data are sorted in ascending order,
  38         `FALSE` if in descending order.
  39      */
  40     boolean IsAscending;
  41
  42     /** specifies if the case of letters is important when comparing entries.
  43      */
  44     boolean IsCaseSensitive;
  45
  46     /** type of contents in the field.
  47
  48         <p>If the value is
  49         com::sun::star::table::TableSortFieldType::AUTOMATIC
  50         the algorithm used for sorting is application specific.
  51         Especially it may or may not use the values given by
  52         "CollatorLocale" and "CollatorAlgorithm".</p>
  53      */
  54     com::sun::star::table::TableSortFieldType FieldType;
  55
  56     /** the locale used by the collator when comparing/sorting text.
  57
  58         <p>This property will not be used when the "FieldType" is
  59         com::sun::star::table::TableSortFieldType::NUMERIC
  60         </p>
  61
  62         @see   com::sun::star::i18n::XCollator
  63      */
  64     com::sun::star::lang::Locale CollatorLocale;
  65
  66     /** the algorithm used by the collator when comparing/sorting text.
  67
  68         <p>This property will not be used when the "FieldType" is
  69         com::sun::star::table::TableSortFieldType::NUMERIC
  70         </p>
  71
  72         @see   com::sun::star::i18n::XCollator
  73      */
  74     string CollatorAlgorithm;
  75
  76 };
  77
  78
  79 }; }; }; };
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */