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

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


#ifndef __com_sun_star_util_XSortable_idl__ 
#define __com_sun_star_util_XSortable_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_beans_PropertyValue_idl__ 
#include <com/sun/star/beans/PropertyValue.idl> 
#endif 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module util {  
 
//============================================================================= 
 
/** makes it possible to sort the contents of this object.

    <p>The available properties describing the sort criterias are 
    defined in the sort descriptor implemented by the object that
    implements this interface.</p>

    <p>There are older deprecated sort descriptors:</p>
    <ul>
        <li>com::sun::star::util::SortDescriptor</li>
        <li>com::sun::star::table::TableSortDescriptor</li>
        <li>com::sun::star::text::TextSortDescriptor</li>
    </ul>
    
    <p>And a new set of sort descriptors:</p>
    <ul>
        <li>com::sun::star::util::SortDescriptor2</li>
        <li>com::sun::star::table::TableSortDescriptor2</li>
        <li>com::sun::star::text::TextSortDescriptor2</li>
    </ul>

    <p>Both types may be implemented by the same object.
    When calling the sort method however properties from different
    descriptors must not be mixed.</p>
 */
published interface XSortable: com::sun::star::uno::XInterface
{ 
	//------------------------------------------------------------------------- 
	/** @returns 
            a sequence of properties which allows to specify/modify the 
            sort criteria.

            <p>The set of properties is specific to the type of object that 
            implements this interface. Therefore they can usually be used
            only for objects of that same type.</p>

        @see com::sun::star::util::SortDescriptor
        @see com::sun::star::table::TableSortDescriptor
        @see com::sun::star::text::TextSortDescriptor
        @see com::sun::star::util::SortDescriptor2
        @see com::sun::star::table::TableSortDescriptor2
        @see com::sun::star::text::TextSortDescriptor2
     
     */
    sequence< com::sun::star::beans::PropertyValue > createSortDescriptor(); 
 
	//------------------------------------------------------------------------- 
	/** sorts the contents of the object according to the specified
        properties.

        <p>The specified properties are usually the same or a subset of 
        those obtained by calling <member>createSortDescriptor</member> 
        on the same type of object.<p>

        @see com::sun::star::util::SortDescriptor
        @see com::sun::star::table::TableSortDescriptor
        @see com::sun::star::text::TextSortDescriptor
        @see com::sun::star::util::SortDescriptor2
        @see com::sun::star::table::TableSortDescriptor2
        @see com::sun::star::text::TextSortDescriptor2
     */
    void sort( [in] sequence< com::sun::star::beans::PropertyValue > xDescriptor ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif