1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/* -*- 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 INCLUDED_COMPHELPER_ACCESSIBLEEVENTNOTIFIER_HXX
#define INCLUDED_COMPHELPER_ACCESSIBLEEVENTNOTIFIER_HXX
#include <com/sun/star/accessibility/AccessibleEventObject.hpp>
#include <com/sun/star/accessibility/XAccessibleEventListener.hpp>
#include <comphelper/comphelperdllapi.h>
namespace comphelper
{
//= AccessibleEventNotifier
class COMPHELPER_DLLPUBLIC AccessibleEventNotifier
{
// typedefs
public:
typedef sal_uInt32 TClientId;
protected:
AccessibleEventNotifier( ); // never implemented
~AccessibleEventNotifier( ); // never implemented
private:
AccessibleEventNotifier( const AccessibleEventNotifier& ) = delete;
AccessibleEventNotifier& operator=( const AccessibleEventNotifier& ) = delete;
public:
/** 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 ::com::sun::star::uno::Reference< ::com::sun::star::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 ::com::sun::star::uno::Reference< ::com::sun::star::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 ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleEventListener >& _rxListener
);
/** adds an event, which is to be braodcasted, to the queue
@param _nClient
the id of the client which needs to broadcast the event
*/
static void addEvent(
const TClientId _nClient,
const ::com::sun::star::accessibility::AccessibleEventObject& _rEvent
);
};
} // namespace comphelper
#endif // INCLUDED_COMPHELPER_ACCESSIBLEEVENTNOTIFIER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
