offapi/com/sun/star/sheet/SheetSortDescriptor2.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_sheet_SheetSortDescriptor2_idl__
  20 #define __com_sun_star_sheet_SheetSortDescriptor2_idl__
  21
  22 #include <com/sun/star/table/TableSortDescriptor2.idl>
  23 #include <com/sun/star/table/CellAddress.idl>
  24
  25
  26 module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** a description of how a cell range is to be sorted.
  30
  31     <p>This service extends the com::sun::star::table::TableSortDescriptor2
  32     service with spreadsheet specific properties.</p>
  33
  34     @since OOo 1.1.2
  35  */
  36 published service SheetSortDescriptor2
  37 {
  38
  39     /** provides common sorting properties.
  40
  41     The fields in the SortFields property are not fully supported at the moment.
  42     IsCaseSensitive, CollatorLocale and CollatorAlgorithm are only supported once and if
  43     every field contains different of this it gives undefined results.
  44
  45      */
  46     service com::sun::star::table::TableSortDescriptor2;
  47
  48
  49     /** specifies if cell formats are moved with the contents
  50         they belong to.
  51      */
  52     [property] boolean BindFormatsToContent;
  53
  54
  55     /** specifies if a user defined sorting list is used.
  56      */
  57     [property] boolean IsUserListEnabled;
  58
  59
  60     /** specifies which user defined sorting list is used.
  61
  62         <p>This property is only used, if
  63         SheetSortDescriptor::IsUserListEnabled is `TRUE`.</p>
  64      */
  65     [property] long UserListIndex;
  66
  67
  68     /** specifies if the sorted data should be copied to another
  69         position in the document.
  70      */
  71     [property] boolean CopyOutputData;
  72
  73
  74     /** specifies the position where sorted data are to be copied.
  75
  76         <p>This property is only used, if
  77         SheetSortDescriptor::CopyOutputData is `TRUE`.</p>
  78      */
  79     [property] com::sun::star::table::CellAddress OutputPosition;
  80
  81
  82     /** specifies whether the first row or column (depending on
  83         com::sun::star::table::TableSortDescriptor::Orientation) is a header which
  84         should not be sorted.
  85      */
  86     [property] boolean ContainsHeader;
  87 };
  88
  89
  90 }; }; }; };
  91
  92 #endif
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */