offapi/com/sun/star/sheet/SheetSortDescriptor.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_SheetSortDescriptor_idl__
  20 #define __com_sun_star_sheet_SheetSortDescriptor_idl__
  21
  22 #include <com/sun/star/table/TableSortDescriptor.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::TableSortDescriptor
  32     service with spreadsheet specific properties.</p>
  33  */
  34 published service SheetSortDescriptor
  35 {
  36
  37     /** provides common table sorting properties.
  38      */
  39     service com::sun::star::table::TableSortDescriptor;
  40
  41
  42     /** specifies if cell formats are moved with the contents
  43         they belong to.
  44      */
  45     [property] boolean BindFormatsToContent;
  46
  47
  48     /** specifies if a user defined sorting list is used.
  49      */
  50     [property] boolean IsUserListEnabled;
  51
  52
  53     /** specifies which user defined sorting list is used.
  54
  55         <p>This property is only used, if
  56         SheetSortDescriptor::IsUserListEnabled is `TRUE`.</p>
  57      */
  58     [property] long UserListIndex;
  59
  60
  61     /** specifies if the sorted data should be copied to another
  62         position in the document.
  63      */
  64     [property] boolean CopyOutputData;
  65
  66
  67     /** specifies the position where sorted data are to be copied.
  68
  69         <p>This property is only used, if
  70         SheetSortDescriptor::CopyOutputData is `TRUE`.</p>
  71      */
  72     [property] com::sun::star::table::CellAddress OutputPosition;
  73
  74 };
  75
  76
  77 }; }; }; };
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */