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 --- .../com/sun/star/view/XMultiSelectionSupplier.idl | 113 +++++++++++++++++++++ 1 file changed, 113 insertions(+) create mode 100644 offapi/com/sun/star/view/XMultiSelectionSupplier.idl (limited to 'offapi/com/sun/star/view/XMultiSelectionSupplier.idl') diff --git a/offapi/com/sun/star/view/XMultiSelectionSupplier.idl b/offapi/com/sun/star/view/XMultiSelectionSupplier.idl new file mode 100644 index 000000000..d7c8bd9e0 --- /dev/null +++ b/offapi/com/sun/star/view/XMultiSelectionSupplier.idl @@ -0,0 +1,113 @@ +/* -*- 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_view_XMultiSelectionSupplier_idl__ +#define __com_sun_star_view_XMultiSelectionSupplier_idl__ + +#include +#include + + +module com { module sun { module star { module view { + + +/** makes it possible to append and remove objects from a selection. + +

The method XSelectionSupplier::setSelection() for an + instance that also supports XMultiSelectionSupplier should + be implemented that it also takes either a selectable object or a sequence + of selectable objects.

+ +

Adding an object more than once to a selection should not toggle the + selection for that object but only select it once

+ */ +interface XMultiSelectionSupplier: XSelectionSupplier +{ + + /** adds the object or the objects represented by Selection to the selection + of this XMultiSelectionSupplier. + + @param Selection + either an Object that is selectable or a sequence of objects that are selectable. + + @returns + `TRUE`/, if Selection was added to the current selection. + `FALSE`, if Selection or parts of Selection could not be + added to the current selection. For example, if the selection already contains + objects that are forbidden to be selected together with Selection + + @throws com::sun::star::lang::IllegalArgumentException + If Selection is not a selectable object for this XMultiSelectionSupplier. +

Adding an object to the selection that is already part of the selection should not raise this exception

+ */ + boolean addSelection( [in] any Selection ) + raises( com::sun::star::lang::IllegalArgumentException ); + + + /** remove the object or objects represented by Selection from the + selection of this XMultiSelectionSupplier. + + @param Selection + either an Object that is selectable or a sequence of objects that are selectable. + + @returns + `TRUE`/, if Selection was added to the current selection. + `FALSE`, if Selection or parts of Selection could not be + added to the current selection. For example, if the selection already contains + objects that are forbidden to be selected together with Selection. + + @throws com::sun::star::lang::IllegalArgumentException + If Selection is not a selectable object for this XMultiSelectionSupplier. +

Removing an object from the selection that is not part of the selection should not raise this exception

+ */ + void removeSelection( [in] any Selection ) + raises( com::sun::star::lang::IllegalArgumentException ); + + + /** clears the selection of this XMultiSelectionSupplier. + */ + void clearSelection(); + + + /** returns the number of selected objects of this XMultiSelectionSupplier. + */ + long getSelectionCount(); + + + /** @returns + a new object to enumerate the selection of this XMultiSelectionSupplier. + It returns NULL if there are no objects in the selection. + */ + com::sun::star::container::XEnumeration createSelectionEnumeration(); + + + /** @returns + a new object to enumerate the selection of this XMultiSelectionSupplier + in reverse order. If the order of the selected objects + It returns NULL if there are no objects in the selection. + */ + com::sun::star::container::XEnumeration createReverseSelectionEnumeration(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3