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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
/*************************************************************************
*
* 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: bufferedgraphicdevicebase.hxx,v $
* $Revision: 1.2 $
*
* 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 INCLUDED_CANVAS_BUFFEREDGRAPHICDEVICEBASE_HXX
#define INCLUDED_CANVAS_BUFFEREDGRAPHICDEVICEBASE_HXX
#ifndef _COM_SUN_STAR_AWT_XWINDOW2_HPP_
#include <com/sun/star/awt/XWindow2.hpp>
#endif
#ifndef _COM_SUN_STAR_AWT_XTOPWINDOW_HPP_
#include <com/sun/star/awt/XTopWindow.hpp>
#endif
#ifndef _COM_SUN_STAR_AWT_XWINDOWLISTENER_HPP_
#include <com/sun/star/awt/XWindowListener.hpp>
#endif
#ifndef INCLUDED_CANVAS_CANVASTOOLS_HXX
#include <canvas/canvastools.hxx>
#endif
#ifndef INCLUDED_CANVAS_GRAPHICDEVICEBASE_HXX
#include <canvas/base/graphicdevicebase.hxx>
#endif
/* Definition of BufferedGraphicDeviceBase class */
namespace canvas
{
/** Helper template base class for XGraphicDevice implementations
on windows.
Use this base class if your target device is a
window. Additionally to GraphicDeviceBase, this template
provides an implementation of the awt::XWindowListener
interface, to receive notifications about state changes of the
associated window.
@tpl Base
Base class to use, most probably one of the
WeakComponentImplHelperN templates with the appropriate
interfaces. At least XGraphicDevice should be among them (why else
would you use this template, then?). Base class must have an
Base( const Mutex& ) constructor (like the
WeakComponentImplHelperN templates have). As the very least,
the base class must be derived from uno::XInterface, as some
error reporting mechanisms rely on that.
@tpl DeviceHelper
Device helper implementation for the backend in question. This
object will be held as a member of this template class, and
basically gets forwarded all XGraphicDevice API calls that
could not be handled generically.
@tpl Mutex
Lock strategy to use. Defaults to using the
OBaseMutex-provided lock. Everytime one of the methods is
entered, an object of type Mutex is created with m_aMutex as
the sole parameter, and destroyed again when the method scope
is left.
@tpl UnambiguousBase
Optional unambiguous base class for XInterface of Base. It's
sometimes necessary to specify this parameter, e.g. if Base
derives from multiple UNO interface (were each provides its
own version of XInterface, making the conversion ambiguous)
*/
template< class Base,
class DeviceHelper,
class Mutex=::osl::MutexGuard,
class UnambiguousBase=::com::sun::star::uno::XInterface > class BufferedGraphicDeviceBase :
public GraphicDeviceBase< Base, DeviceHelper, Mutex, UnambiguousBase >
{
public:
typedef GraphicDeviceBase< Base, DeviceHelper, Mutex, UnambiguousBase > BaseType;
typedef BufferedGraphicDeviceBase OurType;
typedef Mutex MutexType;
BufferedGraphicDeviceBase() :
mxWindow(),
maBounds(),
mbIsVisible( false ),
mbIsTopLevel( false )
{
BaseType::maPropHelper.addProperties( PropertySetHelper::MakeMap
("Window",
boost::bind(&OurType::getXWindow,
this)));
}
// XGraphicDevice
virtual ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XBufferController > SAL_CALL getBufferController( ) throw (::com::sun::star::uno::RuntimeException)
{
return this;
}
// XBufferController
virtual ::sal_Int32 SAL_CALL createBuffers( ::sal_Int32 nBuffers ) throw (::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::RuntimeException)
{
tools::verifyRange( nBuffers, (sal_Int32)1 );
MutexType aGuard( BaseType::m_aMutex );
return BaseType::maDeviceHelper.createBuffers( nBuffers );
}
virtual void SAL_CALL destroyBuffers( ) throw (::com::sun::star::uno::RuntimeException)
{
MutexType aGuard( BaseType::m_aMutex );
BaseType::maDeviceHelper.destroyBuffers();
}
virtual ::sal_Bool SAL_CALL showBuffer( ::sal_Bool bUpdateAll ) throw (::com::sun::star::uno::RuntimeException)
{
MutexType aGuard( BaseType::m_aMutex );
return BaseType::maDeviceHelper.showBuffer( mbIsVisible, bUpdateAll );
}
virtual ::sal_Bool SAL_CALL switchBuffer( ::sal_Bool bUpdateAll ) throw (::com::sun::star::uno::RuntimeException)
{
MutexType aGuard( BaseType::m_aMutex );
return BaseType::maDeviceHelper.switchBuffer( mbIsVisible, bUpdateAll );
}
/** Set corresponding canvas window
Use this method to set the window this canvas displays
on. Comes in handy when the canvas needs to adapt size or
output position to the changing window.
Whenever the bounds of the window change, <code>void
notifySizeUpdate( const awt::Rectangle& rBounds )</code>
is called, with rBounds the window bound rect relative to
the frame window.
*/
void setWindow( const ::com::sun::star::uno::Reference<
::com::sun::star::awt::XWindow2 >& rWindow )
{
if( mxWindow.is() )
mxWindow->removeWindowListener( this );
mxWindow = rWindow;
if( mxWindow.is() )
{
mbIsVisible = mxWindow->isVisible();
mbIsTopLevel =
::com::sun::star::uno::Reference< ::com::sun::star::awt::XTopWindow >(
mxWindow,
::com::sun::star::uno::UNO_QUERY ).is();
maBounds = transformBounds( mxWindow->getPosSize() );
mxWindow->addWindowListener( this );
}
}
::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow2 > getWindow() const
{
return mxWindow;
}
::com::sun::star::uno::Any getXWindow() const
{
return ::com::sun::star::uno::makeAny(mxWindow);
}
#if defined __SUNPRO_CC
using Base::disposing;
#endif
virtual void SAL_CALL disposing()
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
if( mxWindow.is() )
{
mxWindow->removeWindowListener(this);
mxWindow.clear();
}
// pass on to base class
BaseType::disposing();
}
::com::sun::star::awt::Rectangle transformBounds( const ::com::sun::star::awt::Rectangle& rBounds )
{
// notifySizeUpdate's bounds are relative to the toplevel
// window
if( !mbIsTopLevel )
return tools::getAbsoluteWindowRect(
rBounds,
mxWindow );
else
return ::com::sun::star::awt::Rectangle( 0,0,rBounds.Width,rBounds.Height );
}
void boundsChanged( const ::com::sun::star::awt::WindowEvent& e )
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
const ::com::sun::star::awt::Rectangle& rNewBounds(
transformBounds(
::com::sun::star::awt::Rectangle( e.X,
e.Y,
e.Width,
e.Height )));
if( rNewBounds.X != maBounds.X ||
rNewBounds.Y != maBounds.Y ||
rNewBounds.Width != maBounds.Width ||
rNewBounds.Height != maBounds.Height )
{
maBounds = rNewBounds;
BaseType::maDeviceHelper.notifySizeUpdate( maBounds );
}
}
// XWindowListener
virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException)
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
if( Source.Source == mxWindow )
mxWindow.clear();
}
virtual void SAL_CALL windowResized( const ::com::sun::star::awt::WindowEvent& e ) throw (::com::sun::star::uno::RuntimeException)
{
boundsChanged( e );
}
virtual void SAL_CALL windowMoved( const ::com::sun::star::awt::WindowEvent& e ) throw (::com::sun::star::uno::RuntimeException)
{
boundsChanged( e );
}
virtual void SAL_CALL windowShown( const ::com::sun::star::lang::EventObject& ) throw (::com::sun::star::uno::RuntimeException)
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
mbIsVisible = true;
}
virtual void SAL_CALL windowHidden( const ::com::sun::star::lang::EventObject& ) throw (::com::sun::star::uno::RuntimeException)
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
mbIsVisible = false;
}
protected:
::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow2 > mxWindow;
/// Current bounds of the owning Window
::com::sun::star::awt::Rectangle maBounds;
/// True, if the window this canvas is contained in, is visible
bool mbIsVisible;
private:
/// True, if the window this canvas is contained in, is a toplevel window
bool mbIsTopLevel;
};
}
#endif /* INCLUDED_CANVAS_BUFFEREDGRAPHICDEVICEBASE_HXX */
|
