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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: otasksaccess.hxx,v $
* $Revision: 1.6 $
*
* 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.
*
************************************************************************/
#ifndef __FRAMEWORK_HELPER_OTASKSACCESS_HXX_
#define __FRAMEWORK_HELPER_OTASKSACCESS_HXX_
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
#include <classes/framecontainer.hxx>
#include <threadhelp/threadhelpbase.hxx>
#include <macros/generic.hxx>
#include <macros/xinterface.hxx>
#include <macros/xtypeprovider.hxx>
#include <macros/debug.hxx>
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
#include <com/sun/star/container/XEnumerationAccess.hpp>
#include <com/sun/star/container/XElementAccess.hpp>
#include <com/sun/star/container/XEnumeration.hpp>
#include <com/sun/star/frame/XDesktop.hpp>
//_________________________________________________________________________________________________________________
// other includes
//_________________________________________________________________________________________________________________
#include <cppuhelper/weak.hxx>
#include <cppuhelper/weakref.hxx>
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework{
//_________________________________________________________________________________________________________________
// exported const
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// exported definitions
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@short implement XEnumerationAccess interface as helper to create many oneway enumeration of tasks
@descr We share mutex and framecontainer with ouer owner and have full access to his child tasks.
(Ouer owner can be the Desktop only!) We create oneway enumerations on demand. These "lists"
can be used for one time only. Step during the list from first to last element.
(The type of created enumerations is OTasksEnumeration.)
@implements XInterface
XEnumerationAccess
XElementAccess
@base OWeakObject
@devstatus deprecated
*//*-*************************************************************************************************************/
class OTasksAccess : public css::lang::XTypeProvider ,
public css::container::XEnumerationAccess , // => XElementAccess
private ThreadHelpBase ,
public ::cppu::OWeakObject
{
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
//---------------------------------------------------------------------------------------------------------
// constructor / destructor
//---------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short constructor to initialize this instance
@descr A desktop will create an enumeration-access-object. An enumeration is a oneway-list and a
snapshot of the tasklist of current tasks of desktop.
But we need a instance to create more then one enumerations to the same tasklist!
@seealso class Desktop
@seealso class OTasksEnumeration
@param "xOwner" is a reference to ouer owner and must be the desktop!
@param "pTasks" is a pointer to the taskcontainer of the desktop. We need it to create a new enumeration.
@return -
@onerror Do nothing and reset this object to default with an empty list.
*//*-*****************************************************************************************************/
OTasksAccess( const css::uno::Reference< css::frame::XDesktop >& xOwner ,
FrameContainer* pTasks );
//---------------------------------------------------------------------------------------------------------
// XInterface
//---------------------------------------------------------------------------------------------------------
DECLARE_XINTERFACE
DECLARE_XTYPEPROVIDER
//---------------------------------------------------------------------------------------------------------
// XEnumerationAccess
//---------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short create a new enumeration of tasks
@descr You can call this method to get a new snapshot to all tasks of the desktop as an enumeration.
@seealso interface XEnumerationAccess
@seealso interface XEnumeration
@seealso class Desktop
@param -
@return If the desktop and some tasks exist => a valid reference to an enumeration<BR>
An NULL-reference, other way.
@onerror -
*//*-*****************************************************************************************************/
virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL createEnumeration() throw( css::uno::RuntimeException );
//---------------------------------------------------------------------------------------------------------
// XElementAccess
//---------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short get the type of elements in enumeration
@descr -
@seealso interface XElementAccess
@seealso class TasksEnumeration
@param -
@return The uno-type XTask.
@onerror -
*//*-*****************************************************************************************************/
virtual css::uno::Type SAL_CALL getElementType() throw( css::uno::RuntimeException );
/*-****************************************************************************************************//**
@short get state of tasklist of enumeration.
@descr -
@seealso interface XElementAccess
@param -
@return sal_True ,if more then 0 elements exist.
@return sal_False ,otherwise.
@onerror -
*//*-*****************************************************************************************************/
virtual sal_Bool SAL_CALL hasElements() throw( css::uno::RuntimeException );
//-------------------------------------------------------------------------------------------------------------
// protected methods
//-------------------------------------------------------------------------------------------------------------
protected:
/*-****************************************************************************************************//**
@short standard destructor
@descr This method destruct an instance of this class and clear some member.
Don't use an instance of this class as normal member. Use it dynamicly with a pointer.
We hold a weakreference to ouer owner and not to ouer superclass!
Thats the reason for a protected dtor.
@seealso class Desktop
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual ~OTasksAccess();
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
private:
//-------------------------------------------------------------------------------------------------------------
// debug methods
// (should be private everyway!)
//-------------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short debug-method to check incoming parameter of some other mehods of this class
@descr The following methods are used to check parameters for other methods
of this class. The return value is used directly for an ASSERT(...).
@seealso ASSERTs in implementation!
@param references to checking variables
@return sal_False ,on invalid parameter.
@return sal_True ,otherwise
@onerror -
*//*-*****************************************************************************************************/
#ifdef ENABLE_ASSERTIONS
private:
static sal_Bool impldbg_checkParameter_OTasksAccessCtor( const css::uno::Reference< css::frame::XDesktop >& xOwner ,
FrameContainer* pTasks );
#endif // #ifdef ENABLE_ASSERTIONS
//-------------------------------------------------------------------------------------------------------------
// variables
// (should be private everyway!)
//-------------------------------------------------------------------------------------------------------------
private:
css::uno::WeakReference< css::frame::XDesktop > m_xOwner ; /// weak reference to the desktop object!
FrameContainer* m_pTasks ; /// pointer to list of current tasks on desktop (is a member of class Desktop!)
/// This pointer is valid only, if weakreference can be locked.
}; // class OTasksAccess
} // namespace framework
#endif // #ifndef __FRAMEWORK_HELPER_OTASKSACCESS_HXX_
|
