diff options
author | Kohei Yoshida <kohei.yoshida@collabora.com> | 2017-02-18 19:01:14 -0500 |
---|---|---|
committer | Kohei Yoshida <libreoffice@kohei.us> | 2017-02-19 01:57:37 +0000 |
commit | 6ba107fbab8a110a6545a935bbdbdb9356d53d61 (patch) | |
tree | 70a5257f8ce9e8b1c79b44c7254e2c9d3798c2e1 /include/comphelper | |
parent | Fix headless build (diff) | |
download | core-6ba107fbab8a110a6545a935bbdbdb9356d53d61.tar.gz core-6ba107fbab8a110a6545a935bbdbdb9356d53d61.zip |
Consistent formatting & indentation.
Change-Id: I5dce7d05156313d460533040b8f7a3de3d8c59d7
Reviewed-on: https://gerrit.libreoffice.org/34420
Reviewed-by: Kohei Yoshida <libreoffice@kohei.us>
Tested-by: Kohei Yoshida <libreoffice@kohei.us>
Diffstat (limited to 'include/comphelper')
-rw-r--r-- | include/comphelper/accessibleeventnotifier.hxx | 169 |
1 files changed, 79 insertions, 90 deletions
diff --git a/include/comphelper/accessibleeventnotifier.hxx b/include/comphelper/accessibleeventnotifier.hxx index 572ac77168f1..f8cf110f65ad 100644 --- a/include/comphelper/accessibleeventnotifier.hxx +++ b/include/comphelper/accessibleeventnotifier.hxx @@ -25,98 +25,87 @@ #include <comphelper/comphelperdllapi.h> +namespace comphelper { -namespace comphelper +class COMPHELPER_DLLPUBLIC AccessibleEventNotifier { - - - //= AccessibleEventNotifier - - class COMPHELPER_DLLPUBLIC AccessibleEventNotifier - { - // typedefs - public: - typedef sal_uInt32 TClientId; - - public: - AccessibleEventNotifier() = delete; - ~AccessibleEventNotifier() = delete; - AccessibleEventNotifier( const AccessibleEventNotifier& ) = delete; - AccessibleEventNotifier& operator=( const AccessibleEventNotifier& ) = delete; - - /** registers a client of this class, means a broadcaster of AccessibleEvents - - <p>No precaution is taken to care for disposal of this component. When the component - dies, it <b>must</b> call <member>revokeClient</member> or <member>revokeClientNotifyDisposing</member> - explicitly itself.</p> - */ - static TClientId registerClient( ); - - /** revokes a broadcaster of AccessibleEvents - - <p>Note that no disposing event is fired when you use this method, the client is simply revoked. - You can for instance revoke a client if the last listener for it is revoked, but the client - itself is not disposed.<br/> - When the client is disposed, you should prefer <member>revokeClientNotifyDisposing</member></p> - - <p>Any possibly pending events for this client are removed from the queue.</p> - - @seealso revokeClientNotifyDisposing - */ - static void revokeClient( const TClientId _nClient ); - - /** revokes a client, with additionally notifying a disposing event to all listeners registered for - this client - - <p>Any other possibly pending events for this client are removed from the queue</p> - - @param _nClient - the id of the client which should be revoked - @param _rxEventSource - the source to be notified together with the <member scope="com.sun.star.lang">XComponent::disposing</member> - call. - */ - static void revokeClientNotifyDisposing( - const TClientId _nClient, - const css::uno::Reference< css::uno::XInterface >& _rxEventSource - ); - - /** registers a listener for the given client - - @param _nClient - the id of the client for which a listener should be registered - @return - the number of event listeners currently registered for this client - */ - static sal_Int32 addEventListener( - const TClientId _nClient, - const css::uno::Reference< css::accessibility::XAccessibleEventListener >& _rxListener - ); - - /** revokes a listener for the given client - - @param _nClient - the id of the client for which a listener should be revoked - @return - the number of event listeners currently registered for this client - */ - static sal_Int32 removeEventListener( - const TClientId _nClient, - const css::uno::Reference< css::accessibility::XAccessibleEventListener >& _rxListener - ); - - /** adds an event, which is to be broadcasted, to the queue - - @param _nClient - the id of the client which needs to broadcast the event - */ - static void addEvent( - const TClientId _nClient, - const css::accessibility::AccessibleEventObject& _rEvent - ); - - }; - +public: + typedef sal_uInt32 TClientId; + +public: + AccessibleEventNotifier() = delete; + ~AccessibleEventNotifier() = delete; + AccessibleEventNotifier( const AccessibleEventNotifier& ) = delete; + AccessibleEventNotifier& operator=( const AccessibleEventNotifier& ) = delete; + + /** registers a client of this class, means a broadcaster of AccessibleEvents + + <p>No precaution is taken to care for disposal of this component. When the component + dies, it <b>must</b> call <member>revokeClient</member> or <member>revokeClientNotifyDisposing</member> + explicitly itself.</p> + */ + static TClientId registerClient(); + + /** revokes a broadcaster of AccessibleEvents + + <p>Note that no disposing event is fired when you use this method, the client is simply revoked. + You can for instance revoke a client if the last listener for it is revoked, but the client + itself is not disposed.<br/> + When the client is disposed, you should prefer <member>revokeClientNotifyDisposing</member></p> + + <p>Any possibly pending events for this client are removed from the queue.</p> + + @seealso revokeClientNotifyDisposing + */ + static void revokeClient( const TClientId _nClient ); + + /** revokes a client, with additionally notifying a disposing event to all listeners registered for + this client + + <p>Any other possibly pending events for this client are removed from the queue</p> + + @param _nClient + the id of the client which should be revoked + @param _rxEventSource + the source to be notified together with the <member scope="com.sun.star.lang">XComponent::disposing</member> + call. + */ + static void revokeClientNotifyDisposing( + const TClientId _nClient, + const css::uno::Reference< css::uno::XInterface >& _rxEventSource ); + + /** registers a listener for the given client + + @param _nClient + the id of the client for which a listener should be registered + @return + the number of event listeners currently registered for this client + */ + static sal_Int32 addEventListener( + const TClientId _nClient, + const css::uno::Reference< css::accessibility::XAccessibleEventListener >& _rxListener ); + + /** revokes a listener for the given client + + @param _nClient + the id of the client for which a listener should be revoked + @return + the number of event listeners currently registered for this client + */ + static sal_Int32 removeEventListener( + const TClientId _nClient, + const css::uno::Reference< css::accessibility::XAccessibleEventListener >& _rxListener ); + + /** adds an event, which is to be broadcasted, to the queue + + @param _nClient + the id of the client which needs to broadcast the event + */ + static void addEvent( + const TClientId _nClient, + const css::accessibility::AccessibleEventObject& _rEvent ); + +}; } // namespace comphelper |