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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
/* -*- 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 .
*/
#include <dispatch/menudispatcher.hxx>
#include <general.h>
#include <framework/menuconfiguration.hxx>
#include <framework/addonmenu.hxx>
#include <services.h>
#include <com/sun/star/frame/FrameSearchFlag.hpp>
#include <com/sun/star/awt/WindowAttribute.hpp>
#include <com/sun/star/awt/WindowDescriptor.hpp>
#include <com/sun/star/awt/PosSize.hpp>
#include <com/sun/star/awt/XWindowPeer.hpp>
#include <com/sun/star/beans/UnknownPropertyException.hpp>
#include <com/sun/star/lang/WrappedTargetException.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/container/XEnumeration.hpp>
#include <com/sun/star/util/XURLTransformer.hpp>
#include <vcl/window.hxx>
#include <vcl/syswin.hxx>
#include <vcl/menu.hxx>
#include <vcl/svapp.hxx>
#include <tools/rcid.h>
#include <osl/mutex.hxx>
#include <toolkit/helper/vclunohelper.hxx>
#include <rtl/logfile.hxx>
#include <ucbhelper/content.hxx>
namespace framework{
using namespace ::com::sun::star ;
using namespace ::com::sun::star::awt ;
using namespace ::com::sun::star::beans ;
using namespace ::com::sun::star::container ;
using namespace ::com::sun::star::frame ;
using namespace ::com::sun::star::lang ;
using namespace ::com::sun::star::uno ;
using namespace ::com::sun::star::util ;
using namespace ::cppu ;
using ::rtl::OUString;
const sal_uInt16 SLOTID_MDIWINDOWLIST = 5610;
//*****************************************************************************************************************
// constructor
//*****************************************************************************************************************
MenuDispatcher::MenuDispatcher( const uno::Reference< XMultiServiceFactory >& xFactory ,
const uno::Reference< XFrame >& xOwner )
// Init baseclasses first
: ThreadHelpBase ( &Application::GetSolarMutex() )
, OWeakObject ( )
// Init member
, m_xOwnerWeak ( xOwner )
, m_xFactory ( xFactory )
, m_aListenerContainer ( m_aLock.getShareableOslMutex() )
, m_bAlreadyDisposed ( sal_False )
, m_bActivateListener ( sal_False )
, m_pMenuManager ( NULL )
{
// Safe impossible cases
// We need valid informations about ouer ownerfor work.
LOG_ASSERT( impldbg_checkParameter_MenuDispatcher( xFactory, xOwner ), "MenuDispatcher::MenuDispatcher()\nInvalid parameter detected!\n" )
m_bActivateListener = sal_True;
xOwner->addFrameActionListener( uno::Reference< XFrameActionListener >( (OWeakObject *)this, UNO_QUERY ));
}
//*****************************************************************************************************************
// destructor
//*****************************************************************************************************************
MenuDispatcher::~MenuDispatcher()
{
// Warn programmer if he forgot to dispose this instance.
// We must release all our references ...
// and a dtor isn't the best place to do that!
}
//*****************************************************************************************************************
// XInterface, XTypeProvider
//*****************************************************************************************************************
DEFINE_XINTERFACE_4 ( MenuDispatcher ,
OWeakObject ,
DIRECT_INTERFACE( XTypeProvider ),
DIRECT_INTERFACE( XDispatch ),
DIRECT_INTERFACE( XEventListener ),
DERIVED_INTERFACE( XFrameActionListener, XEventListener )
)
DEFINE_XTYPEPROVIDER_4 ( MenuDispatcher ,
XTypeProvider ,
XDispatch ,
XEventListener ,
XFrameActionListener
)
//*****************************************************************************************************************
// XDispatch
//*****************************************************************************************************************
void SAL_CALL MenuDispatcher::dispatch( const URL& /*aURL*/ ,
const Sequence< PropertyValue >& /*seqProperties*/ ) throw( RuntimeException )
{
}
//*****************************************************************************************************************
// XDispatch
//*****************************************************************************************************************
void SAL_CALL MenuDispatcher::addStatusListener( const uno::Reference< XStatusListener >& xControl,
const URL& aURL ) throw( RuntimeException )
{
// Ready for multithreading
ResetableGuard aGuard( m_aLock );
// Safe impossible cases
// Method not defined for all incoming parameter
LOG_ASSERT( impldbg_checkParameter_addStatusListener( xControl, aURL ), "MenuDispatcher::addStatusListener()\nInvalid parameter detected.\n" )
// Add listener to container.
m_aListenerContainer.addInterface( aURL.Complete, xControl );
}
//*****************************************************************************************************************
// XDispatch
//*****************************************************************************************************************
void SAL_CALL MenuDispatcher::removeStatusListener( const uno::Reference< XStatusListener >& xControl,
const URL& aURL ) throw( RuntimeException )
{
// Ready for multithreading
ResetableGuard aGuard( m_aLock );
// Safe impossible cases
// Method not defined for all incoming parameter
LOG_ASSERT( impldbg_checkParameter_removeStatusListener( xControl, aURL ), "MenuDispatcher::removeStatusListener()\nInvalid parameter detected.\n" )
// Add listener to container.
m_aListenerContainer.removeInterface( aURL.Complete, xControl );
}
//*****************************************************************************************************************
// XFrameActionListener
//*****************************************************************************************************************
void SAL_CALL MenuDispatcher::frameAction( const FrameActionEvent& aEvent ) throw ( RuntimeException )
{
ResetableGuard aGuard( m_aLock );
if ( m_pMenuManager && aEvent.Action == FrameAction_FRAME_UI_ACTIVATED )
{
MenuBar* pMenuBar = (MenuBar *)m_pMenuManager->GetMenu();
uno::Reference< XFrame > xFrame( m_xOwnerWeak.get(), UNO_QUERY );
aGuard.unlock();
if ( xFrame.is() && pMenuBar )
{
uno::Reference< ::com::sun::star::awt::XWindow >xContainerWindow = xFrame->getContainerWindow();
SolarMutexGuard aSolarGuard;
{
Window* pWindow = VCLUnoHelper::GetWindow( xContainerWindow );
while ( pWindow && !pWindow->IsSystemWindow() )
pWindow = pWindow->GetParent();
if ( pWindow )
{
SystemWindow* pSysWindow = (SystemWindow *)pWindow;
pSysWindow->SetMenuBar( pMenuBar );
}
}
}
}
else if ( m_pMenuManager && aEvent.Action == css::frame::FrameAction_COMPONENT_DETACHING )
{
if ( m_pMenuManager )
impl_setMenuBar( NULL );
}
}
//*****************************************************************************************************************
// XEventListener
//*****************************************************************************************************************
void SAL_CALL MenuDispatcher::disposing( const EventObject& ) throw( RuntimeException )
{
// Ready for multithreading
ResetableGuard aGuard( m_aLock );
// Safe impossible cases
LOG_ASSERT( !(m_bAlreadyDisposed==sal_True), "MenuDispatcher::disposing()\nObject already disposed .. don't call it again!\n" )
if( m_bAlreadyDisposed == sal_False )
{
m_bAlreadyDisposed = sal_True;
if ( m_bActivateListener )
{
uno::Reference< XFrame > xFrame( m_xOwnerWeak.get(), UNO_QUERY );
if ( xFrame.is() )
{
xFrame->removeFrameActionListener( uno::Reference< XFrameActionListener >( (OWeakObject *)this, UNO_QUERY ));
m_bActivateListener = sal_False;
if ( m_pMenuManager )
{
EventObject aEventObj;
aEventObj.Source = xFrame;
m_pMenuManager->disposing( aEventObj );
}
}
}
// Forget our factory.
m_xFactory = uno::Reference< XMultiServiceFactory >();
// Remove our menu from system window if it is still there!
if ( m_pMenuManager )
impl_setMenuBar( NULL );
}
}
//*****************************************************************************************************************
// private method
//*****************************************************************************************************************
void MenuDispatcher::impl_setAccelerators( Menu* pMenu, const Accelerator& aAccel )
{
for ( sal_uInt16 nPos = 0; nPos < pMenu->GetItemCount(); ++nPos )
{
sal_uInt16 nId = pMenu->GetItemId(nPos);
PopupMenu* pPopup = pMenu->GetPopupMenu(nId);
if ( pPopup )
impl_setAccelerators( (Menu *)pPopup, aAccel );
else if ( nId && !pMenu->GetPopupMenu(nId))
{
KeyCode aCode = aAccel.GetKeyCode( nId );
if ( aCode.GetCode() )
pMenu->SetAccelKey( nId, aCode );
}
}
}
//*****************************************************************************************************************
// private method
//*****************************************************************************************************************
sal_Bool MenuDispatcher::impl_setMenuBar( MenuBar* pMenuBar, sal_Bool bMenuFromResource )
{
uno::Reference< XFrame > xFrame( m_xOwnerWeak.get(), UNO_QUERY );
if ( xFrame.is() )
{
uno::Reference< ::com::sun::star::awt::XWindow >xContainerWindow = xFrame->getContainerWindow();
Window* pWindow = NULL;
// Use SolarMutex for threadsafe code too!
SolarMutexGuard aSolarGuard;
{
pWindow = VCLUnoHelper::GetWindow( xContainerWindow );
while ( pWindow && !pWindow->IsSystemWindow() )
pWindow = pWindow->GetParent();
}
if ( pWindow )
{
// Ready for multithreading
ResetableGuard aGuard( m_aLock );
SystemWindow* pSysWindow = (SystemWindow *)pWindow;
if ( m_pMenuManager )
{
// remove old menu from our system window if it was set before
if ( m_pMenuManager->GetMenu() == (Menu *)pSysWindow->GetMenuBar() )
pSysWindow->SetMenuBar( NULL );
// remove listener before we destruct ourself, so we cannot be called back afterwards
m_pMenuManager->RemoveListener();
(static_cast< ::com::sun::star::uno::XInterface* >((OWeakObject*)m_pMenuManager))->release();
m_pMenuManager = 0;
}
if ( pMenuBar != NULL )
{
sal_uInt16 nPos = pMenuBar->GetItemPos( SLOTID_MDIWINDOWLIST );
if ( nPos != MENU_ITEM_NOTFOUND )
{
uno::Reference< XModel > xModel;
uno::Reference< XController > xController( xFrame->getController(), UNO_QUERY );
if ( xController.is() )
xModel = uno::Reference< XModel >( xController->getModel(), UNO_QUERY );
// retrieve addon popup menus and add them to our menu bar
AddonMenuManager::MergeAddonPopupMenus( xFrame, xModel, nPos, pMenuBar );
// retrieve addon help menu items and add them to our help menu
AddonMenuManager::MergeAddonHelpMenu( xFrame, pMenuBar );
}
// set new menu on our system window and create new menu manager
if ( bMenuFromResource )
{
m_pMenuManager = new MenuManager( m_xFactory, xFrame, pMenuBar, sal_True, sal_False );
}
else
{
m_pMenuManager = new MenuManager( m_xFactory, xFrame, pMenuBar, sal_True, sal_True );
}
pSysWindow->SetMenuBar( pMenuBar );
}
return sal_True;
}
}
return sal_False;
}
//_________________________________________________________________________________________________________________
// debug methods
//_________________________________________________________________________________________________________________
/*-----------------------------------------------------------------------------------------------------------------
The follow methods checks the parameter for other functions. If a parameter or his value is non valid,
we return "sal_False". (else sal_True) This mechanism is used to throw an ASSERT!
ATTENTION
If you miss a test for one of this parameters, contact the autor or add it himself !(?)
But ... look for right testing! See using of this methods!
-----------------------------------------------------------------------------------------------------------------*/
#ifdef ENABLE_ASSERTIONS
//*****************************************************************************************************************
sal_Bool MenuDispatcher::impldbg_checkParameter_MenuDispatcher( const uno::Reference< XMultiServiceFactory >& xFactory ,
const uno::Reference< XFrame >& xOwner )
{
// Set default return value.
sal_Bool bOK = sal_True;
// Check parameter.
if (
( &xFactory == NULL ) ||
( &xOwner == NULL ) ||
( xFactory.is() == sal_False ) ||
( xOwner.is() == sal_False )
)
{
bOK = sal_False ;
}
// Return result of check.
return bOK ;
}
//*****************************************************************************************************************
// We need a valid URL. What is meaning with "register for nothing"?!
// xControl must correct to - nobody can advised otherwise!
sal_Bool MenuDispatcher::impldbg_checkParameter_addStatusListener( const uno::Reference< XStatusListener >& xControl,
const URL& aURL )
{
// Set default return value.
sal_Bool bOK = sal_True;
// Check parameter.
if (
( &xControl == NULL ) ||
( &aURL == NULL ) ||
( aURL.Complete.isEmpty() )
)
{
bOK = sal_False ;
}
// Return result of check.
return bOK ;
}
//*****************************************************************************************************************
// The same goes for these case! We have added valid listener for correct URL only.
// We can't remove invalid listener for nothing!
sal_Bool MenuDispatcher::impldbg_checkParameter_removeStatusListener( const uno::Reference< XStatusListener >& xControl,
const URL& aURL )
{
// Set default return value.
sal_Bool bOK = sal_True;
// Check parameter.
if (
( &xControl == NULL ) ||
( &aURL == NULL ) ||
( aURL.Complete.isEmpty() )
)
{
bOK = sal_False ;
}
// Return result of check.
return bOK ;
}
#endif // #ifdef ENABLE_ASSERTIONS
} // namespace framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
