offapi/com/sun/star/util/XSortable.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_util_XSortable_idl__
  20 #define __com_sun_star_util_XSortable_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/beans/PropertyValue.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module util {
  29
  30
  31 /** makes it possible to sort the contents of this object.
  32
  33     <p>The available properties describing the sort criteria are
  34     defined in the sort descriptor implemented by the object that
  35     implements this interface.</p>
  36
  37     <p>There are older deprecated sort descriptors:</p>
  38     <ul>
  39         <li>com::sun::star::util::SortDescriptor</li>
  40         <li>com::sun::star::table::TableSortDescriptor</li>
  41         <li>com::sun::star::text::TextSortDescriptor</li>
  42     </ul>
  43
  44     <p>And a new set of sort descriptors:</p>
  45     <ul>
  46         <li>com::sun::star::util::SortDescriptor2</li>
  47         <li>com::sun::star::table::TableSortDescriptor2</li>
  48         <li>com::sun::star::text::TextSortDescriptor2</li>
  49     </ul>
  50
  51     <p>Both types may be implemented by the same object.
  52     When calling the sort method however properties from different
  53     descriptors must not be mixed.</p>
  54  */
  55 published interface XSortable: com::sun::star::uno::XInterface
  56 {
  57     /** @returns
  58             a sequence of properties which allows to specify/modify the
  59             sort criteria.
  60
  61             <p>The set of properties is specific to the type of object that
  62             implements this interface. Therefore they can usually be used
  63             only for objects of that same type.</p>
  64
  65         @see com::sun::star::util::SortDescriptor
  66         @see com::sun::star::table::TableSortDescriptor
  67         @see com::sun::star::text::TextSortDescriptor
  68         @see com::sun::star::util::SortDescriptor2
  69         @see com::sun::star::table::TableSortDescriptor2
  70         @see com::sun::star::text::TextSortDescriptor2
  71
  72      */
  73     sequence< com::sun::star::beans::PropertyValue > createSortDescriptor();
  74
  75     /** sorts the contents of the object according to the specified
  76         properties.
  77
  78         <p>The specified properties are usually the same or a subset of
  79         those obtained by calling createSortDescriptor()
  80         on the same type of object.<p>
  81
  82         @see com::sun::star::util::SortDescriptor
  83         @see com::sun::star::table::TableSortDescriptor
  84         @see com::sun::star::text::TextSortDescriptor
  85         @see com::sun::star::util::SortDescriptor2
  86         @see com::sun::star::table::TableSortDescriptor2
  87         @see com::sun::star::text::TextSortDescriptor2
  88      */
  89     void sort( [in] sequence< com::sun::star::beans::PropertyValue > xDescriptor );
  90
  91 };
  92
  93
  94 }; }; }; };
  95
  96 #endif
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */