offapi/com/sun/star/util/XSortable.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSortable.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_util_XSortable_idl__
  31 #define __com_sun_star_util_XSortable_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_PropertyValue_idl__
  38 #include <com/sun/star/beans/PropertyValue.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module util {
  45
  46 //=============================================================================
  47
  48 /** makes it possible to sort the contents of this object.
  49
  50     <p>The available properties describing the sort criterias are
  51     defined in the sort descriptor implemented by the object that
  52     implements this interface.</p>
  53
  54     <p>There are older deprecated sort descriptors:</p>
  55     <ul>
  56         <li>com::sun::star::util::SortDescriptor</li>
  57         <li>com::sun::star::table::TableSortDescriptor</li>
  58         <li>com::sun::star::text::TextSortDescriptor</li>
  59     </ul>
  60
  61     <p>And a new set of sort descriptors:</p>
  62     <ul>
  63         <li>com::sun::star::util::SortDescriptor2</li>
  64         <li>com::sun::star::table::TableSortDescriptor2</li>
  65         <li>com::sun::star::text::TextSortDescriptor2</li>
  66     </ul>
  67
  68     <p>Both types may be implemented by the same object.
  69     When calling the sort method however properties from different
  70     descriptors must not be mixed.</p>
  71  */
  72 published interface XSortable: com::sun::star::uno::XInterface
  73 {
  74     //-------------------------------------------------------------------------
  75     /** @returns
  76             a sequence of properties which allows to specify/modify the
  77             sort criteria.
  78
  79             <p>The set of properties is specific to the type of object that
  80             implements this interface. Therefore they can usually be used
  81             only for objects of that same type.</p>
  82
  83         @see com::sun::star::util::SortDescriptor
  84         @see com::sun::star::table::TableSortDescriptor
  85         @see com::sun::star::text::TextSortDescriptor
  86         @see com::sun::star::util::SortDescriptor2
  87         @see com::sun::star::table::TableSortDescriptor2
  88         @see com::sun::star::text::TextSortDescriptor2
  89
  90      */
  91     sequence< com::sun::star::beans::PropertyValue > createSortDescriptor();
  92
  93     //-------------------------------------------------------------------------
  94     /** sorts the contents of the object according to the specified
  95         properties.
  96
  97         <p>The specified properties are usually the same or a subset of
  98         those obtained by calling <member>createSortDescriptor</member>
  99         on the same type of object.<p>
 100
 101         @see com::sun::star::util::SortDescriptor
 102         @see com::sun::star::table::TableSortDescriptor
 103         @see com::sun::star::text::TextSortDescriptor
 104         @see com::sun::star::util::SortDescriptor2
 105         @see com::sun::star::table::TableSortDescriptor2
 106         @see com::sun::star::text::TextSortDescriptor2
 107      */
 108     void sort( [in] sequence< com::sun::star::beans::PropertyValue > xDescriptor );
 109
 110 };
 111
 112 //=============================================================================
 113
 114 }; }; }; };
 115
 116 #endif