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
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
|
/* -*- 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 <loadenv/loadenv.hxx>
#include <loadenv/targethelper.hxx>
#include <services/desktop.hxx>
#include <helper/ocomponentaccess.hxx>
#include <dispatch/dispatchprovider.hxx>
#include <dispatch/interceptionhelper.hxx>
#include <classes/taskcreator.hxx>
#include <threadhelp/transactionguard.hxx>
#include <threadhelp/writeguard.hxx>
#include <threadhelp/readguard.hxx>
#include <services.h>
#include <general.h>
#include <properties.h>
#include <classes/resource.hrc>
#include <classes/fwkresid.hxx>
#include <com/sun/star/beans/PropertyAttribute.hpp>
#include <com/sun/star/frame/FrameSearchFlag.hpp>
#include <com/sun/star/awt/XWindow.hpp>
#include <com/sun/star/awt/XWindowPeer.hpp>
#include <com/sun/star/awt/WindowDescriptor.hpp>
#include <com/sun/star/awt/WindowAttribute.hpp>
#include <com/sun/star/awt/PosSize.hpp>
#include <com/sun/star/util/XURLTransformer.hpp>
#include <com/sun/star/task/XInteractionAbort.hpp>
#include <com/sun/star/task/XInteractionApprove.hpp>
#include <com/sun/star/document/XInteractionFilterSelect.hpp>
#include <com/sun/star/document/AmbigousFilterRequest.hpp>
#include <com/sun/star/task/ErrorCodeRequest.hpp>
#include <com/sun/star/ucb/InteractiveIOException.hpp>
#include <com/sun/star/ucb/InteractiveAugmentedIOException.hpp>
#include <com/sun/star/frame/XNotifyingDispatch.hpp>
#include <com/sun/star/frame/DispatchResultState.hpp>
#include <com/sun/star/lang/IllegalArgumentException.hpp>
#include <com/sun/star/lang/DisposedException.hpp>
#include <com/sun/star/util/XCloseable.hpp>
#include <com/sun/star/document/MacroExecMode.hpp>
#include <com/sun/star/document/UpdateDocMode.hpp>
#include <com/sun/star/frame/XTerminateListener2.hpp>
#include <cppuhelper/queryinterface.hxx>
#include <cppuhelper/typeprovider.hxx>
#include <cppuhelper/factory.hxx>
#include <cppuhelper/proptypehlp.hxx>
#include <rtl/ustrbuf.hxx>
#include <vcl/svapp.hxx>
#include <tools/errinf.hxx>
#include <comphelper/extract.hxx>
#include <fwkdllapi.h>
namespace framework{
//*****************************************************************************************************************
// XInterface, XTypeProvider, XServiceInfo
//*****************************************************************************************************************
DEFINE_XSERVICEINFO_ONEINSTANCESERVICE_2( Desktop,
::cppu::OWeakObject,
"com.sun.star.frame.Desktop",
IMPLEMENTATIONNAME_DESKTOP
)
DEFINE_INIT_SERVICE ( Desktop,
{
/*Attention
I think we don't need any mutex or lock here ... because we are called by our own static method impl_createInstance()
to create a new instance of this class by our own supported service factory.
see macro DEFINE_XSERVICEINFO_MULTISERVICE and "impl_initService()" for further information!
*/
//-------------------------------------------------------------------------------------------------------------
// Initialize a new XFrames-helper-object to handle XIndexAccess and XElementAccess.
// We hold member as reference ... not as pointer too!
// Attention: We share our frame container with this helper. Container is threadsafe himself ... So I think we can do that.
// But look on dispose() for right order of deinitialization.
OFrames* pFramesHelper = new OFrames( this, &m_aChildTaskContainer );
m_xFramesHelper = css::uno::Reference< css::frame::XFrames >( static_cast< ::cppu::OWeakObject* >(pFramesHelper), css::uno::UNO_QUERY );
//-------------------------------------------------------------------------------------------------------------
// Initialize a new dispatchhelper-object to handle dispatches.
// We use these helper as slave for our interceptor helper ... not directly!
// But he is event listener on THIS instance!
DispatchProvider* pDispatchHelper = new DispatchProvider( m_xContext, this );
css::uno::Reference< css::frame::XDispatchProvider > xDispatchProvider( static_cast< ::cppu::OWeakObject* >(pDispatchHelper), css::uno::UNO_QUERY );
//-------------------------------------------------------------------------------------------------------------
// Initialize a new interception helper object to handle dispatches and implement an interceptor mechanism.
// Set created dispatch provider as slowest slave of it.
// Hold interception helper by reference only - not by pointer!
// So it's easiear to destroy it.
InterceptionHelper* pInterceptionHelper = new InterceptionHelper( this, xDispatchProvider );
m_xDispatchHelper = css::uno::Reference< css::frame::XDispatchProvider >( static_cast< ::cppu::OWeakObject* >(pInterceptionHelper), css::uno::UNO_QUERY );
OUStringBuffer sUntitledPrefix (256);
sUntitledPrefix.append (FWK_RESSTR(STR_UNTITLED_DOCUMENT));
sUntitledPrefix.appendAscii (" ");
::comphelper::NumberedCollection* pNumbers = new ::comphelper::NumberedCollection ();
m_xTitleNumberGenerator = css::uno::Reference< css::frame::XUntitledNumbers >(static_cast< ::cppu::OWeakObject* >(pNumbers), css::uno::UNO_QUERY_THROW);
pNumbers->setOwner ( static_cast< ::cppu::OWeakObject* >(this) );
pNumbers->setUntitledPrefix ( sUntitledPrefix.makeStringAndClear () );
// Safe impossible cases
// We can't work without this helper!
SAL_WARN_IF( !m_xFramesHelper.is(), "fwk", "Desktop::Desktop(): Frames helper is not valid. XFrames, XIndexAccess and XElementAcces are not supported!");
SAL_WARN_IF( !m_xDispatchHelper.is(), "fwk", "Desktop::Desktop(): Dispatch helper is not valid. XDispatch will not work correctly!" );
// Enable object for real working!
// Otherwise all calls will be rejected ...
m_aTransactionManager.setWorkingMode( E_WORK );
}
)
/*-************************************************************************************************************//**
@short standard constructor to create instance by factory
@descr This constructor initialize a new instance of this class by valid factory,
and will be set valid values on his member and baseclasses.
@attention a) Don't use your own reference during an UNO-Service-ctor! There is no guarantee, that you
will get over this. (e.g. using of your reference as parameter to initialize some member)
Do such things in DEFINE_INIT_SERVICE() method, which is called automaticly after your ctor!!!
b) Baseclass OBroadcastHelper is a typedef in namespace cppu!
The microsoft compiler has some problems to handle it right BY using namespace explicitly ::cppu::OBroadcastHelper.
If we write it without a namespace or expand the typedef to OBrodcastHelperVar<...> -> it will be OK!?
I don't know why! (other compiler not tested .. but it works!)
@seealso method DEFINE_INIT_SERVICE()
@param "xFactory" is the multi service manager, which create this instance.
The value must be different from NULL!
@return -
@onerror We throw an ASSERT in debug version or do nothing in relaese version.
*//*-*************************************************************************************************************/
Desktop::Desktop( const css::uno::Reference< css::uno::XComponentContext >& xContext )
// Init baseclasses first
// Attention: Don't change order of initialization!
// ThreadHelpBase is a struct with a lock as member. We can't use a lock as direct member!
// We must guarantee right initialization and a valid value of this to initialize other baseclasses!
: ThreadHelpBase ( &Application::GetSolarMutex() )
, TransactionBase ( )
, ::cppu::OBroadcastHelperVar< ::cppu::OMultiTypeInterfaceContainerHelper, ::cppu::OMultiTypeInterfaceContainerHelper::keyType > ( m_aLock.getShareableOslMutex() )
, ::cppu::OPropertySetHelper ( *(static_cast< ::cppu::OBroadcastHelper* >(this)) )
// Init member
, m_bIsTerminated ( sal_False ) // see dispose() for further information!
, m_xContext ( xContext )
, m_aChildTaskContainer ( )
, m_aListenerContainer ( m_aLock.getShareableOslMutex() )
, m_xFramesHelper ( )
, m_xDispatchHelper ( )
, m_eLoadState ( E_NOTSET )
, m_xLastFrame ( )
, m_aInteractionRequest ( )
, m_bSuspendQuickstartVeto( sal_False )
, m_aCommandOptions ( )
, m_sName ( )
, m_sTitle ( )
, m_xDispatchRecorderSupplier( )
, m_xPipeTerminator ( )
, m_xQuickLauncher ( )
, m_xSWThreadManager ( )
, m_xSfxTerminator ( )
, m_xTitleNumberGenerator ( )
{
// Safe impossible cases
// We don't accept all incoming parameter.
SAL_WARN_IF( implcp_ctor( xContext ), "fwk", "Desktop::Desktop(): Invalid parameter detected!" );
}
/*-************************************************************************************************************//**
@short standard destructor
@descr This one do NOTHING! Use dispose() instaed of this.
@seealso method dispose()
@param -
@return -
@onerror -
*//*-*************************************************************************************************************/
Desktop::~Desktop()
{
SAL_WARN_IF( !m_bIsTerminated, "fwk", "Desktop not terminated before being destructed" );
SAL_WARN_IF( m_aTransactionManager.getWorkingMode()!=E_CLOSE, "fwk", "Desktop::~Desktop(): Who forgot to dispose this service?" );
}
css::uno::Any SAL_CALL Desktop::queryInterface( const css::uno::Type& _rType ) throw(css::uno::RuntimeException)
{
css::uno::Any aRet = Desktop_BASE::queryInterface( _rType );
if ( !aRet.hasValue() )
aRet = OPropertySetHelper::queryInterface( _rType );
return aRet;
}
css::uno::Sequence< css::uno::Type > SAL_CALL Desktop::getTypes( ) throw(css::uno::RuntimeException)
{
return comphelper::concatSequences(
Desktop_BASE::getTypes(),
::cppu::OPropertySetHelper::getTypes()
);
}
//=============================================================================
sal_Bool SAL_CALL Desktop::terminate()
throw( css::uno::RuntimeException )
{
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
ReadGuard aReadLock( m_aLock ); // start synchronize
css::uno::Reference< css::frame::XTerminateListener > xPipeTerminator = m_xPipeTerminator;
css::uno::Reference< css::frame::XTerminateListener > xQuickLauncher = m_xQuickLauncher;
css::uno::Reference< css::frame::XTerminateListener > xSWThreadManager = m_xSWThreadManager;
css::uno::Reference< css::frame::XTerminateListener > xSfxTerminator = m_xSfxTerminator;
css::lang::EventObject aEvent ( static_cast< ::cppu::OWeakObject* >(this) );
::sal_Bool bAskQuickStart = !m_bSuspendQuickstartVeto ;
aReadLock.unlock(); // end synchronize
//-------------------------------------------------------------------------------------------------------------
// Ask normal terminate listener. They could stop terminate without closing any open document.
Desktop::TTerminateListenerList lCalledTerminationListener;
::sal_Bool bVeto = sal_False;
impl_sendQueryTerminationEvent(lCalledTerminationListener, bVeto);
if ( bVeto )
{
impl_sendCancelTerminationEvent(lCalledTerminationListener);
return sal_False;
}
//-------------------------------------------------------------------------------------------------------------
// try to close all open frames.
// Allow using of any UI ... because Desktop.terminate() was designed as UI functionality in the past.
::sal_Bool bAllowUI = sal_True;
::sal_Bool bFramesClosed = impl_closeFrames(bAllowUI);
if ( ! bFramesClosed )
{
impl_sendCancelTerminationEvent(lCalledTerminationListener);
return sal_False;
}
//-------------------------------------------------------------------------------------------------------------
// Normal listener had no problem ...
// all frames was closed ...
// now it's time to ask our specialized listener.
// They are handled these way because they wish to hinder the office on termination
// but they wish also closing of all frames.
// Note further:
// We shouldn't ask quicklauncher in case it was allowed from outside only.
// This is special trick to "ignore existing quick starter" for debug purposes.
// Attention:
// Order of alled listener is important !
// some of them are harmless .-)
// But some of them can be dangerous. E.g. it would be dangerous if we close our pipe
// and dont terminate in real because another listener throws a veto exception .-)
::sal_Bool bTerminate = sal_False;
try
{
if(
( bAskQuickStart ) &&
( xQuickLauncher.is() )
)
{
xQuickLauncher->queryTermination( aEvent );
lCalledTerminationListener.push_back( xQuickLauncher );
}
if ( xSWThreadManager.is() )
{
xSWThreadManager->queryTermination( aEvent );
lCalledTerminationListener.push_back( xSWThreadManager );
}
if ( xPipeTerminator.is() )
{
xPipeTerminator->queryTermination( aEvent );
lCalledTerminationListener.push_back( xPipeTerminator );
}
if ( xSfxTerminator.is() )
{
xSfxTerminator->queryTermination( aEvent );
lCalledTerminationListener.push_back( xSfxTerminator );
}
bTerminate = sal_True;
}
catch(const css::frame::TerminationVetoException&)
{
bTerminate = sal_False;
}
if ( ! bTerminate )
impl_sendCancelTerminationEvent(lCalledTerminationListener);
else
{
// "Protect" us against dispose before terminate calls!
// see dispose() for further information.
/* SAFE AREA --------------------------------------------------------------------------------------- */
WriteGuard aWriteLock( m_aLock );
m_bIsTerminated = sal_True;
aWriteLock.unlock();
/* UNSAFE AREA ------------------------------------------------------------------------------------- */
impl_sendNotifyTerminationEvent();
if(
( bAskQuickStart ) &&
( xQuickLauncher.is() )
)
{
xQuickLauncher->notifyTermination( aEvent );
}
if ( xSWThreadManager.is() )
xSWThreadManager->notifyTermination( aEvent );
if ( xPipeTerminator.is() )
xPipeTerminator->notifyTermination( aEvent );
// Must be realy the last listener to be called.
// Because it shutdown the whole process asynchronous !
if ( xSfxTerminator.is() )
xSfxTerminator->notifyTermination( aEvent );
}
return bTerminate;
}
namespace
{
class QuickstartSuppressor
{
Desktop* const m_pDesktop;
css::uno::Reference< css::frame::XTerminateListener > m_xQuickLauncher;
public:
QuickstartSuppressor(Desktop* const pDesktop, css::uno::Reference< css::frame::XTerminateListener > xQuickLauncher)
: m_pDesktop(pDesktop)
, m_xQuickLauncher(xQuickLauncher)
{
SAL_INFO("fwk.desktop", "temporary removing Quickstarter");
if(m_xQuickLauncher.is())
m_pDesktop->removeTerminateListener(m_xQuickLauncher);
}
~QuickstartSuppressor()
{
SAL_INFO("fwk.desktop", "readding Quickstarter");
if(m_xQuickLauncher.is())
m_pDesktop->addTerminateListener(m_xQuickLauncher);
}
};
}
bool SAL_CALL Desktop::terminateQuickstarterToo()
throw( css::uno::RuntimeException )
{
QuickstartSuppressor aQuickstartSuppressor(this, m_xQuickLauncher);
return terminate();
}
//=============================================================================
void SAL_CALL Desktop::addTerminateListener( const css::uno::Reference< css::frame::XTerminateListener >& xListener )
throw( css::uno::RuntimeException )
{
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
css::uno::Reference< css::lang::XServiceInfo > xInfo( xListener, css::uno::UNO_QUERY );
if ( xInfo.is() )
{
OUString sImplementationName = xInfo->getImplementationName();
// SYCNHRONIZED ->
WriteGuard aWriteLock( m_aLock );
if( sImplementationName.equals(IMPLEMENTATIONNAME_SFXTERMINATOR) )
{
m_xSfxTerminator = xListener;
return;
}
if( sImplementationName.equals(IMPLEMENTATIONNAME_PIPETERMINATOR) )
{
m_xPipeTerminator = xListener;
return;
}
if( sImplementationName.equals(IMPLEMENTATIONNAME_QUICKLAUNCHER) )
{
m_xQuickLauncher = xListener;
return;
}
if( sImplementationName.equals(IMPLEMENTATIONNAME_SWTHREADMANAGER) )
{
m_xSWThreadManager = xListener;
return;
}
aWriteLock.unlock();
// <- SYCNHRONIZED
}
// No lock required ... container is threadsafe by itself.
m_aListenerContainer.addInterface( ::getCppuType( ( const css::uno::Reference< css::frame::XTerminateListener >*) NULL ), xListener );
}
//=============================================================================
void SAL_CALL Desktop::removeTerminateListener( const css::uno::Reference< css::frame::XTerminateListener >& xListener )
throw( css::uno::RuntimeException )
{
TransactionGuard aTransaction( m_aTransactionManager, E_SOFTEXCEPTIONS );
css::uno::Reference< css::lang::XServiceInfo > xInfo( xListener, css::uno::UNO_QUERY );
if ( xInfo.is() )
{
OUString sImplementationName = xInfo->getImplementationName();
// SYCNHRONIZED ->
WriteGuard aWriteLock( m_aLock );
if( sImplementationName.equals(IMPLEMENTATIONNAME_SFXTERMINATOR) )
{
m_xSfxTerminator.clear();
return;
}
if( sImplementationName.equals(IMPLEMENTATIONNAME_PIPETERMINATOR) )
{
m_xPipeTerminator.clear();
return;
}
if( sImplementationName.equals(IMPLEMENTATIONNAME_QUICKLAUNCHER) )
{
m_xQuickLauncher.clear();
return;
}
if( sImplementationName.equals(IMPLEMENTATIONNAME_SWTHREADMANAGER) )
{
m_xSWThreadManager.clear();
return;
}
aWriteLock.unlock();
// <- SYCNHRONIZED
}
// No lock required ... container is threadsafe by itself.
m_aListenerContainer.removeInterface( ::getCppuType( ( const css::uno::Reference< css::frame::XTerminateListener >*) NULL ), xListener );
}
/*-************************************************************************************************************//**
@interface XDesktop
@short get access to create enumerations of all current components
@descr You will be the owner of the returned object and must delete it if you don't use it again.
@seealso class TasksAccess
@seealso class TasksEnumeration
@param -
@return A reference to an XEnumerationAccess-object.
@onerror We return a null-reference.
@threadsafe yes
*//*-*************************************************************************************************************/
css::uno::Reference< css::container::XEnumerationAccess > SAL_CALL Desktop::getComponents() throw( css::uno::RuntimeException )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
// We use a helper class OComponentAccess to have access on all child components.
// Create it on demand and return it as a reference.
OComponentAccess* pAccess = new OComponentAccess( this );
css::uno::Reference< css::container::XEnumerationAccess > xAccess( static_cast< ::cppu::OWeakObject* >(pAccess), css::uno::UNO_QUERY );
return xAccess;
}
/*-************************************************************************************************************//**
@interface XDesktop
@short return the current active component
@descr The most current component is the window, model or the controller of the current active frame.
@seealso method getCurrentFrame()
@seealso method impl_getFrameComponent()
@param -
@return A reference to the component.
@onerror We return a null-reference.
@threadsafe yes
*//*-*************************************************************************************************************/
css::uno::Reference< css::lang::XComponent > SAL_CALL Desktop::getCurrentComponent() throw( css::uno::RuntimeException )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
// Set return value if method failed.
css::uno::Reference< css::lang::XComponent > xComponent;
// Get reference to current frame ...
// ... get component of this frame ... (It can be the window, the model or the controller.)
// ... and return the result.
css::uno::Reference< css::frame::XFrame > xCurrentFrame = getCurrentFrame();
if( xCurrentFrame.is() == sal_True )
{
xComponent = impl_getFrameComponent( xCurrentFrame );
}
return xComponent;
}
/*-************************************************************************************************************//**
@interface XDesktop
@short return the current active frame in hierarchy
@descr There can be more then one different active paths in our frame hierarchy. But only one of them
could be the most active frame (normal he has the focus).
Don't mix it with getActiveFrame()! That will return our current active frame, which must be
a direct child of us and should be a part(!) of an active path.
@seealso method getActiveFrame()
@param -
@return A valid reference, if there is an active frame.
A null reference , otherwise.
@onerror We return a null reference.
@threadsafe yes
*//*-*************************************************************************************************************/
css::uno::Reference< css::frame::XFrame > SAL_CALL Desktop::getCurrentFrame() throw( css::uno::RuntimeException )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
// Start search with ouer direct active frame (if it exist!).
// Search on his children for other active frames too.
// Stop if no one could be found and return last of found ones.
css::uno::Reference< css::frame::XFramesSupplier > xLast = css::uno::Reference< css::frame::XFramesSupplier >( getActiveFrame(), css::uno::UNO_QUERY );
if( xLast.is() == sal_True )
{
css::uno::Reference< css::frame::XFramesSupplier > xNext = css::uno::Reference< css::frame::XFramesSupplier >( xLast->getActiveFrame(), css::uno::UNO_QUERY );
while( xNext.is() == sal_True )
{
xLast = xNext;
xNext = css::uno::Reference< css::frame::XFramesSupplier >( xNext->getActiveFrame(), css::uno::UNO_QUERY );
}
}
return css::uno::Reference< css::frame::XFrame >( xLast, css::uno::UNO_QUERY );
}
/*-************************************************************************************************************//**
@interface XComponentLoader
@short try to load given URL into a task
@descr You can give us some information about the content, which you will load into a frame.
We search or create this target for you, make a type detection of given URL and try to load it.
As result of this operation we return the new created component or nothing, if loading failed.
@seealso -
@param "sURL" , URL, which represant the content
@param "sTargetFrameName" , name of target frame or special value like "_self", "_blank" ...
@param "nSearchFlags" , optional arguments for frame search, if target isn't a special one
@param "lArguments" , optional arguments for loading
@return A valid component reference, if loading was successfully.
A null reference otherwise.
@onerror We return a null reference.
@threadsafe yes
*//*-*************************************************************************************************************/
css::uno::Reference< css::lang::XComponent > SAL_CALL Desktop::loadComponentFromURL( const OUString& sURL ,
const OUString& sTargetFrameName,
sal_Int32 nSearchFlags ,
const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) throw( css::io::IOException ,
css::lang::IllegalArgumentException ,
css::uno::RuntimeException )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
SAL_INFO( "fwk.desktop", "framework (as96863) ::Desktop::loadComponentFromURL" );
ReadGuard aReadLock(m_aLock);
css::uno::Reference< css::frame::XComponentLoader > xThis(static_cast< css::frame::XComponentLoader* >(this), css::uno::UNO_QUERY);
css::uno::Reference< css::uno::XComponentContext > xContext = m_xContext;
aReadLock.unlock();
SAL_INFO( "fwk.desktop", "PERFORMANCE - Desktop::loadComponentFromURL()" );
return LoadEnv::loadComponentFromURL(xThis, xContext, sURL, sTargetFrameName, nSearchFlags, lArguments);
}
/*-************************************************************************************************************//**
@interface XTasksSupplier
@short get access to create enumerations of ouer taskchildren
@descr Direct children of desktop are tasks everytime.
Call these method to could create enumerations of it.
But; Don't forget - you will be the owner of returned object and must release it!
We use a helper class to implement the access interface. They hold a weakreference to us.
It can be, that the desktop is dead - but not your tasksaccess-object! Then they will do nothing!
You can't create enumerations then.
@attention Normaly we don't need any lock here. We don't work on internal member!
@seealso class TasksAccess
@param -
@return A reference to an accessobject, which can create enumerations of ouer childtasks.
@onerror A null reference is returned.
@threadsafe yes
*//*-*************************************************************************************************************/
css::uno::Reference< css::container::XEnumerationAccess > SAL_CALL Desktop::getTasks() throw( css::uno::RuntimeException )
{
SAL_INFO("fwk", "Desktop::getTasks(): Use of obsolete interface XTaskSupplier");
return NULL;
}
/*-************************************************************************************************************//**
@interface XTasksSupplier
@short return current active task of ouer direct children
@descr Desktop children are tasks only ! If we have an active path from desktop
as top to any frame on bottom, we must have an active direct child. His reference is returned here.
@attention a) Do not confuse it with getCurrentFrame()! The current frame don't must one of ouer direct children.
It can be every frame in subtree and must have the focus (Is the last one of an active path!).
b) We don't need any lock here. Our container is threadsafe himself and live, if we live!
@seealso method getCurrentFrame()
@param -
@return A reference to ouer current active taskchild.
@onerror A null reference is returned.
@threadsafe yes
*//*-*************************************************************************************************************/
css::uno::Reference< css::frame::XTask > SAL_CALL Desktop::getActiveTask() throw( css::uno::RuntimeException )
{
SAL_INFO("fwk", "Desktop::getActiveTask(): Use of obsolete interface XTaskSupplier");
return NULL;
}
/*-************************************************************************************************************//**
@interface XDispatchProvider
@short search a dispatcher for given URL
@descr We use a helper implementation (class DispatchProvider) to do so.
So we don't must implement this algorithm twice!
@attention We don't need any lock here. Our helper is threadsafe himself and live, if we live!
@seealso class DispatchProvider
@param "aURL" , URL to dispatch
@param "sTargetFrameName" , name of target frame, who should dispatch these URL
@param "nSearchFlags" , flags to regulate the search
@param "lQueries" , list of queryDispatch() calls!
@return A reference or list of founded dispatch objects for these URL.
@onerror A null reference is returned.
@threadsafe yes
*//*-*************************************************************************************************************/
css::uno::Reference< css::frame::XDispatch > SAL_CALL Desktop::queryDispatch( const css::util::URL& aURL ,
const OUString& sTargetFrameName ,
sal_Int32 nSearchFlags ) throw( css::uno::RuntimeException )
{
const char UNO_PROTOCOL[] = ".uno:";
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
// Remove uno and cmd protocol part as we want to support both of them. We store only the command part
// in our hash map. All other protocols are stored with the protocol part.
String aCommand( aURL.Main );
if ( aURL.Protocol.equalsIgnoreAsciiCaseAsciiL( UNO_PROTOCOL, sizeof( UNO_PROTOCOL )-1 ))
aCommand = aURL.Path;
// Make boost::unordered_map lookup if the current URL is in the disabled list
if ( m_aCommandOptions.Lookup( SvtCommandOptions::CMDOPTION_DISABLED, aCommand ) )
return css::uno::Reference< css::frame::XDispatch >();
else
{
// We use a helper to support these interface and an interceptor mechanism.
// Our helper is threadsafe by himself!
return m_xDispatchHelper->queryDispatch( aURL, sTargetFrameName, nSearchFlags );
}
}
//*****************************************************************************************************************
css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL Desktop::queryDispatches( const css::uno::Sequence< css::frame::DispatchDescriptor >& lQueries ) throw( css::uno::RuntimeException )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
return m_xDispatchHelper->queryDispatches( lQueries );
}
/*-************************************************************************************************************//**
@interface XDipsatchProviderInterception
@short supports registration/deregistration of interception objects, which
are interested on special dispatches.
@descr Its realy provided by an internal helper, which is used inside the dispatch api too.
@param xInterceptor
the interceptor object, which wish to be (de)registered.
@threadsafe yes
*//*-*************************************************************************************************************/
void SAL_CALL Desktop::registerDispatchProviderInterceptor( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor)
throw( css::uno::RuntimeException)
{
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
css::uno::Reference< css::frame::XDispatchProviderInterception > xInterceptionHelper( m_xDispatchHelper, css::uno::UNO_QUERY );
xInterceptionHelper->registerDispatchProviderInterceptor( xInterceptor );
}
//*****************************************************************************************************************
void SAL_CALL Desktop::releaseDispatchProviderInterceptor ( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor)
throw( css::uno::RuntimeException)
{
TransactionGuard aTransaction( m_aTransactionManager, E_SOFTEXCEPTIONS );
css::uno::Reference< css::frame::XDispatchProviderInterception > xInterceptionHelper( m_xDispatchHelper, css::uno::UNO_QUERY );
xInterceptionHelper->releaseDispatchProviderInterceptor( xInterceptor );
}
/*-************************************************************************************************************//**
@interface XFramesSupplier
@short return access to append or remove children on desktop
@descr We don't implement these interface directly. We use a helper class to do this.
If you wish to add or delete children to/from the container, call these method to get
a reference to the helper.
@attention Helper is threadsafe himself. So we don't need any lock here.
@seealso class OFrames
@param -
@return A reference to the helper.
@onerror A null reference is returned.
@threadsafe yes
*//*-*************************************************************************************************************/
css::uno::Reference< css::frame::XFrames > SAL_CALL Desktop::getFrames() throw( css::uno::RuntimeException )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
return m_xFramesHelper;
}
/*-************************************************************************************************************//**
@interface XFramesSupplier
@short set/get the current active child frame
@descr It must be a task. Direct children of desktop are tasks only! No frames are accepted.
We don't save this information directly in this class. We use ouer container-helper
to do that.
@attention Helper is threadsafe himself. So we don't need any lock here.
@seealso class OFrameContainer
@param "xFrame", new active frame (must be valid!)
@return A reference to ouer current active childtask, if anyone exist.
@onerror A null reference is returned.
@threadsafe yes
*//*-*************************************************************************************************************/
void SAL_CALL Desktop::setActiveFrame( const css::uno::Reference< css::frame::XFrame >& xFrame ) throw( css::uno::RuntimeException )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
// Get old active frame first.
// If nothing will change - do nothing!
// Otherwise set new active frame ...
// and deactivate last frame.
// It's necessary for our FrameActionEvent listener on a frame!
css::uno::Reference< css::frame::XFrame > xLastActiveChild = m_aChildTaskContainer.getActive();
if( xLastActiveChild != xFrame )
{
m_aChildTaskContainer.setActive( xFrame );
if( xLastActiveChild.is() == sal_True )
{
xLastActiveChild->deactivate();
}
}
}
//*****************************************************************************************************************
css::uno::Reference< css::frame::XFrame > SAL_CALL Desktop::getActiveFrame() throw( css::uno::RuntimeException )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
return m_aChildTaskContainer.getActive();
}
/*-************************************************************************************************************//**
@interface XFrame
@short non implemented methods!
@descr Some method make no sense for our desktop! He has no window or parent or ...
So we should implement it empty and warn programmer, if he use it!
@seealso -
@param -
@return -
@onerror -
@threadsafe -
*//*-*************************************************************************************************************/
void SAL_CALL Desktop::initialize( const css::uno::Reference< css::awt::XWindow >& ) throw( css::uno::RuntimeException )
{
}
//*****************************************************************************************************************
css::uno::Reference< css::awt::XWindow > SAL_CALL Desktop::getContainerWindow() throw( css::uno::RuntimeException )
{
return css::uno::Reference< css::awt::XWindow >();
}
//*****************************************************************************************************************
void SAL_CALL Desktop::setCreator( const css::uno::Reference< css::frame::XFramesSupplier >& /*xCreator*/ ) throw( css::uno::RuntimeException )
{
}
//*****************************************************************************************************************
css::uno::Reference< css::frame::XFramesSupplier > SAL_CALL Desktop::getCreator() throw( css::uno::RuntimeException )
{
return css::uno::Reference< css::frame::XFramesSupplier >();
}
//*****************************************************************************************************************
OUString SAL_CALL Desktop::getName() throw( css::uno::RuntimeException )
{
/* SAFE { */
ReadGuard aReadLock( m_aLock );
return m_sName;
/* } SAFE */
}
//*****************************************************************************************************************
void SAL_CALL Desktop::setName( const OUString& sName ) throw( css::uno::RuntimeException )
{
/* SAFE { */
WriteGuard aWriteLock( m_aLock );
m_sName = sName;
aWriteLock.unlock();
/* } SAFE */
}
//*****************************************************************************************************************
sal_Bool SAL_CALL Desktop::isTop() throw( css::uno::RuntimeException )
{
return sal_True;
}
//*****************************************************************************************************************
void SAL_CALL Desktop::activate() throw( css::uno::RuntimeException )
{
// Desktop is activae always ... but sometimes our frames try to activate
// the complete path from bottom to top ... And our desktop is the topest frame :-(
// So - please don't show any assertions here. Do nothing!
}
//*****************************************************************************************************************
void SAL_CALL Desktop::deactivate() throw( css::uno::RuntimeException )
{
// Desktop is activae always ... but sometimes our frames try to deactivate
// the complete path from bottom to top ... And our desktop is the topest frame :-(
// So - please don't show any assertions here. Do nothing!
}
//*****************************************************************************************************************
sal_Bool SAL_CALL Desktop::isActive() throw( css::uno::RuntimeException )
{
return sal_True;
}
//*****************************************************************************************************************
sal_Bool SAL_CALL Desktop::setComponent( const css::uno::Reference< css::awt::XWindow >& /*xComponentWindow*/ ,
const css::uno::Reference< css::frame::XController >& /*xController*/ ) throw( css::uno::RuntimeException )
{
return sal_False;
}
//*****************************************************************************************************************
css::uno::Reference< css::awt::XWindow > SAL_CALL Desktop::getComponentWindow() throw( css::uno::RuntimeException )
{
return css::uno::Reference< css::awt::XWindow >();
}
//*****************************************************************************************************************
css::uno::Reference< css::frame::XController > SAL_CALL Desktop::getController() throw( css::uno::RuntimeException )
{
return css::uno::Reference< css::frame::XController >();
}
//*****************************************************************************************************************
void SAL_CALL Desktop::contextChanged() throw( css::uno::RuntimeException )
{
}
//*****************************************************************************************************************
void SAL_CALL Desktop::addFrameActionListener( const css::uno::Reference< css::frame::XFrameActionListener >& ) throw( css::uno::RuntimeException )
{
}
//*****************************************************************************************************************
// css::frame::XFrame
//*****************************************************************************************************************
void SAL_CALL Desktop::removeFrameActionListener( const css::uno::Reference< css::frame::XFrameActionListener >& ) throw( css::uno::RuntimeException )
{
}
/*-************************************************************************************************************//**
@interface XFrame
@short try to find a frame with special parameters
@descr This method searches for a frame with the specified name.
Frames may contain other frames (e.g. a frameset) and may
be contained in other frames. This hierarchie ist searched by
this method.
First some special names are taken into account, i.e. "",
"_self", "_top", "_parent" etc. The FrameSearchFlags are ignored
when comparing these names with aTargetFrameName, further steps are
controlled by the FrameSearchFlags. If allowed, the name of the frame
itself is compared with the desired one, then ( again if allowed )
the method findFrame is called for all children of the frame.
If no Frame with the given name is found until the top frames container,
a new top Frame is created, if this is allowed by a special
FrameSearchFlag. The new Frame also gets the desired name.
We use a helper to get right search direction and react in a right manner.
@seealso class TargetFinder
@param "sTargetFrameName" , name of searched frame
@param "nSearchFlags" , flags to regulate search
@return A reference to an existing frame in hierarchy, if it exist.
@onerror A null reference is returned.
@threadsafe yes
*//*-*************************************************************************************************************/
css::uno::Reference< css::frame::XFrame > SAL_CALL Desktop::findFrame( const OUString& sTargetFrameName ,
sal_Int32 nSearchFlags ) throw( css::uno::RuntimeException )
{
css::uno::Reference< css::frame::XFrame > xTarget;
//-----------------------------------------------------------------------------------------------------
// 0) Ignore wrong parameter!
// We doesn't support search for following special targets.
// If we reject this requests - we mustnt check for such names
// in following code again and again. If we do not so -wrong
// search results can occure!
//-----------------------------------------------------------------------------------------------------
if (
(sTargetFrameName==SPECIALTARGET_DEFAULT ) || // valid for dispatches - not for findFrame()!
(sTargetFrameName==SPECIALTARGET_MENUBAR ) || // valid for dispatches - not for findFrame()!
(sTargetFrameName==SPECIALTARGET_PARENT ) || // we have no parent by definition
(sTargetFrameName==SPECIALTARGET_BEAMER ) // beamer frames are allowed as child of tasks only -
// and they exist more then ones. We have no idea which our sub tasks is the right one
)
{
return NULL;
}
//-----------------------------------------------------------------------------------------------------
// I) check for special defined targets first which must be handled exclusive.
// force using of "if() else if() ..."
//-----------------------------------------------------------------------------------------------------
// get threadsafe some necessary member which are neccessary for following functionality
/* SAFE { */
ReadGuard aReadLock( m_aLock );
css::uno::Reference< css::uno::XComponentContext> xContext = m_xContext;
aReadLock.unlock();
/* } SAFE */
//-----------------------------------------------------------------------------------------------------
// I.I) "_blank"
// create a new task as child of this desktop instance
// Note: Used helper TaskCreator use us automaticly ...
//-----------------------------------------------------------------------------------------------------
if ( sTargetFrameName==SPECIALTARGET_BLANK )
{
TaskCreator aCreator( xContext );
xTarget = aCreator.createTask(sTargetFrameName,sal_False);
}
//-----------------------------------------------------------------------------------------------------
// I.II) "_top"
// We are top by definition
//-----------------------------------------------------------------------------------------------------
else if ( sTargetFrameName==SPECIALTARGET_TOP )
{
xTarget = this;
}
//-----------------------------------------------------------------------------------------------------
// I.III) "_self", ""
// This mean this "frame" in every case.
//-----------------------------------------------------------------------------------------------------
else if (
( sTargetFrameName==SPECIALTARGET_SELF ) ||
( sTargetFrameName.isEmpty() )
)
{
xTarget = this;
}
else
{
//-------------------------------------------------------------------------------------------------
// II) otherwise use optional given search flags
// force using of combinations of such flags. means no "else" part of use if() statements.
// But we ust break further searches if target was already found.
// Order of using flags is fix: SELF - CHILDREN - SIBLINGS - PARENT
// TASK and CREATE are handled special.
// But note: Such flags are not valid for the desktop - especialy SIBLINGS or PARENT.
//-------------------------------------------------------------------------------------------------
// get threadsafe some necessary member which are neccessary for following functionality
/* SAFE { */
aReadLock.lock();
OUString sOwnName = m_sName;
aReadLock.unlock();
/* } SAFE */
//-------------------------------------------------------------------------------------------------
// II.I) SELF
// Check for right name. If it's the searched one return ourself - otherwise
// ignore this flag.
//-------------------------------------------------------------------------------------------------
if (
(nSearchFlags & css::frame::FrameSearchFlag::SELF) &&
(sOwnName == sTargetFrameName )
)
{
xTarget = this;
}
//-------------------------------------------------------------------------------------------------
// II.II) TASKS
// This is a special flag. Normaly it regulate search inside tasks and forbid access to parent trees.
// But the desktop exists outside such task trees. They are our sub trees. So the desktop implement
// a special feature: We use it to start search on our direct children only. That means we supress
// search on ALL child frames. May that can be useful to get access on opened document tasks
// only without filter out all non realy required sub frames ...
// Used helper method on our container doesn't create any frame - its a search only.
//-------------------------------------------------------------------------------------------------
if (
( ! xTarget.is() ) &&
(nSearchFlags & css::frame::FrameSearchFlag::TASKS)
)
{
xTarget = m_aChildTaskContainer.searchOnDirectChildrens(sTargetFrameName);
}
//-------------------------------------------------------------------------------------------------
// II.III) CHILDREN
// Search on all children for the given target name.
// An empty name value can't occure here - because it must be already handled as "_self"
// before. Used helper function of container doesn't create any frame.
// It makes a deep search only.
//-------------------------------------------------------------------------------------------------
if (
( ! xTarget.is() ) &&
(nSearchFlags & css::frame::FrameSearchFlag::CHILDREN)
)
{
xTarget = m_aChildTaskContainer.searchOnAllChildrens(sTargetFrameName);
}
//-------------------------------------------------------------------------------------------------
// II.IV) CREATE
// If we haven't found any valid target frame by using normal flags - but user allowed us to create
// a new one ... we should do that. Used TaskCreator use us automaticly as parent!
//-------------------------------------------------------------------------------------------------
if (
( ! xTarget.is() ) &&
(nSearchFlags & css::frame::FrameSearchFlag::CREATE)
)
{
TaskCreator aCreator( xContext );
xTarget = aCreator.createTask(sTargetFrameName,sal_False);
}
}
return xTarget;
}
//=============================================================================
void SAL_CALL Desktop::dispose()
throw( css::uno::RuntimeException )
{
// Safe impossible cases
// It's an programming error if dispose is called before terminate!
// But if you just ignore the assertion (which happens in unit
// tests for instance in sc/qa/unit) nothing bad happens.
SAL_WARN_IF( !m_bIsTerminated, "fwk", "Desktop disposed before terminating it" );
WriteGuard aWriteLock( m_aLock ); // start synchronize
// Look for multiple calls of this method!
// If somewhere call dispose() twice - he will be stopped here realy!!!
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
// Now - we are alone and its the first call of this method ...
// otherwise call before had thrown a DisposedException / hopefully .-)
// But we dont use the transaction object created before ... we reset it immediately ...
// two lines of code ... for what ?
// The answer: We wished to synchronize concurrent dispose() calls -> OK
// But next line will wait for all currently running transaction (even if they
// are running within the same thread!) So we would block ourself there if aTransaction
// will stay registered .-)
aTransaction.stop();
// Disable this instance for further work.
// This will wait for all current running transactions ...
// and reject all new incoming requests!
m_aTransactionManager.setWorkingMode( E_BEFORECLOSE );
aWriteLock.unlock(); // end synchronize
// Following lines of code can be called outside a synchronized block ...
// Because our transaction manager will block all new requests to this object.
// So nobody can use us any longer.
// Exception: Only removing of listener will work ... and this code cant be dangerous.
// First we has to kill all listener connections.
// They might rely on our member and can hinder us on releasing them.
css::uno::Reference< css::uno::XInterface > xThis ( static_cast< ::cppu::OWeakObject* >(this), css::uno::UNO_QUERY );
css::lang::EventObject aEvent( xThis );
m_aListenerContainer.disposeAndClear( aEvent );
// Clear our child task container and forget all task references hardly.
// Normaly all open document was already closed by our terminate() function before ...
// New opened frames will have a problem now .-)
m_aChildTaskContainer.clear();
// Dispose our helper too.
css::uno::Reference< css::lang::XEventListener > xFramesHelper( m_xFramesHelper, css::uno::UNO_QUERY );
if( xFramesHelper.is() )
xFramesHelper->disposing( aEvent );
// At least clean up other member references.
m_xDispatchHelper.clear();
m_xFramesHelper.clear();
m_xLastFrame.clear();
m_xContext.clear();
m_xPipeTerminator.clear();
m_xQuickLauncher.clear();
m_xSWThreadManager.clear();
m_xSfxTerminator.clear();
// From this point nothing will work further on this object ...
// excepting our dtor() .-)
m_aTransactionManager.setWorkingMode( E_CLOSE );
}
/*-************************************************************************************************************//**
@interface XComponent
@short add/remove listener for dispose events
@descr Add an event listener to this object, if you whish to get information
about our dieing!
You must releas ethis listener reference during your own disposing() method.
@attention Our container is threadsafe himeslf. So we doesn't need any lock here.
@seealso -
@param "xListener", reference to valid listener. We don't accept invalid values!
@return -
@onerror -
@threadsafe yes
*//*-*************************************************************************************************************/
void SAL_CALL Desktop::addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) throw( css::uno::RuntimeException )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Safe impossible cases
// Method not defined for all incoming parameter.
SAL_WARN_IF( implcp_addEventListener( xListener ), "fwk", "Desktop::addEventListener(): Invalid parameter detected!" );
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
m_aListenerContainer.addInterface( ::getCppuType( ( const css::uno::Reference< css::lang::XEventListener >*) NULL ), xListener );
}
//*****************************************************************************************************************
void SAL_CALL Desktop::removeEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) throw( css::uno::RuntimeException )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Safe impossible cases
// Method not defined for all incoming parameter.
SAL_WARN_IF( implcp_removeEventListener( xListener ), "fwk", "Desktop::removeEventListener(): Invalid parameter detected!" );
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_SOFTEXCEPTIONS );
m_aListenerContainer.removeInterface( ::getCppuType( ( const css::uno::Reference< css::lang::XEventListener >*) NULL ), xListener );
}
/*-************************************************************************************************************//**
@interface XDispatchResultListener
@short callback for dispatches
@descr To support our method "loadComponentFromURL()" we are listener on temp. created dispatcher.
They call us back in this method "statusChanged()". As source of given state event, they give us a
reference to the target frame, in which dispatch was loaded! So we can use it to return his component
to caller! If no target exist ... ??!!
@seealso method loadComponentFromURL()
@param "aEvent", state event which (hopefully) valid information
@return -
@onerror -
@threadsafe yes
*//*-*************************************************************************************************************/
void SAL_CALL Desktop::dispatchFinished( const css::frame::DispatchResultEvent& aEvent ) throw( css::uno::RuntimeException )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
/* SAFE AREA ------------------------------------------------------------------------------------------- */
WriteGuard aWriteLock( m_aLock );
if( m_eLoadState != E_INTERACTION )
{
m_xLastFrame = css::uno::Reference< css::frame::XFrame >();
m_eLoadState = E_FAILED ;
if( aEvent.State == css::frame::DispatchResultState::SUCCESS )
{
css::uno::Reference < css::frame::XFrame > xFrame;
if ( aEvent.Result >>= m_xLastFrame )
m_eLoadState = E_SUCCESSFUL;
}
}
/* UNSAFE AREA ----------------------------------------------------------------------------------------- */
}
/*-************************************************************************************************************//**
@interface XEventListener
@short not implemented!
@descr We are a status listener ... and so we must be an event listener too ... But we doesn't need it realy!
We are a temp. listener only and our lifetime isn't smaller then of our temp. used dispatcher.
@seealso method loadComponentFromURL()
@param -
@return -
@onerror -
@threadsafe -
*//*-*************************************************************************************************************/
void SAL_CALL Desktop::disposing( const css::lang::EventObject& ) throw( css::uno::RuntimeException )
{
SAL_WARN( "fwk", "Desktop::disposing(): Algorithm error! Normaly desktop is temp. listener ... not all the time. So this method shouldn't be called." );
}
/*-************************************************************************************************************//**
@interface XInteractionHandler
@short callback for loadComponentFromURL for detected exceptions during load proccess
@descr In this case we must cancel loading and throw these detected exception again as result
of our own called method.
@attention a)
Normal loop in loadComponentFromURL() breaks on setted member m_eLoadState during callback statusChanged().
But these interaction feature implements second way to do so! So we must look on different callbacks
for same operation ... and live with it.
b)
Search for given continuations too. If any XInteractionAbort exist ... use it to abort further operations
for currently running operation!
@seealso method loadComponentFromURL()
@seealso member m_eLoadState
@param "xRequest", request for interaction - normal a wrapped target exception from bottom services
@return -
@onerror -
@threadsafe yes
*//*-*************************************************************************************************************/
void SAL_CALL Desktop::handle( const css::uno::Reference< css::task::XInteractionRequest >& xRequest ) throw( css::uno::RuntimeException )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
// Don't check incoming request!
// If somewhere starts interaction without right parameter - he maked something wrong.
// loadComponentFromURL() waits for thjese event - otherwise it yield for ever!
// get packed request and work on it first
// Attention: Don't set it on internal member BEFORE interaction is finished - because
// "loadComponentFromURL()" yield tills this member is changed. If we do it before
// interaction finish we can't guarantee right functionality. May be we cancel load process to erliear ...
css::uno::Any aRequest = xRequest->getRequest();
// extract continuations from request
css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > lContinuations = xRequest->getContinuations();
css::uno::Reference< css::task::XInteractionAbort > xAbort ;
css::uno::Reference< css::task::XInteractionApprove > xApprove ;
css::uno::Reference< css::document::XInteractionFilterSelect > xFilterSelect ;
sal_Bool bAbort = sal_False;
sal_Int32 nCount=lContinuations.getLength();
for( sal_Int32 nStep=0; nStep<nCount; ++nStep )
{
if( ! xAbort.is() )
xAbort = css::uno::Reference< css::task::XInteractionAbort >( lContinuations[nStep], css::uno::UNO_QUERY );
if( ! xApprove.is() )
xApprove = css::uno::Reference< css::task::XInteractionApprove >( lContinuations[nStep], css::uno::UNO_QUERY );
if( ! xFilterSelect.is() )
xFilterSelect = css::uno::Reference< css::document::XInteractionFilterSelect >( lContinuations[nStep], css::uno::UNO_QUERY );
}
// differ between abortable interactions (error, unknown filter ...)
// and other ones (ambigous but not unknown filter ...)
css::task::ErrorCodeRequest aErrorCodeRequest ;
css::document::AmbigousFilterRequest aAmbigousFilterRequest;
if( aRequest >>= aAmbigousFilterRequest )
{
if( xFilterSelect.is() )
{
xFilterSelect->setFilter( aAmbigousFilterRequest.SelectedFilter ); // user selected filter wins!
xFilterSelect->select();
}
}
else if( aRequest >>= aErrorCodeRequest )
{
sal_Bool bWarning = ((aErrorCodeRequest.ErrCode & ERRCODE_WARNING_MASK) == ERRCODE_WARNING_MASK);
if (xApprove.is() && bWarning)
xApprove->select();
else
if (xAbort.is())
{
xAbort->select();
bAbort = sal_True;
}
}
else if( xAbort.is() )
{
xAbort->select();
bAbort = sal_True;
}
/* SAFE AREA ------------------------------------------------------------------------------------------- */
// Ok now it's time to break yield loop of loadComponentFromURL().
// But only for realy aborted requests!
// For example warnings will be approved and we wait for any success story ...
if (bAbort)
{
WriteGuard aWriteLock( m_aLock );
m_eLoadState = E_INTERACTION;
m_aInteractionRequest = aRequest ;
aWriteLock.unlock();
}
/* UNSAFE AREA ----------------------------------------------------------------------------------------- */
}
//-----------------------------------------------------------------------------
::sal_Int32 SAL_CALL Desktop::leaseNumber( const css::uno::Reference< css::uno::XInterface >& xComponent )
throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException )
{
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
return m_xTitleNumberGenerator->leaseNumber (xComponent);
}
//-----------------------------------------------------------------------------
void SAL_CALL Desktop::releaseNumber( ::sal_Int32 nNumber )
throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException )
{
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
m_xTitleNumberGenerator->releaseNumber (nNumber);
}
//-----------------------------------------------------------------------------
void SAL_CALL Desktop::releaseNumberForComponent( const css::uno::Reference< css::uno::XInterface >& xComponent )
throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException )
{
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
m_xTitleNumberGenerator->releaseNumberForComponent (xComponent);
}
//-----------------------------------------------------------------------------
OUString SAL_CALL Desktop::getUntitledPrefix()
throw (css::uno::RuntimeException)
{
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
return m_xTitleNumberGenerator->getUntitledPrefix ();
}
/*-************************************************************************************************************//**
@short try to convert a property value
@descr This method is called from helperclass "OPropertySetHelper".
Don't use this directly!
You must try to convert the value of given DESKTOP_PROPHANDLE and
return results of this operation. This will be used to ask vetoable
listener. If no listener has a veto, we will change value realy!
( in method setFastPropertyValue_NoBroadcast(...) )
@attention Methods of OPropertySethelper are safed by using our shared osl mutex! (see ctor!)
So we must use different locks to make our implementation threadsafe.
@seealso class OPropertySetHelper
@seealso method setFastPropertyValue_NoBroadcast()
@param "aConvertedValue" new converted value of property
@param "aOldValue" old value of property
@param "nHandle" handle of property
@param "aValue" new value of property
@return sal_True if value will be changed, sal_FALSE otherway
@onerror IllegalArgumentException, if you call this with an invalid argument
@threadsafe yes
*//*-*************************************************************************************************************/
sal_Bool SAL_CALL Desktop::convertFastPropertyValue( css::uno::Any& aConvertedValue ,
css::uno::Any& aOldValue ,
sal_Int32 nHandle ,
const css::uno::Any& aValue ) throw( css::lang::IllegalArgumentException )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
// Initialize state with sal_False !!!
// (Handle can be invalid)
sal_Bool bReturn = sal_False;
switch( nHandle )
{
case DESKTOP_PROPHANDLE_SUSPENDQUICKSTARTVETO:
bReturn = PropHelper::willPropertyBeChanged(
css::uno::makeAny(m_bSuspendQuickstartVeto),
aValue,
aOldValue,
aConvertedValue);
break;
case DESKTOP_PROPHANDLE_DISPATCHRECORDERSUPPLIER :
bReturn = PropHelper::willPropertyBeChanged(
css::uno::makeAny(m_xDispatchRecorderSupplier),
aValue,
aOldValue,
aConvertedValue);
break;
case DESKTOP_PROPHANDLE_TITLE :
bReturn = PropHelper::willPropertyBeChanged(
css::uno::makeAny(m_sTitle),
aValue,
aOldValue,
aConvertedValue);
break;
}
// Return state of operation.
return bReturn ;
}
/*-************************************************************************************************************//**
@short set value of a transient property
@descr This method is calling from helperclass "OPropertySetHelper".
Don't use this directly!
Handle and value are valid everyway! You must set the new value only.
After this, baseclass send messages to all listener automaticly.
@seealso class OPropertySetHelper
@param "nHandle" handle of property to change
@param "aValue" new value of property
@return -
@onerror An exception is thrown.
@threadsafe yes
*//*-*************************************************************************************************************/
void SAL_CALL Desktop::setFastPropertyValue_NoBroadcast( sal_Int32 nHandle ,
const css::uno::Any& aValue ) throw( css::uno::Exception )
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
switch( nHandle )
{
case DESKTOP_PROPHANDLE_SUSPENDQUICKSTARTVETO: aValue >>= m_bSuspendQuickstartVeto;
break;
case DESKTOP_PROPHANDLE_DISPATCHRECORDERSUPPLIER: aValue >>= m_xDispatchRecorderSupplier;
break;
case DESKTOP_PROPHANDLE_TITLE: aValue >>= m_sTitle;
break;
}
}
/*-************************************************************************************************************//**
@short get value of a transient property
@descr This method is calling from helperclass "OPropertySetHelper".
Don't use this directly!
@attention We don't need any mutex or lock here ... We use threadsafe container or methods here only!
@seealso class OPropertySetHelper
@param "nHandle" handle of property to change
@param "aValue" current value of property
@return -
@onerror -
@threadsafe yes
*//*-*************************************************************************************************************/
void SAL_CALL Desktop::getFastPropertyValue( css::uno::Any& aValue ,
sal_Int32 nHandle ) const
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
switch( nHandle )
{
case DESKTOP_PROPHANDLE_ACTIVEFRAME : aValue <<= m_aChildTaskContainer.getActive();
break;
case DESKTOP_PROPHANDLE_ISPLUGGED : aValue <<= sal_False;
break;
case DESKTOP_PROPHANDLE_SUSPENDQUICKSTARTVETO: aValue <<= m_bSuspendQuickstartVeto;
break;
case DESKTOP_PROPHANDLE_DISPATCHRECORDERSUPPLIER: aValue <<= m_xDispatchRecorderSupplier;
break;
case DESKTOP_PROPHANDLE_TITLE: aValue <<= m_sTitle;
break;
}
}
/*-************************************************************************************************************//**
@short return structure and information about transient properties
@descr This method is calling from helperclass "OPropertySetHelper".
Don't use this directly!
@attention You must use global lock (method use static variable) ... and it must be the shareable osl mutex of it.
Because; our baseclass use this mutex to make his code threadsafe. We use our lock!
So we could have two different mutex/lock mechanism at the same object.
@seealso class OPropertySetHelper
@param -
@return structure with property-information
@onerror -
@threadsafe yes
*//*-*************************************************************************************************************/
::cppu::IPropertyArrayHelper& SAL_CALL Desktop::getInfoHelper()
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
// 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; pInfoHelper is NULL - for the second call pInfoHelper is different from NULL!
static ::cppu::OPropertyArrayHelper* pInfoHelper = NULL;
if( pInfoHelper == NULL )
{
// Ready for multithreading
::osl::MutexGuard aGuard( LockHelper::getGlobalLock().getShareableOslMutex() );
// Control this pointer again, another instance can be faster then these!
if( pInfoHelper == NULL )
{
// Define static member to give structure of properties to baseclass "OPropertySetHelper".
// "impl_getStaticPropertyDescriptor" is a non exported and static funtion, who will define a static propertytable.
// "sal_True" say: Table is sorted by name.
static ::cppu::OPropertyArrayHelper aInfoHelper( impl_getStaticPropertyDescriptor(), sal_True );
pInfoHelper = &aInfoHelper;
}
}
return(*pInfoHelper);
}
/*-************************************************************************************************************//**
@short return propertysetinfo
@descr You can call this method to get information about transient properties
of this object.
@attention You must use global lock (method use static variable) ... and it must be the shareable osl mutex of it.
Because; our baseclass use this mutex to make his code threadsafe. We use our lock!
So we could have two different mutex/lock mechanism at the same object.
@seealso class OPropertySetHelper
@seealso interface XPropertySet
@seealso interface XMultiPropertySet
@param -
@return reference to object with information [XPropertySetInfo]
@onerror -
@threadsafe yes
*//*-*************************************************************************************************************/
css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL Desktop::getPropertySetInfo() throw (::com::sun::star::uno::RuntimeException)
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
// 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 css::uno::Reference< css::beans::XPropertySetInfo >* pInfo = NULL;
if( pInfo == NULL )
{
// Ready for multithreading
::osl::MutexGuard aGuard( LockHelper::getGlobalLock().getShareableOslMutex() );
// Control this pointer again, another instance can be faster then these!
if( pInfo == NULL )
{
// Create structure of propertysetinfo for baseclass "OPropertySetHelper".
// (Use method "getInfoHelper()".)
static css::uno::Reference< css::beans::XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
pInfo = &xInfo;
}
}
return (*pInfo);
}
/*-************************************************************************************************************//**
@short return current component of current frame
@descr The desktop himself has no component. But every frame in subtree.
If somewhere call getCurrentComponent() at this class, we try to find the right frame and
then we try to become his component. It can be a VCL-component, the model or the controller
of founded frame.
@attention We don't work on internal member ... so we doesn't need any lock here.
@seealso method getCurrentComponent();
@param "xFrame", reference to valid frame in hierarchy. Method is not defined for invalid values.
But we don't check these. Its an IMPL-method and caller must use it right!
@return A reference to found component.
@onerror A null reference is returned.
@threadsafe yes
*//*-*************************************************************************************************************/
css::uno::Reference< css::lang::XComponent > Desktop::impl_getFrameComponent( const css::uno::Reference< css::frame::XFrame >& xFrame ) const
{
/* UNSAFE AREA --------------------------------------------------------------------------------------------- */
// Register transaction and reject wrong calls.
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
// Set default return value, if method failed.
css::uno::Reference< css::lang::XComponent > xComponent;
// Does no controller exists?
css::uno::Reference< css::frame::XController > xController = xFrame->getController();
if( xController.is() == sal_False )
{
// Controller not exist - use the VCL-component.
xComponent = css::uno::Reference< css::lang::XComponent >( xFrame->getComponentWindow(), css::uno::UNO_QUERY );
}
else
{
// Does no model exists?
css::uno::Reference< css::frame::XModel > xModel( xController->getModel(), css::uno::UNO_QUERY );
if( xModel.is() == sal_True )
{
// Model exist - use the model as component.
xComponent = css::uno::Reference< css::lang::XComponent >( xModel, css::uno::UNO_QUERY );
}
else
{
// Model not exist - use the controller as component.
xComponent = css::uno::Reference< css::lang::XComponent >( xController, css::uno::UNO_QUERY );
}
}
return xComponent;
}
/*-************************************************************************************************************//**
@short create table with information about properties
@descr We use a helper class to support properties. These class need some information about this.
These method create a new static description table with name, type, r/w-flags and so on ...
@seealso class OPropertySetHelper
@seealso method getInfoHelper()
@param -
@return Static table with information about properties.
@onerror -
@threadsafe yes
*//*-*************************************************************************************************************/
const css::uno::Sequence< css::beans::Property > Desktop::impl_getStaticPropertyDescriptor()
{
// Create a property array to initialize sequence!
// Table of all predefined properties of this class. Its used from OPropertySetHelper-class!
// Don't forget to change the defines (see begin of this file), if you add, change or delete a property in this list!!!
// It's necessary for methods of OPropertySetHelper.
// ATTENTION:
// YOU MUST SORT FOLLOW TABLE BY NAME ALPHABETICAL !!!
const css::beans::Property pProperties[] =
{
css::beans::Property( DESKTOP_PROPNAME_ACTIVEFRAME , DESKTOP_PROPHANDLE_ACTIVEFRAME , ::getCppuType((const css::uno::Reference< css::lang::XComponent >*)NULL) , css::beans::PropertyAttribute::TRANSIENT | css::beans::PropertyAttribute::READONLY ),
css::beans::Property( DESKTOP_PROPNAME_DISPATCHRECORDERSUPPLIER , DESKTOP_PROPHANDLE_DISPATCHRECORDERSUPPLIER, ::getCppuType((const css::uno::Reference< css::frame::XDispatchRecorderSupplier >*)NULL), css::beans::PropertyAttribute::TRANSIENT ),
css::beans::Property( DESKTOP_PROPNAME_ISPLUGGED , DESKTOP_PROPHANDLE_ISPLUGGED , ::getBooleanCppuType() , css::beans::PropertyAttribute::TRANSIENT | css::beans::PropertyAttribute::READONLY ),
css::beans::Property( DESKTOP_PROPNAME_SUSPENDQUICKSTARTVETO , DESKTOP_PROPHANDLE_SUSPENDQUICKSTARTVETO , ::getBooleanCppuType() , css::beans::PropertyAttribute::TRANSIENT ),
css::beans::Property( DESKTOP_PROPNAME_TITLE , DESKTOP_PROPHANDLE_TITLE , ::getCppuType((const OUString*)NULL) , css::beans::PropertyAttribute::TRANSIENT ),
};
// Use it to initialize sequence!
const css::uno::Sequence< css::beans::Property > lPropertyDescriptor( pProperties, DESKTOP_PROPCOUNT );
// Return "PropertyDescriptor"
return lPropertyDescriptor;
}
//=============================================================================
void Desktop::impl_sendQueryTerminationEvent(Desktop::TTerminateListenerList& lCalledListener,
::sal_Bool& bVeto )
{
bVeto = sal_False;
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
::cppu::OInterfaceContainerHelper* pContainer = m_aListenerContainer.getContainer( ::getCppuType( ( const css::uno::Reference< css::frame::XTerminateListener >*) NULL ) );
if ( ! pContainer )
return;
css::lang::EventObject aEvent( static_cast< ::cppu::OWeakObject* >(this) );
::cppu::OInterfaceIteratorHelper aIterator( *pContainer );
while ( aIterator.hasMoreElements() )
{
try
{
css::uno::Reference< css::frame::XTerminateListener > xListener(aIterator.next(), css::uno::UNO_QUERY);
if ( ! xListener.is() )
continue;
xListener->queryTermination( aEvent );
lCalledListener.push_back(xListener);
}
catch( const css::frame::TerminationVetoException& )
{
// first veto will stop notification loop.
bVeto = sal_True;
return;
}
catch( const css::uno::Exception& )
{
// clean up container.
// E.g. dead remote listener objects can make trouble otherwise.
// Iterator implementation allows removing objects during it's used !
aIterator.remove();
}
}
}
//=============================================================================
void Desktop::impl_sendCancelTerminationEvent(const Desktop::TTerminateListenerList& lCalledListener)
{
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
css::lang::EventObject aEvent( static_cast< ::cppu::OWeakObject* >(this) );
Desktop::TTerminateListenerList::const_iterator pIt;
for ( pIt = lCalledListener.begin();
pIt != lCalledListener.end ();
++pIt )
{
try
{
// Note: cancelTermination() is a new and optional interface method !
css::uno::Reference< css::frame::XTerminateListener > xListener = *pIt;
css::uno::Reference< css::frame::XTerminateListener2 > xListenerGeneration2(xListener, css::uno::UNO_QUERY);
if ( ! xListenerGeneration2.is() )
continue;
xListenerGeneration2->cancelTermination( aEvent );
}
catch( const css::uno::Exception& )
{}
}
}
//=============================================================================
void Desktop::impl_sendNotifyTerminationEvent()
{
TransactionGuard aTransaction( m_aTransactionManager, E_HARDEXCEPTIONS );
::cppu::OInterfaceContainerHelper* pContainer = m_aListenerContainer.getContainer( ::getCppuType( ( const css::uno::Reference< css::frame::XTerminateListener >*) NULL ) );
if ( ! pContainer )
return;
css::lang::EventObject aEvent( static_cast< ::cppu::OWeakObject* >(this) );
::cppu::OInterfaceIteratorHelper aIterator( *pContainer );
while ( aIterator.hasMoreElements() )
{
try
{
css::uno::Reference< css::frame::XTerminateListener > xListener(aIterator.next(), css::uno::UNO_QUERY);
if ( ! xListener.is() )
continue;
xListener->notifyTermination( aEvent );
}
catch( const css::uno::Exception& )
{
// clean up container.
// E.g. dead remote listener objects can make trouble otherwise.
// Iterator implementation allows removing objects during it's used !
aIterator.remove();
}
}
}
//=============================================================================
::sal_Bool Desktop::impl_closeFrames(::sal_Bool bAllowUI)
{
ReadGuard aReadLock( m_aLock ); // start synchronize
css::uno::Sequence< css::uno::Reference< css::frame::XFrame > > lFrames = m_aChildTaskContainer.getAllElements();
aReadLock.unlock(); // end synchronize
::sal_Int32 c = lFrames.getLength();
::sal_Int32 i = 0;
::sal_Int32 nNonClosedFrames = 0;
for( i=0; i<c; ++i )
{
try
{
css::uno::Reference< css::frame::XFrame > xFrame = lFrames[i];
// XController.suspend() will show an UI ...
// Use it in case it was allowed from outside only.
sal_Bool bSuspended = sal_False;
css::uno::Reference< css::frame::XController > xController( xFrame->getController(), css::uno::UNO_QUERY );
if (
( bAllowUI ) &&
( xController.is() )
)
{
bSuspended = xController->suspend( sal_True );
if ( ! bSuspended )
{
++nNonClosedFrames;
continue;
}
}
// Try to close frame (in case no UI was allowed without calling XController->suspend() before!)
// But don't deliver ownership to any other one!
// This method can be called again.
css::uno::Reference< css::util::XCloseable > xClose( xFrame, css::uno::UNO_QUERY );
if ( xClose.is() )
{
try
{
xClose->close(sal_False);
}
catch(const css::util::CloseVetoException&)
{
// Any internal process of this frame disagree with our request.
// Safe this state but dont break these loop. Other frames has to be closed!
++nNonClosedFrames;
// Reactivate controller.
// It can happen that XController.suspend() returned true ... but a registered close listener
// throwed these veto exception. Then the controller has to be reactivated. Otherwise
// these document doesnt work any more.
if (
(bSuspended ) &&
(xController.is())
)
xController->suspend(sal_False);
}
// If interface XClosable interface exists and was used ...
// it's not allowed to use XComponent->dispose() also !
continue;
}
// XClosable not supported ?
// Then we have to dispose these frame hardly.
css::uno::Reference< css::lang::XComponent > xDispose( xFrame, css::uno::UNO_QUERY );
if ( xDispose.is() )
xDispose->dispose();
// Don't remove these frame from our child container!
// A frame do it by itself inside close()/dispose() method.
}
catch(const css::lang::DisposedException&)
{
// Dispose frames are closed frames.
// So we can count it here .-)
}
}
return (nNonClosedFrames < 1);
}
//*****************************************************************************************************************
// We work with valid servicemanager only.
sal_Bool Desktop::implcp_ctor( const css::uno::Reference< css::uno::XComponentContext >& xContext )
{
return(
( &xContext == NULL ) ||
( xContext.is() == sal_False )
);
}
//*****************************************************************************************************************
// We work with valid listener only.
sal_Bool Desktop::implcp_addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener )
{
return(
( &xListener == NULL ) ||
( xListener.is() == sal_False )
);
}
//*****************************************************************************************************************
// We work with valid listener only.
sal_Bool Desktop::implcp_removeEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener )
{
return(
( &xListener == NULL ) ||
( xListener.is() == sal_False )
);
}
} // namespace framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|