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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
|
/* -*- 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 "framecontrol.hxx"
#include <com/sun/star/beans/PropertyAttribute.hpp>
#include <com/sun/star/frame/Frame.hpp>
#include <com/sun/star/frame/FrameSearchFlag.hpp>
#include <com/sun/star/frame/XDispatchProvider.hpp>
#include <com/sun/star/frame/XDispatch.hpp>
#include <com/sun/star/util/URLTransformer.hpp>
#include <com/sun/star/util/XURLTransformer.hpp>
#include <comphelper/processfactory.hxx>
#include <cppuhelper/queryinterface.hxx>
#include <cppuhelper/typeprovider.hxx>
#include <osl/diagnose.h>
// namespaces
using namespace ::osl;
using namespace ::cppu;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::awt;
using namespace ::com::sun::star::frame;
using namespace ::com::sun::star::util;
namespace unocontrols{
// construct/destruct
FrameControl::FrameControl( const Reference< XComponentContext >& rxContext)
: BaseControl ( rxContext )
, OBroadcastHelper ( m_aMutex )
, OPropertySetHelper ( *(static_cast< OBroadcastHelper * >(this)) )
, m_aInterfaceContainer ( m_aMutex )
, m_aConnectionPointContainer ( m_aMutex )
{
}
FrameControl::~FrameControl()
{
}
// XInterface
Any SAL_CALL FrameControl::queryInterface( const Type& rType ) throw( RuntimeException, std::exception )
{
// Attention:
// Don't use mutex or guard in this method!!! Is a method of XInterface.
Any aReturn;
Reference< XInterface > xDel = BaseControl::impl_getDelegator();
if ( xDel.is() )
{
// If an delegator exist, forward question to his queryInterface.
// Delegator will ask his own queryAggregation!
aReturn = xDel->queryInterface( rType );
}
else
{
// If an delegator unknown, forward question to own queryAggregation.
aReturn = queryAggregation( rType );
}
return aReturn;
}
// XInterface
void SAL_CALL FrameControl::acquire() throw()
{
// Attention:
// Don't use mutex or guard in this method!!! Is a method of XInterface.
// Forward to baseclass
BaseControl::acquire();
}
// XInterface
void SAL_CALL FrameControl::release() throw()
{
// Attention:
// Don't use mutex or guard in this method!!! Is a method of XInterface.
// Forward to baseclass
BaseControl::release();
}
// XTypeProvider
Sequence< Type > SAL_CALL FrameControl::getTypes() throw( RuntimeException, std::exception )
{
// Optimize this method !
// We initialize a static variable only one time. And we don't must use a mutex at every call!
// For the first call; pTypeCollection is NULL - for the second call pTypeCollection is different from NULL!
static OTypeCollection* pTypeCollection = NULL;
if ( pTypeCollection == NULL )
{
// Ready for multithreading; get global mutex for first call of this method only! see before
MutexGuard aGuard( Mutex::getGlobalMutex() );
// Control these pointer again ... it can be, that another instance will be faster then these!
if ( pTypeCollection == NULL )
{
// Create a static typecollection ...
static OTypeCollection aTypeCollection ( cppu::UnoType<XControlModel>::get(),
cppu::UnoType<XControlContainer>::get(),
cppu::UnoType<XConnectionPointContainer>::get(),
BaseControl::getTypes()
);
// ... and set his address to static pointer!
pTypeCollection = &aTypeCollection;
}
}
return pTypeCollection->getTypes();
}
// XAggregation
Any SAL_CALL FrameControl::queryAggregation( const Type& aType ) throw( RuntimeException, std::exception )
{
// Ask for my own supported interfaces ...
// Attention: XTypeProvider and XInterface are supported by OComponentHelper!
Any aReturn ( ::cppu::queryInterface( aType ,
static_cast< XControlModel* > ( this ) ,
static_cast< XConnectionPointContainer* > ( this )
)
);
// If searched interface not supported by this class ...
if ( !aReturn.hasValue() )
{
// ... ask baseclasses.
aReturn = OPropertySetHelper::queryInterface( aType );
if ( !aReturn.hasValue() )
{
aReturn = BaseControl::queryAggregation( aType );
}
}
return aReturn;
}
OUString FrameControl::getImplementationName()
throw (css::uno::RuntimeException, std::exception)
{
return impl_getStaticImplementationName();
}
css::uno::Sequence<OUString> FrameControl::getSupportedServiceNames()
throw (css::uno::RuntimeException, std::exception)
{
return impl_getStaticSupportedServiceNames();
}
// XControl
void SAL_CALL FrameControl::createPeer( const Reference< XToolkit >& xToolkit ,
const Reference< XWindowPeer >& xParentPeer ) throw( RuntimeException, std::exception )
{
BaseControl::createPeer( xToolkit, xParentPeer );
if ( impl_getPeerWindow().is() )
{
if( !m_sComponentURL.isEmpty() )
{
impl_createFrame( getPeer(), m_sComponentURL, m_seqLoaderArguments );
}
}
}
// XControl
sal_Bool SAL_CALL FrameControl::setModel( const Reference< XControlModel >& /*xModel*/ ) throw( RuntimeException, std::exception )
{
// We have no model.
return false;
}
// XControl
Reference< XControlModel > SAL_CALL FrameControl::getModel() throw( RuntimeException, std::exception )
{
// We have no model.
return Reference< XControlModel >();
}
// XControl
void SAL_CALL FrameControl::dispose() throw( RuntimeException, std::exception )
{
impl_deleteFrame();
BaseControl::dispose();
}
// XView
sal_Bool SAL_CALL FrameControl::setGraphics( const Reference< XGraphics >& /*xDevice*/ ) throw( RuntimeException, std::exception )
{
// it is not possible to print this control
return false;
}
// XView
Reference< XGraphics > SAL_CALL FrameControl::getGraphics() throw( RuntimeException, std::exception )
{
// when it's not possible to set graphics ! then it's possible to return null
return Reference< XGraphics >();
}
// XConnectionPointContainer
Sequence< Type > SAL_CALL FrameControl::getConnectionPointTypes() throw( RuntimeException, std::exception )
{
// Forwarded to helper class
return m_aConnectionPointContainer.getConnectionPointTypes();
}
// XConnectionPointContainer
Reference< XConnectionPoint > SAL_CALL FrameControl::queryConnectionPoint( const Type& aType ) throw( RuntimeException, std::exception )
{
// Forwarded to helper class
return m_aConnectionPointContainer.queryConnectionPoint( aType );
}
// XConnectionPointContainer
void SAL_CALL FrameControl::advise( const Type& aType ,
const Reference< XInterface >& xListener ) throw( RuntimeException, std::exception )
{
// Forwarded to helper class
m_aConnectionPointContainer.advise( aType, xListener );
}
// XConnectionPointContainer
void SAL_CALL FrameControl::unadvise( const Type& aType ,
const Reference< XInterface >& xListener ) throw( RuntimeException, std::exception )
{
// Forwarded to helper class
m_aConnectionPointContainer.unadvise( aType, xListener );
}
// impl but public method to register service
const Sequence< OUString > FrameControl::impl_getStaticSupportedServiceNames()
{
MutexGuard aGuard( Mutex::getGlobalMutex() );
Sequence< OUString > seqServiceNames( 1 );
seqServiceNames.getArray() [0] = SERVICENAME_FRAMECONTROL;
return seqServiceNames;
}
// impl but public method to register service
const OUString FrameControl::impl_getStaticImplementationName()
{
return OUString(IMPLEMENTATIONNAME_FRAMECONTROL);
}
// OPropertySetHelper
sal_Bool FrameControl::convertFastPropertyValue( Any& rConvertedValue ,
Any& rOldValue ,
sal_Int32 nHandle ,
const Any& rValue ) throw( IllegalArgumentException )
{
bool bReturn = false;
switch (nHandle)
{
case PROPERTYHANDLE_COMPONENTURL : rConvertedValue = rValue;
rOldValue <<= m_sComponentURL;
bReturn = true;
break;
case PROPERTYHANDLE_LOADERARGUMENTS : rConvertedValue = rValue;
rOldValue <<= m_seqLoaderArguments;
bReturn = true;
break;
}
if ( !bReturn )
{
throw IllegalArgumentException();
}
return bReturn;
}
// OPropertySetHelper
void FrameControl::setFastPropertyValue_NoBroadcast( sal_Int32 nHandle ,
const Any& rValue )
throw ( ::com::sun::star::uno::Exception, std::exception )
{
// this method only set the value
MutexGuard aGuard (m_aMutex);
switch (nHandle)
{
case PROPERTYHANDLE_COMPONENTURL : rValue >>= m_sComponentURL;
if (getPeer().is())
{
impl_createFrame ( getPeer(), m_sComponentURL, m_seqLoaderArguments );
}
break;
case PROPERTYHANDLE_LOADERARGUMENTS : rValue >>= m_seqLoaderArguments;
break;
default : OSL_ENSURE ( nHandle == -1, "This is an invalid property handle." );
}
}
// OPropertySetHelper
void FrameControl::getFastPropertyValue( Any& rRet ,
sal_Int32 nHandle ) const
{
MutexGuard aGuard ( Mutex::getGlobalMutex() );
switch (nHandle)
{
case PROPERTYHANDLE_COMPONENTURL : rRet <<= m_sComponentURL;
break;
case PROPERTYHANDLE_LOADERARGUMENTS : rRet <<= m_seqLoaderArguments;
break;
case PROPERTYHANDLE_FRAME : rRet <<= m_xFrame;
break;
default : OSL_ENSURE ( nHandle == -1, "This is an invalid property handle." );
}
}
// OPropertySetHelper
IPropertyArrayHelper& FrameControl::getInfoHelper()
{
// Create a table that map names to index values.
static OPropertyArrayHelper* pInfo;
if (!pInfo)
{
// global method must be guarded
MutexGuard aGuard ( Mutex::getGlobalMutex() );
if (!pInfo)
{
pInfo = new OPropertyArrayHelper( impl_getStaticPropertyDescriptor(), true );
}
}
return *pInfo;
}
// OPropertySetHelper
Reference< XPropertySetInfo > SAL_CALL FrameControl::getPropertySetInfo() throw( RuntimeException, std::exception )
{
// Optimize this method !
// We initialize a static variable only one time. And we don't must use a mutex at every call!
// For the first call; pInfo is NULL - for the second call pInfo is different from NULL!
static Reference< XPropertySetInfo >* pInfo = (Reference< XPropertySetInfo >*)0;
if ( pInfo == (Reference< XPropertySetInfo >*)0 )
{
// Ready for multithreading
MutexGuard aGuard ( Mutex::getGlobalMutex () );
// Control this pointer again, another instance can be faster then these!
if ( pInfo == (Reference< XPropertySetInfo >*)0 )
{
// Create structure of propertysetinfo for baseclass "OPropertySetHelper".
// (Use method "getInfoHelper()".)
static Reference< XPropertySetInfo > xInfo ( createPropertySetInfo ( getInfoHelper () ) );
pInfo = &xInfo;
}
}
return ( *pInfo );
}
// BaseControl
WindowDescriptor* FrameControl::impl_getWindowDescriptor( const Reference< XWindowPeer >& xParentPeer )
{
WindowDescriptor* pDescriptor = new WindowDescriptor;
pDescriptor->Type = WindowClass_CONTAINER;
pDescriptor->ParentIndex = -1;
pDescriptor->Parent = xParentPeer;
pDescriptor->Bounds = getPosSize ();
pDescriptor->WindowAttributes = 0;
return pDescriptor;
}
// private method
void FrameControl::impl_createFrame( const Reference< XWindowPeer >& xPeer ,
const OUString& rURL ,
const Sequence< PropertyValue >& rArguments )
{
Reference< XFrame2 > xOldFrame;
Reference< XFrame2 > xNewFrame;
{
MutexGuard aGuard ( m_aMutex );
xOldFrame = m_xFrame;
}
xNewFrame = Frame::create( impl_getComponentContext() );
Reference< XWindow > xWP ( xPeer, UNO_QUERY );
xNewFrame->initialize ( xWP );
// option
//xFrame->setName( "WhatYouWant" );
Reference< XURLTransformer > xTrans = URLTransformer::create( impl_getComponentContext() );
// load file
URL aURL;
aURL.Complete = rURL;
xTrans->parseStrict( aURL );
Reference< XDispatch > xDisp = xNewFrame->queryDispatch ( aURL, OUString (), FrameSearchFlag::SELF );
if (xDisp.is())
{
xDisp->dispatch ( aURL, rArguments );
}
// set the frame
{
MutexGuard aGuard ( m_aMutex );
m_xFrame = xNewFrame;
}
// notify the listeners
sal_Int32 nFrameId = PROPERTYHANDLE_FRAME;
Any aNewFrame ( &xNewFrame, cppu::UnoType<XFrame>::get());
Any aOldFrame ( &xOldFrame, cppu::UnoType<XFrame>::get());
fire ( &nFrameId, &aNewFrame, &aOldFrame, 1, false );
if (xOldFrame.is())
{
xOldFrame->dispose ();
}
}
// private method
void FrameControl::impl_deleteFrame()
{
Reference< XFrame2 > xOldFrame;
Reference< XFrame2 > xNullFrame;
{
// do not dispose the frame in this guarded section (deadlock?)
MutexGuard aGuard( m_aMutex );
xOldFrame = m_xFrame;
m_xFrame = Reference< XFrame2 > ();
}
// notify the listeners
sal_Int32 nFrameId = PROPERTYHANDLE_FRAME;
Any aNewFrame( &xNullFrame, cppu::UnoType<XFrame2>::get());
Any aOldFrame( &xOldFrame, cppu::UnoType<XFrame2>::get());
fire( &nFrameId, &aNewFrame, &aOldFrame, 1, false );
// dispose the frame
if( xOldFrame.is() )
xOldFrame->dispose();
}
// private method
const Sequence< Property > FrameControl::impl_getStaticPropertyDescriptor()
{
// All Properties of this implementation. The array must be sorted!
static const Property pPropertys[PROPERTY_COUNT] =
{
Property( PROPERTYNAME_COMPONENTURL, PROPERTYHANDLE_COMPONENTURL, cppu::UnoType<OUString>::get(), PropertyAttribute::BOUND | PropertyAttribute::CONSTRAINED ),
Property( PROPERTYNAME_FRAME, PROPERTYHANDLE_FRAME, cppu::UnoType<XFrame>::get(), PropertyAttribute::BOUND | PropertyAttribute::TRANSIENT ),
Property( PROPERTYNAME_LOADERARGUMENTS, PROPERTYHANDLE_LOADERARGUMENTS, cppu::UnoType<Sequence<PropertyValue>>::get(), PropertyAttribute::BOUND | PropertyAttribute::CONSTRAINED )
};
static const Sequence< Property > seqPropertys( pPropertys, PROPERTY_COUNT );
return seqPropertys;
}
} // namespace unocontrols
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|