diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/util/XBroadcaster.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | offapi/com/sun/star/util/XBroadcaster.idl | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/offapi/com/sun/star/util/XBroadcaster.idl b/offapi/com/sun/star/util/XBroadcaster.idl new file mode 100644 index 000000000..f0a4fd250 --- /dev/null +++ b/offapi/com/sun/star/util/XBroadcaster.idl @@ -0,0 +1,72 @@ +/* -*- 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_XBroadcaster_idl__ +#define __com_sun_star_util_XBroadcaster_idl__ + +#include <com/sun/star/uno/XInterface.idl> + + +module com { module sun { module star { module util { + + +/** allows to control notification behavior of a broadcaster. + + @since OOo 3.0 + */ +interface XBroadcaster: com::sun::star::uno::XInterface +{ + /** suspends broadcasts to the registered listeners. + + <p> + The calls to XBroadcaster::lockBroadcasts() and + XBroadcaster::unlockBroadcasts() may be + nested and even overlapping, but they must be in pairs. While + there is at least one lock remaining, no broadcasts are + sent to registered listeners. + </p> + */ + void lockBroadcasts(); + + /** resumes the broadcasts which were suspended by + XBroadcaster::lockBroadcasts(). + + <p> + The calls to XBroadcaster::lockBroadcasts() and + XBroadcaster::unlockBroadcasts() may be + nested and even overlapping, but they must be in pairs. While + there is at least one lock remaining, no broadcasts are + sent to registered listeners. + </p> + + <p> Pending broadcasts will be sent immediately after the last + call to XBroadcaster::lockBroadcasts() is matched + by a call to XBroadcaster::unlockBroadcasts(). + An implementation can decide to broadcast all pending notification in + order or batch them in single broadcasts. + </p> + */ + void unlockBroadcasts(); +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |