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