From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- offapi/com/sun/star/util/XSortable.idl | 98 ++++++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 offapi/com/sun/star/util/XSortable.idl (limited to 'offapi/com/sun/star/util/XSortable.idl') diff --git a/offapi/com/sun/star/util/XSortable.idl b/offapi/com/sun/star/util/XSortable.idl new file mode 100644 index 000000000..7093a0469 --- /dev/null +++ b/offapi/com/sun/star/util/XSortable.idl @@ -0,0 +1,98 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_util_XSortable_idl__ +#define __com_sun_star_util_XSortable_idl__ + +#include + +#include + + + +module com { module sun { module star { module util { + + +/** makes it possible to sort the contents of this object. + +

The available properties describing the sort criteria are + defined in the sort descriptor implemented by the object that + implements this interface.

+ +

There are older deprecated sort descriptors:

+
    +
  • com::sun::star::util::SortDescriptor
  • +
  • com::sun::star::table::TableSortDescriptor
  • +
  • com::sun::star::text::TextSortDescriptor
  • +
+ +

And a new set of sort descriptors:

+
    +
  • com::sun::star::util::SortDescriptor2
  • +
  • com::sun::star::table::TableSortDescriptor2
  • +
  • com::sun::star::text::TextSortDescriptor2
  • +
+ +

Both types may be implemented by the same object. + When calling the sort method however properties from different + descriptors must not be mixed.

+ */ +published interface XSortable: com::sun::star::uno::XInterface +{ + /** @returns + a sequence of properties which allows to specify/modify the + sort criteria. + +

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.

+ + @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. + +

The specified properties are usually the same or a subset of + those obtained by calling createSortDescriptor() + on the same type of object.

+ + @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 + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3