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
130
131
132
133
134
135
136
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#if !defined INCLUDED_COMPHELPER_ACCESSIBLEEVENTBUFFER_HXX
#define INCLUDED_COMPHELPER_ACCESSIBLEEVENTBUFFER_HXX
#include "com/sun/star/uno/Reference.hxx"
#include "com/sun/star/uno/Sequence.hxx"
#include <vector>
namespace com { namespace sun { namespace star { namespace uno {
class XInterface;
} } } }
namespace com { namespace sun { namespace star {
namespace accessibility { struct AccessibleEventObject; }
} } }
namespace comphelper {
/**
A buffer for AccessibleEventObjects about to be sent to
XAccessibleEventListeners.
This buffer records pairs of AccessibleEventObjects and sequences of
XAccessibleEventListeners. At a time when it is safe to do so (e.g., when
no critical mutexes are held), all events can be notified at once.
This class is not thread-safe in itself, but it is thread-compatible (i.e.,
all multi-threaded uses of instances of this class have to ensure proper
mutual exclusion).
*/
class AccessibleEventBuffer
{
public:
/**
Create an initially empty buffer.
Internally uses ::std::vector and thus may throw exceptions thrown by
operations on ::std::vector, especially ::std::bad_alloc.
*/
AccessibleEventBuffer();
/**
Create a buffer with a copy of another buffer.
The events from the other buffer are copied, not shared.
Internally uses ::std::vector and thus may throw exceptions thrown by
operations on ::std::vector, especially ::std::bad_alloc.
*/
AccessibleEventBuffer(AccessibleEventBuffer const & rOther);
/**
Destroy the buffer.
If the buffer contains any events that have not yet been sent, those
events are lost.
Does not throw any exceptions.
*/
~AccessibleEventBuffer();
/**
Copy another buffer into this buffer.
If this buffer contained any events that had not yet been sent, those
events are lost. The events from the other buffer are copied, not
shared.
Internally uses ::std::vector and thus may throw exceptions thrown by
operations on ::std::vector, especially ::std::bad_alloc.
*/
AccessibleEventBuffer operator =(AccessibleEventBuffer const & rOther);
/**
Add an event to the buffer.
Internally uses ::std::vector and thus may throw exceptions thrown by
operations on ::std::vector, especially ::std::bad_alloc.
*/
void addEvent(
::com::sun::star::accessibility::AccessibleEventObject const &
rEvent,
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference<
::com::sun::star::uno::XInterface > > const & rListeners);
/**
Sends all the events accumulated in the buffer.
If sending any of the events to a specific XAccessibleListener fails with
a RuntimeException, that exception is ignored and the method carries on
with the rest of the notifications.
After sending all events, the buffer is cleared.
*/
void sendEvents() const;
private:
struct Entry;
typedef ::std::vector< Entry > Entries;
Entries m_aEntries;
};
}
#endif // INCLUDED_COMPHELPER_ACCESSIBLEEVENTBUFFER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
