allows to control notification behavior of a broadcaster. More...
import"XBroadcaster.idl";
Public Member Functions | |
| void | lockBroadcasts () |
| suspends broadcasts to the registered listeners. More... | |
| void | unlockBroadcasts () |
| resumes the broadcasts which were suspended by XBroadcaster::lockBroadcasts(). More... | |
 Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More... | |
| void | acquire () |
| increases the reference counter by one. More... | |
| void | release () |
| decreases the reference counter by one. More... | |
Detailed Description
allows to control notification behavior of a broadcaster.
- Since
- OOo 3.0
Member Function Documentation
◆ lockBroadcasts()
| void lockBroadcasts | ( | ) |
suspends broadcasts to the registered listeners.
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.
◆ unlockBroadcasts()
| void unlockBroadcasts | ( | ) |
resumes the broadcasts which were suspended by XBroadcaster::lockBroadcasts().
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.
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.
The documentation for this interface was generated from the following file:
- com/sun/star/util/XBroadcaster.idl
