Quelle  XSortable.idl   Sprache: unbekannt

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */



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 criteria 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 createSortDescriptor()
        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 );

};


}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */