helper class for simple notification of the form LISTENER::METHOD( EVENT ) More...
#include <listenernotification.hxx>
Inheritance diagram for comphelper::OSimpleListenerContainer< LISTENER, EVENT >:
Collaboration diagram for comphelper::OSimpleListenerContainer< LISTENER, EVENT >:
Public Types | |
| typedef LISTENER | ListenerClass |
| typedef EVENT | EventClass |
Public Member Functions | |
| typedef | void (SAL_CALL LISTENER::*NotificationMethod)(const EventClass &) |
| OSimpleListenerContainer (::osl::Mutex &_rMutex) | |
| void | addListener (const css::uno::Reference< ListenerClass > &_rxListener) |
| void | removeListener (const css::uno::Reference< ListenerClass > &_rxListener) |
| void | notify (const EventClass &_rEvent, NotificationMethod _pNotify) |
| typed notification More... | |
Protected Member Functions | |
| virtual bool | implNotify (const css::uno::Reference< css::lang::XEventListener > &_rxListener, const css::lang::EventObject &_rEvent) override |
| call a single listener More... | |
 Protected Member Functions inherited from comphelper::OListenerContainer | |
| OListenerContainer (::osl::Mutex &_rMutex) | |
| virtual | ~OListenerContainer () |
| void | impl_addListener (const css::uno::Reference< css::lang::XEventListener > &_rxListener) |
| void | impl_removeListener (const css::uno::Reference< css::lang::XEventListener > &_rxListener) |
| bool | impl_notify (const css::lang::EventObject &_rEvent) |
| notifies all listeners of the given event, using THB's notification pattern More... | |
| void | disposing (const css::lang::EventObject &_rEventSource) |
| sends a XEventObject::disposing notification to all listeners, and clears the listener container More... | |
| void | clear () |
| clears the container without calling <member scope="css::lang">XEventListener::disposing</member> at the listeners More... | |
| bool | empty () const |
| determines whether the listener container is currently empty More... | |
| ::std::unique_ptr< ::comphelper::OInterfaceIteratorHelper2 > | createIterator () |
| creates an iterator for looping through all registered listeners More... | |
Private Attributes | |
| NotificationMethod | m_pNotificationMethod |
Detailed Description
template<class LISTENER, class EVENT>
class comphelper::OSimpleListenerContainer< LISTENER, EVENT >
helper class for simple notification of the form LISTENER::METHOD( EVENT )
This class is not threadsafe!
- Parameters
-
LISTENER the listener class to call, e.g. css::lang::XEventListener EVENT the event type to notify, e.g. css::lang::EventObject
Definition at line 156 of file listenernotification.hxx.
Member Typedef Documentation
template<class LISTENER, class EVENT>
| typedef EVENT comphelper::OSimpleListenerContainer< LISTENER, EVENT >::EventClass |
Definition at line 160 of file listenernotification.hxx.
template<class LISTENER, class EVENT>
| typedef LISTENER comphelper::OSimpleListenerContainer< LISTENER, EVENT >::ListenerClass |
Definition at line 159 of file listenernotification.hxx.
Constructor & Destructor Documentation
template<class LISTENER, class EVENT>
|
inline |
Definition at line 167 of file listenernotification.hxx.
Member Function Documentation
template<class LISTENER, class EVENT>
|
inline |
Definition at line 173 of file listenernotification.hxx.
template<class LISTENER, class EVENT>
|
inlineoverrideprotectedvirtual |
call a single listener
- Exceptions
-
css::uno::Exception if the listener throws an exception during notification. Please don't catch any listener exceptions in your implementation of this method, simply let them pass to the caller.
- Parameters
-
_rxListener specifies the listener to call. Is guaranteed to not be <NULL> _rEvent the event to broadcast. This is the same as passed to <member>notify</member>, so if your base class knows the type passed into <member>notify</member>, it can safely assume that <arg>_rEvent</arg> is also of this type.
- Returns
- <TRUE> if the remaining listeners should be called, <FALSE> if the notification loop should be cancelled
- See also
- notify
Implements comphelper::OListenerContainer.
Definition at line 193 of file listenernotification.hxx.
template<class LISTENER , class EVENT >
|
inline |
typed notification
Definition at line 207 of file listenernotification.hxx.
References comphelper::OListenerContainer::impl_notify().
template<class LISTENER, class EVENT>
|
inline |
Definition at line 178 of file listenernotification.hxx.
template<class LISTENER, class EVENT>
| typedef comphelper::OSimpleListenerContainer< LISTENER, EVENT >::void | ( | SAL_CALL LISTENER::* | NotificationMethod | ) | const |
Member Data Documentation
template<class LISTENER, class EVENT>
|
private |
Definition at line 164 of file listenernotification.hxx.
Referenced by comphelper::OSimpleListenerContainer< css::beans::XPropertyChangeListener, css::beans::PropertyChangeEvent >::implNotify().
The documentation for this class was generated from the following file:
