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
|
/* -*- 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 "eventhandler.hxx"
#include <helpids.h>
#include <propctrlr.h>
#include "formbrowsertools.hxx"
#include <strings.hrc>
#include "formstrings.hxx"
#include "handlerhelper.hxx"
#include "modulepcr.hxx"
#include "pcrcommon.hxx"
#include "propertycontrolextender.hxx"
#include <com/sun/star/awt/XTabControllerModel.hpp>
#include <com/sun/star/beans/PropertyAttribute.hpp>
#include <com/sun/star/beans/UnknownPropertyException.hpp>
#include <com/sun/star/beans/theIntrospection.hpp>
#include <com/sun/star/beans/XIntrospectionAccess.hpp>
#include <com/sun/star/container/NoSuchElementException.hpp>
#include <com/sun/star/container/XChild.hpp>
#include <com/sun/star/container/XIndexAccess.hpp>
#include <com/sun/star/container/XNameContainer.hpp>
#include <com/sun/star/container/XNameReplace.hpp>
#include <com/sun/star/form/FormComponentType.hpp>
#include <com/sun/star/form/XForm.hpp>
#include <com/sun/star/form/runtime/FormController.hpp>
#include <com/sun/star/inspection/PropertyControlType.hpp>
#include <com/sun/star/lang/NullPointerException.hpp>
#include <com/sun/star/script/XEventAttacherManager.hpp>
#include <com/sun/star/script/XScriptEventsSupplier.hpp>
#include <com/sun/star/uri/UriReferenceFactory.hpp>
#include <com/sun/star/uri/XVndSunStarScriptUrlReference.hpp>
#include <comphelper/namedvaluecollection.hxx>
#include <comphelper/evtmethodhelper.hxx>
#include <comphelper/propertyvalue.hxx>
#include <comphelper/sequence.hxx>
#include <comphelper/types.hxx>
#include <cppuhelper/implbase.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <rtl/ref.hxx>
#include <rtl/ustrbuf.hxx>
#include <svx/svxdlg.hxx>
#include <comphelper/diagnose_ex.hxx>
#include <map>
#include <algorithm>
#include <iterator>
#include <string_view>
#include <utility>
namespace pcr
{
using ::com::sun::star::uno::Reference;
using ::com::sun::star::uno::XComponentContext;
using ::com::sun::star::uno::Any;
using ::com::sun::star::uno::TypeClass_STRING;
using ::com::sun::star::uno::Type;
using ::com::sun::star::beans::theIntrospection;
using ::com::sun::star::beans::XPropertyChangeListener;
using ::com::sun::star::beans::Property;
using ::com::sun::star::beans::PropertyState;
using ::com::sun::star::beans::PropertyState_DIRECT_VALUE;
using ::com::sun::star::uno::Sequence;
using ::com::sun::star::script::ScriptEventDescriptor;
using ::com::sun::star::script::XScriptEventsSupplier;
using ::com::sun::star::lang::NullPointerException;
using ::com::sun::star::uno::Exception;
using ::com::sun::star::container::XChild;
using ::com::sun::star::container::XIndexAccess;
using ::com::sun::star::script::XEventAttacherManager;
using ::com::sun::star::uno::UNO_QUERY;
using ::com::sun::star::uno::UNO_QUERY_THROW;
using ::com::sun::star::uno::XInterface;
using ::com::sun::star::beans::XIntrospection;
using ::com::sun::star::beans::XIntrospectionAccess;
using ::com::sun::star::container::XNameContainer;
using ::com::sun::star::awt::XTabControllerModel;
using ::com::sun::star::form::XForm;
using ::com::sun::star::form::runtime::FormController;
using ::com::sun::star::form::runtime::XFormController;
using ::com::sun::star::beans::UnknownPropertyException;
using ::com::sun::star::container::NoSuchElementException;
using ::com::sun::star::beans::XPropertySetInfo;
using ::com::sun::star::container::XNameReplace;
using ::com::sun::star::beans::PropertyValue;
using ::com::sun::star::inspection::LineDescriptor;
using ::com::sun::star::inspection::XPropertyControlFactory;
using ::com::sun::star::inspection::InteractiveSelectionResult;
using ::com::sun::star::inspection::InteractiveSelectionResult_Cancelled;
using ::com::sun::star::inspection::InteractiveSelectionResult_Success;
using ::com::sun::star::inspection::XObjectInspectorUI;
using ::com::sun::star::beans::PropertyChangeEvent;
using ::com::sun::star::frame::XFrame;
using ::com::sun::star::frame::XModel;
using ::com::sun::star::frame::XController;
using ::com::sun::star::uno::UNO_SET_THROW;
using com::sun::star::uri::UriReferenceFactory;
using com::sun::star::uri::XUriReferenceFactory;
using com::sun::star::uri::XVndSunStarScriptUrlReference;
namespace PropertyControlType = css::inspection::PropertyControlType;
namespace PropertyAttribute = css::beans::PropertyAttribute;
namespace FormComponentType = css::form::FormComponentType;
EventDescription::EventDescription( EventId _nId, std::u16string_view listenerClassName,
std::u16string_view listenerMethodName, TranslateId pDisplayNameResId, OUString _sHelpId, OString _sUniqueBrowseId )
:sDisplayName(PcrRes( pDisplayNameResId ))
,sListenerClassName( listenerClassName )
,sListenerMethodName( listenerMethodName )
,sHelpId(std::move( _sHelpId ))
,sUniqueBrowseId(std::move( _sUniqueBrowseId ))
,nId( _nId )
{
}
namespace
{
#define DESCRIBE_EVENT( map, listener, method, id_postfix ) \
map.emplace( \
u"" method##_ustr, \
EventDescription( ++nEventId, u"com.sun.star." listener, u"" method, RID_STR_EVT_##id_postfix, HID_EVT_##id_postfix, UID_BRWEVT_##id_postfix ) )
bool lcl_getEventDescriptionForMethod( const OUString& _rMethodName, EventDescription& _out_rDescription )
{
static EventMap s_aKnownEvents = []() {
EventMap aMap;
sal_Int32 nEventId = 0;
DESCRIBE_EVENT(aMap, "form.XApproveActionListener", "approveAction", APPROVEACTIONPERFORMED);
DESCRIBE_EVENT(aMap, "awt.XActionListener", "actionPerformed", ACTIONPERFORMED);
DESCRIBE_EVENT(aMap, "form.XChangeListener", "changed", CHANGED);
DESCRIBE_EVENT(aMap, "awt.XTextListener", "textChanged", TEXTCHANGED);
DESCRIBE_EVENT(aMap, "awt.XItemListener", "itemStateChanged", ITEMSTATECHANGED);
DESCRIBE_EVENT(aMap, "awt.XFocusListener", "focusGained", FOCUSGAINED);
DESCRIBE_EVENT(aMap, "awt.XFocusListener", "focusLost", FOCUSLOST);
DESCRIBE_EVENT(aMap, "awt.XKeyListener", "keyPressed", KEYTYPED);
DESCRIBE_EVENT(aMap, "awt.XKeyListener", "keyReleased", KEYUP);
DESCRIBE_EVENT(aMap, "awt.XMouseListener", "mouseEntered", MOUSEENTERED);
DESCRIBE_EVENT(aMap, "awt.XMouseMotionListener", "mouseDragged", MOUSEDRAGGED);
DESCRIBE_EVENT(aMap, "awt.XMouseMotionListener", "mouseMoved", MOUSEMOVED);
DESCRIBE_EVENT(aMap, "awt.XMouseListener", "mousePressed", MOUSEPRESSED);
DESCRIBE_EVENT(aMap, "awt.XMouseListener", "mouseReleased", MOUSERELEASED);
DESCRIBE_EVENT(aMap, "awt.XMouseListener", "mouseExited", MOUSEEXITED);
DESCRIBE_EVENT(aMap, "form.XResetListener", "approveReset", APPROVERESETTED);
DESCRIBE_EVENT(aMap, "form.XResetListener", "resetted", RESETTED);
DESCRIBE_EVENT(aMap, "form.XSubmitListener", "approveSubmit", SUBMITTED);
DESCRIBE_EVENT(aMap, "form.XUpdateListener", "approveUpdate", BEFOREUPDATE);
DESCRIBE_EVENT(aMap, "form.XUpdateListener", "updated", AFTERUPDATE);
DESCRIBE_EVENT(aMap, "form.XLoadListener", "loaded", LOADED);
DESCRIBE_EVENT(aMap, "form.XLoadListener", "reloading", RELOADING);
DESCRIBE_EVENT(aMap, "form.XLoadListener", "reloaded", RELOADED);
DESCRIBE_EVENT(aMap, "form.XLoadListener", "unloading", UNLOADING);
DESCRIBE_EVENT(aMap, "form.XLoadListener", "unloaded", UNLOADED);
DESCRIBE_EVENT(aMap, "form.XConfirmDeleteListener", "confirmDelete", CONFIRMDELETE);
DESCRIBE_EVENT(aMap, "sdb.XRowSetApproveListener", "approveRowChange", APPROVEROWCHANGE);
DESCRIBE_EVENT(aMap, "sdbc.XRowSetListener", "rowChanged", ROWCHANGE);
DESCRIBE_EVENT(aMap, "sdb.XRowSetApproveListener", "approveCursorMove", POSITIONING);
DESCRIBE_EVENT(aMap, "sdbc.XRowSetListener", "cursorMoved", POSITIONED);
DESCRIBE_EVENT(aMap, "form.XDatabaseParameterListener", "approveParameter", APPROVEPARAMETER);
DESCRIBE_EVENT(aMap, "sdb.XSQLErrorListener", "errorOccured", ERROROCCURRED);
DESCRIBE_EVENT(aMap, "awt.XAdjustmentListener", "adjustmentValueChanged", ADJUSTMENTVALUECHANGED);
return aMap;
}();
EventMap::const_iterator pos = s_aKnownEvents.find( _rMethodName );
if ( pos == s_aKnownEvents.end() )
return false;
_out_rDescription = pos->second;
return true;
}
OUString lcl_getEventPropertyName( std::u16string_view _rListenerClassName, std::u16string_view _rMethodName )
{
return _rListenerClassName + OUStringChar(';') + _rMethodName;
}
ScriptEventDescriptor lcl_getAssignedScriptEvent( const EventDescription& _rEvent, const std::vector< ScriptEventDescriptor >& _rAllAssignedMacros )
{
ScriptEventDescriptor aScriptEvent;
// for the case there is actually no event assigned, initialize at least ListenerType and MethodName,
// so this ScriptEventDescriptor properly describes the given event
aScriptEvent.ListenerType = _rEvent.sListenerClassName;
aScriptEvent.EventMethod = _rEvent.sListenerMethodName;
for ( const ScriptEventDescriptor& rSED : _rAllAssignedMacros )
{
if ( rSED.ListenerType != _rEvent.sListenerClassName
|| rSED.EventMethod != _rEvent.sListenerMethodName
)
continue;
if ( rSED.ScriptCode.isEmpty()
|| rSED.ScriptType.isEmpty()
)
{
OSL_FAIL( "lcl_getAssignedScriptEvent: me thinks this should not happen!" );
continue;
}
aScriptEvent = rSED;
if ( aScriptEvent.ScriptType != "StarBasic" )
continue;
// this is an old-style macro specification:
// [document|application]:Library.Module.Function
// we need to translate this to the new-style macro specification
// vnd.sun.star.script:Library.Module.Function?language=Basic&location=[document|application]
sal_Int32 nPrefixLen = aScriptEvent.ScriptCode.indexOf( ':' );
OSL_ENSURE( nPrefixLen > 0, "lcl_getAssignedScriptEvent: illegal location!" );
std::u16string_view sLocation = aScriptEvent.ScriptCode.subView( 0, nPrefixLen );
std::u16string_view sMacroPath = aScriptEvent.ScriptCode.subView( nPrefixLen + 1 );
aScriptEvent.ScriptCode =
OUString::Concat("vnd.sun.star.script:") +
sMacroPath +
"?language=Basic&location=" +
sLocation;
// also, this new-style spec requires the script code to be "Script" instead of "StarBasic"
aScriptEvent.ScriptType = "Script";
}
return aScriptEvent;
}
OUString lcl_getQualifiedKnownListenerName( const ScriptEventDescriptor& _rFormComponentEventDescriptor )
{
EventDescription aKnownEvent;
if ( lcl_getEventDescriptionForMethod( _rFormComponentEventDescriptor.EventMethod, aKnownEvent ) )
return aKnownEvent.sListenerClassName;
OSL_FAIL( "lcl_getQualifiedKnownListenerName: unknown method name!" );
// somebody assigned an script to a form component event which we don't know
// Speaking strictly, this is not really an error - it is possible to do
// this programmatically -, but it should rarely happen, since it's not possible
// via UI
return _rFormComponentEventDescriptor.ListenerType;
}
typedef std::set< Type, TypeLessByName > TypeBag;
void lcl_addListenerTypesFor_throw( const Reference< XInterface >& _rxComponent,
const Reference< XIntrospection >& _rxIntrospection, TypeBag& _out_rTypes )
{
if ( !_rxComponent.is() )
return;
OSL_PRECOND( _rxIntrospection.is(), "lcl_addListenerTypesFor_throw: this will crash!" );
Reference< XIntrospectionAccess > xIntrospectionAccess(
_rxIntrospection->inspect( Any( _rxComponent ) ), UNO_SET_THROW );
const Sequence< Type > aListeners( xIntrospectionAccess->getSupportedListeners() );
std::copy( aListeners.begin(), aListeners.end(),
std::insert_iterator< TypeBag >( _out_rTypes, _out_rTypes.begin() ) );
}
}
typedef ::cppu::WeakImplHelper < css::container::XNameReplace
> EventHolder_Base;
namespace {
/* A UNO component holding assigned event descriptions, for use with a SvxMacroAssignDlg */
class EventHolder : public EventHolder_Base
{
private:
typedef std::unordered_map< OUString, ScriptEventDescriptor > EventMap;
typedef std::map< EventId, OUString > EventMapIndexAccess;
EventMap m_aEventNameAccess;
EventMapIndexAccess m_aEventIndexAccess;
public:
EventHolder( );
void addEvent( EventId _nId, const OUString& _rEventName, const ScriptEventDescriptor& _rScriptEvent );
/** effectively the same as getByName, but instead of converting the ScriptEventDescriptor to the weird
format used by the macro assignment dialog, it is returned directly
*/
ScriptEventDescriptor getNormalizedDescriptorByName( const OUString& _rEventName ) const;
// XNameReplace
virtual void SAL_CALL replaceByName( const OUString& _rName, const Any& aElement ) override;
virtual Any SAL_CALL getByName( const OUString& _rName ) override;
virtual Sequence< OUString > SAL_CALL getElementNames( ) override;
virtual sal_Bool SAL_CALL hasByName( const OUString& _rName ) override;
virtual Type SAL_CALL getElementType( ) override;
virtual sal_Bool SAL_CALL hasElements( ) override;
protected:
virtual ~EventHolder( ) override;
private:
ScriptEventDescriptor const & impl_getDescriptor_throw( const OUString& _rEventName ) const;
};
}
EventHolder::EventHolder()
{
}
EventHolder::~EventHolder()
{
m_aEventNameAccess.clear();
m_aEventIndexAccess.clear();
}
void EventHolder::addEvent( EventId _nId, const OUString& _rEventName, const ScriptEventDescriptor& _rScriptEvent )
{
std::pair< EventMap::iterator, bool > insertionResult =
m_aEventNameAccess.emplace( _rEventName, _rScriptEvent );
OSL_ENSURE( insertionResult.second, "EventHolder::addEvent: there already was a MacroURL for this event!" );
m_aEventIndexAccess[ _nId ] = _rEventName;
}
ScriptEventDescriptor EventHolder::getNormalizedDescriptorByName( const OUString& _rEventName ) const
{
return impl_getDescriptor_throw( _rEventName );
}
ScriptEventDescriptor const & EventHolder::impl_getDescriptor_throw( const OUString& _rEventName ) const
{
EventMap::const_iterator pos = m_aEventNameAccess.find( _rEventName );
if ( pos == m_aEventNameAccess.end() )
throw NoSuchElementException( OUString(), *const_cast< EventHolder* >( this ) );
return pos->second;
}
void SAL_CALL EventHolder::replaceByName( const OUString& _rName, const Any& _rElement )
{
EventMap::iterator pos = m_aEventNameAccess.find( _rName );
if ( pos == m_aEventNameAccess.end() )
throw NoSuchElementException( OUString(), *this );
Sequence< PropertyValue > aScriptDescriptor;
OSL_VERIFY( _rElement >>= aScriptDescriptor );
::comphelper::NamedValueCollection aExtractor( aScriptDescriptor );
pos->second.ScriptType = aExtractor.getOrDefault( u"EventType"_ustr, OUString() );
pos->second.ScriptCode = aExtractor.getOrDefault( u"Script"_ustr, OUString() );
}
Any SAL_CALL EventHolder::getByName( const OUString& _rName )
{
ScriptEventDescriptor aDescriptor( impl_getDescriptor_throw( _rName ) );
Sequence< PropertyValue > aScriptDescriptor{
comphelper::makePropertyValue(u"EventType"_ustr, aDescriptor.ScriptType),
comphelper::makePropertyValue(u"Script"_ustr, aDescriptor.ScriptCode)
};
return Any( aScriptDescriptor );
}
Sequence< OUString > SAL_CALL EventHolder::getElementNames( )
{
Sequence< OUString > aReturn( m_aEventIndexAccess.size() );
OUString* pReturn = aReturn.getArray();
// SvxMacroAssignDlg has a weird API: It expects a XNameReplace, means a container whose
// main access method is by name. In its UI, it shows the possible events in exactly the
// order in which XNameAccess::getElementNames returns them.
// However, SvxMacroAssignDlg *also* takes an index for the initial selection, which is
// relative to the sequence returned by XNameAccess::getElementNames.
// This is IMO weird, since it mixes index access with name access, which decreases efficiency
// of the implementation.
// Well, it means we're forced to return the events in getElementNames in exactly the same as they
// appear in the property browser UI.
for (auto const& elem : m_aEventIndexAccess)
{
*pReturn = elem.second;
++pReturn;
}
return aReturn;
}
sal_Bool SAL_CALL EventHolder::hasByName( const OUString& _rName )
{
EventMap::const_iterator pos = m_aEventNameAccess.find( _rName );
return pos != m_aEventNameAccess.end();
}
Type SAL_CALL EventHolder::getElementType( )
{
return cppu::UnoType<Sequence< PropertyValue >>::get();
}
sal_Bool SAL_CALL EventHolder::hasElements( )
{
return !m_aEventNameAccess.empty();
}
EventHandler::EventHandler( const Reference< XComponentContext >& _rxContext )
:EventHandler_Base( m_aMutex )
,m_xContext( _rxContext )
,m_aPropertyListeners( m_aMutex )
,m_bEventsMapInitialized( false )
,m_bIsDialogElement( false )
,m_nGridColumnType( -1 )
{
}
EventHandler::~EventHandler()
{
}
OUString SAL_CALL EventHandler::getImplementationName( )
{
return u"com.sun.star.comp.extensions.EventHandler"_ustr;
}
sal_Bool SAL_CALL EventHandler::supportsService( const OUString& ServiceName )
{
return cppu::supportsService(this, ServiceName);
}
Sequence< OUString > SAL_CALL EventHandler::getSupportedServiceNames( )
{
return { u"com.sun.star.form.inspection.EventHandler"_ustr };
}
void SAL_CALL EventHandler::inspect( const Reference< XInterface >& _rxIntrospectee )
{
::osl::MutexGuard aGuard( m_aMutex );
if ( !_rxIntrospectee.is() )
throw NullPointerException();
m_xComponent.set( _rxIntrospectee, UNO_QUERY_THROW );
m_bEventsMapInitialized = false;
EventMap().swap(m_aEvents);
m_bIsDialogElement = false;
m_nGridColumnType = -1;
try
{
Reference< XPropertySetInfo > xPSI( m_xComponent->getPropertySetInfo() );
m_bIsDialogElement = xPSI.is()
&& xPSI->hasPropertyByName( PROPERTY_WIDTH )
&& xPSI->hasPropertyByName( PROPERTY_HEIGHT )
&& xPSI->hasPropertyByName( PROPERTY_POSITIONX )
&& xPSI->hasPropertyByName( PROPERTY_POSITIONY );
Reference< XChild > xAsChild( _rxIntrospectee, UNO_QUERY );
if ( xAsChild.is() && !Reference< XForm >( _rxIntrospectee, UNO_QUERY ).is() )
{
if ( FormComponentType::GRIDCONTROL == classifyComponent( xAsChild->getParent() ) )
{
m_nGridColumnType = classifyComponent( _rxIntrospectee );
}
}
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
}
}
Any SAL_CALL EventHandler::getPropertyValue( const OUString& _rPropertyName )
{
::osl::MutexGuard aGuard( m_aMutex );
const EventDescription& rEvent = impl_getEventForName_throw( _rPropertyName );
std::vector< ScriptEventDescriptor > aEvents;
impl_getComponentScriptEvents_nothrow( aEvents );
ScriptEventDescriptor aPropertyValue;
for ( const ScriptEventDescriptor& rSCD : aEvents )
{
if ( rEvent.sListenerClassName == rSCD.ListenerType
&& rEvent.sListenerMethodName == rSCD.EventMethod
)
{
aPropertyValue = rSCD;
break;
}
}
return Any( aPropertyValue );
}
void SAL_CALL EventHandler::setPropertyValue( const OUString& _rPropertyName, const Any& _rValue )
{
::osl::MutexGuard aGuard( m_aMutex );
const EventDescription& rEvent = impl_getEventForName_throw( _rPropertyName );
ScriptEventDescriptor aNewScriptEvent;
OSL_VERIFY( _rValue >>= aNewScriptEvent );
ScriptEventDescriptor aOldScriptEvent;
OSL_VERIFY( getPropertyValue( _rPropertyName ) >>= aOldScriptEvent );
if ( aOldScriptEvent == aNewScriptEvent )
return;
if ( m_bIsDialogElement )
impl_setDialogElementScriptEvent_nothrow( aNewScriptEvent );
else
impl_setFormComponentScriptEvent_nothrow( aNewScriptEvent );
PropertyHandlerHelper::setContextDocumentModified( m_xContext );
PropertyChangeEvent aEvent;
aEvent.Source = m_xComponent;
aEvent.PropertyHandle = rEvent.nId;
aEvent.PropertyName = _rPropertyName;
aEvent.OldValue <<= aOldScriptEvent;
aEvent.NewValue <<= aNewScriptEvent;
m_aPropertyListeners.notifyEach( &XPropertyChangeListener::propertyChange, aEvent );
}
Any SAL_CALL EventHandler::convertToPropertyValue( const OUString& _rPropertyName, const Any& _rControlValue )
{
::osl::MutexGuard aGuard( m_aMutex );
OUString sNewScriptCode;
OSL_VERIFY( _rControlValue >>= sNewScriptCode );
std::vector< ScriptEventDescriptor > aAllAssignedEvents;
impl_getComponentScriptEvents_nothrow( aAllAssignedEvents );
const EventDescription& rEvent = impl_getEventForName_throw( _rPropertyName );
ScriptEventDescriptor aAssignedScript = lcl_getAssignedScriptEvent( rEvent, aAllAssignedEvents );
OSL_ENSURE( sNewScriptCode.isEmpty(), "EventHandler::convertToPropertyValue: cannot convert a non-empty display name!" );
// Usually, there is no possibility for the user to change the content of an event binding directly in the
// input field, this instead is done with the macro assignment dialog.
// The only exception is the user pressing "DEL" while the control has the focus, in this case, we reset the
// control content to an empty string. So this is the only scenario where this method is allowed to be called.
// Strictly, we would be able to convert the display value to a property value,
// using the "name (location, language)" format we used in convertToControlValue. However,
// there is no need for this code...
aAssignedScript.ScriptCode = sNewScriptCode;
return Any( aAssignedScript );
}
Any SAL_CALL EventHandler::convertToControlValue( const OUString& /*_rPropertyName*/, const Any& _rPropertyValue, const Type& _rControlValueType )
{
::osl::MutexGuard aGuard( m_aMutex );
ScriptEventDescriptor aScriptEvent;
OSL_VERIFY( _rPropertyValue >>= aScriptEvent );
OSL_ENSURE( _rControlValueType.getTypeClass() == TypeClass_STRING,
"EventHandler::convertToControlValue: unexpected ControlValue type class!" );
OUString sScript( aScriptEvent.ScriptCode );
if ( !sScript.isEmpty() )
{
// format is: "name (location, language)"
try
{
// parse
Reference< XUriReferenceFactory > xUriRefFac = UriReferenceFactory::create( m_xContext );
Reference< XVndSunStarScriptUrlReference > xScriptUri( xUriRefFac->parse( sScript ), UNO_QUERY_THROW );
OUStringBuffer aComposeBuffer;
// name
aComposeBuffer.append( xScriptUri->getName() );
// location
const OUString sLocation = xScriptUri->getParameter( u"location"_ustr );
const OUString sLanguage = xScriptUri->getParameter( u"language"_ustr );
if ( !(sLocation.isEmpty() && sLanguage.isEmpty()) )
{
aComposeBuffer.append( " (" );
// location
OSL_ENSURE( !sLocation.isEmpty(), "EventHandler::convertToControlValue: unexpected: no location!" );
if ( !sLocation.isEmpty() )
{
aComposeBuffer.append( sLocation + ", " );
}
// language
if ( !sLanguage.isEmpty() )
{
aComposeBuffer.append( sLanguage );
}
aComposeBuffer.append( ')' );
}
sScript = aComposeBuffer.makeStringAndClear();
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
}
}
return Any( sScript );
}
PropertyState SAL_CALL EventHandler::getPropertyState( const OUString& /*_rPropertyName*/ )
{
return PropertyState_DIRECT_VALUE;
}
void SAL_CALL EventHandler::addPropertyChangeListener( const Reference< XPropertyChangeListener >& _rxListener )
{
::osl::MutexGuard aGuard( m_aMutex );
if ( !_rxListener.is() )
throw NullPointerException();
m_aPropertyListeners.addInterface( _rxListener );
}
void SAL_CALL EventHandler::removePropertyChangeListener( const Reference< XPropertyChangeListener >& _rxListener )
{
::osl::MutexGuard aGuard( m_aMutex );
m_aPropertyListeners.removeInterface( _rxListener );
}
Sequence< Property > SAL_CALL EventHandler::getSupportedProperties()
{
::osl::MutexGuard aGuard( m_aMutex );
if ( !m_bEventsMapInitialized )
{
m_bEventsMapInitialized = true;
try
{
std::vector< Type > aListeners;
impl_getComponentListenerTypes_nothrow( aListeners );
OUString sListenerClassName;
// loop through all listeners and all methods, and see which we can present at the UI
for ( const Type& rListener : aListeners )
{
// the programmatic name of the listener, to be used as "property" name
sListenerClassName = rListener.getTypeName();
OSL_ENSURE( !sListenerClassName.isEmpty(), "EventHandler::getSupportedProperties: strange - no listener name ..." );
if ( sListenerClassName.isEmpty() )
continue;
// loop through all methods
const Sequence<OUString> aEventMethods = comphelper::getEventMethodsForType( rListener );
for (const OUString& rMethod : aEventMethods)
{
EventDescription aEvent;
if ( !lcl_getEventDescriptionForMethod( rMethod, aEvent ) )
continue;
if ( !impl_filterMethod_nothrow( aEvent ) )
continue;
m_aEvents.emplace(
lcl_getEventPropertyName( sListenerClassName, rMethod ), aEvent );
}
}
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
}
}
// sort them by ID - this is the relative ordering in the UI
std::map< EventId, Property > aOrderedProperties;
for (auto const& event : m_aEvents)
{
aOrderedProperties[ event.second.nId ] = Property(
event.first, event.second.nId,
::cppu::UnoType<OUString>::get(),
PropertyAttribute::BOUND );
}
return comphelper::mapValuesToSequence( aOrderedProperties );
}
Sequence< OUString > SAL_CALL EventHandler::getSupersededProperties( )
{
// none
return Sequence< OUString >( );
}
Sequence< OUString > SAL_CALL EventHandler::getActuatingProperties( )
{
// none
return Sequence< OUString >( );
}
LineDescriptor SAL_CALL EventHandler::describePropertyLine( const OUString& _rPropertyName,
const Reference< XPropertyControlFactory >& _rxControlFactory )
{
if ( !_rxControlFactory.is() )
throw NullPointerException();
::osl::MutexGuard aGuard( m_aMutex );
LineDescriptor aDescriptor;
aDescriptor.Control = _rxControlFactory->createPropertyControl( PropertyControlType::TextField, true );
new PropertyControlExtender( aDescriptor.Control );
const EventDescription& rEvent = impl_getEventForName_throw( _rPropertyName );
aDescriptor.DisplayName = rEvent.sDisplayName;
aDescriptor.HelpURL = HelpIdUrl::getHelpURL( rEvent.sHelpId );
aDescriptor.PrimaryButtonId = OStringToOUString(rEvent.sUniqueBrowseId, RTL_TEXTENCODING_UTF8);
aDescriptor.HasPrimaryButton = true;
aDescriptor.Category = "Events";
return aDescriptor;
}
sal_Bool SAL_CALL EventHandler::isComposable( const OUString& /*_rPropertyName*/ )
{
return false;
}
InteractiveSelectionResult SAL_CALL EventHandler::onInteractivePropertySelection( const OUString& _rPropertyName, sal_Bool /*_bPrimary*/, Any& /*_rData*/, const Reference< XObjectInspectorUI >& _rxInspectorUI )
{
if ( !_rxInspectorUI.is() )
throw NullPointerException();
::osl::MutexGuard aGuard( m_aMutex );
const EventDescription& rForEvent = impl_getEventForName_throw( _rPropertyName );
std::vector< ScriptEventDescriptor > aAllAssignedEvents;
impl_getComponentScriptEvents_nothrow( aAllAssignedEvents );
// SvxMacroAssignDlg-compatible structure holding all event/assignments
::rtl::Reference< EventHolder > pEventHolder( new EventHolder );
for (auto const& event : m_aEvents)
{
// the script which is assigned to the current event (if any)
ScriptEventDescriptor aAssignedScript = lcl_getAssignedScriptEvent( event.second, aAllAssignedEvents );
pEventHolder->addEvent( event.second.nId, event.second.sListenerMethodName, aAssignedScript );
}
// the initial selection in the dialog
const Sequence< OUString > aNames( pEventHolder->getElementNames() );
const OUString* pChosenEvent = std::find( aNames.begin(), aNames.end(), rForEvent.sListenerMethodName );
sal_uInt16 nInitialSelection = static_cast<sal_uInt16>( pChosenEvent - aNames.begin() );
// the dialog
SvxAbstractDialogFactory* pFactory = SvxAbstractDialogFactory::Create();
ScopedVclPtr<VclAbstractDialog> pDialog( pFactory->CreateSvxMacroAssignDlg(
PropertyHandlerHelper::getDialogParentFrame( m_xContext ),
impl_getContextFrame_nothrow(),
m_bIsDialogElement,
pEventHolder,
nInitialSelection
) );
if ( !pDialog )
return InteractiveSelectionResult_Cancelled;
// DF definite problem here
// OK & Cancel seem to be both returning 0
if ( pDialog->Execute() == RET_CANCEL )
return InteractiveSelectionResult_Cancelled;
try
{
for (auto const& event : m_aEvents)
{
ScriptEventDescriptor aScriptDescriptor( pEventHolder->getNormalizedDescriptorByName( event.second.sListenerMethodName ) );
// set the new "property value"
setPropertyValue(
lcl_getEventPropertyName( event.second.sListenerClassName, event.second.sListenerMethodName ),
Any( aScriptDescriptor )
);
}
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
}
return InteractiveSelectionResult_Success;
}
void SAL_CALL EventHandler::actuatingPropertyChanged( const OUString& /*_rActuatingPropertyName*/, const Any& /*_rNewValue*/, const Any& /*_rOldValue*/, const Reference< XObjectInspectorUI >& /*_rxInspectorUI*/, sal_Bool /*_bFirstTimeInit*/ )
{
OSL_FAIL( "EventHandler::actuatingPropertyChanged: no actuating properties -> no callback (well, this is how it *should* be!)" );
}
IMPLEMENT_FORWARD_XCOMPONENT( EventHandler, EventHandler_Base )
void SAL_CALL EventHandler::disposing()
{
EventMap().swap(m_aEvents);
m_xComponent.clear();
}
sal_Bool SAL_CALL EventHandler::suspend( sal_Bool /*_bSuspend*/ )
{
return true;
}
Reference< XFrame > EventHandler::impl_getContextFrame_nothrow() const
{
Reference< XFrame > xContextFrame;
try
{
Reference< XModel > xContextDocument( PropertyHandlerHelper::getContextDocument(m_xContext), UNO_QUERY_THROW );
Reference< XController > xController( xContextDocument->getCurrentController(), UNO_SET_THROW );
xContextFrame.set( xController->getFrame(), UNO_SET_THROW );
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
}
return xContextFrame;
}
sal_Int32 EventHandler::impl_getComponentIndexInParent_throw() const
{
Reference< XChild > xChild( m_xComponent, UNO_QUERY_THROW );
Reference< XIndexAccess > xParentAsIndexAccess( xChild->getParent(), UNO_QUERY_THROW );
// get the index of the inspected object within its parent container
sal_Int32 nElements = xParentAsIndexAccess->getCount();
for ( sal_Int32 i=0; i<nElements; ++i )
{
Reference< XInterface > xElement( xParentAsIndexAccess->getByIndex( i ), UNO_QUERY_THROW );
if ( xElement == m_xComponent )
return i;
}
throw NoSuchElementException();
}
void EventHandler::impl_getFormComponentScriptEvents_nothrow( std::vector < ScriptEventDescriptor >& _out_rEvents ) const
{
_out_rEvents.clear();
try
{
Reference< XChild > xChild( m_xComponent, UNO_QUERY_THROW );
Reference< XEventAttacherManager > xEventManager( xChild->getParent(), UNO_QUERY_THROW );
comphelper::sequenceToContainer(_out_rEvents, xEventManager->getScriptEvents( impl_getComponentIndexInParent_throw() ));
// the form component script API has unqualified listener names, but for normalization
// purpose, we want fully qualified ones
for ( ScriptEventDescriptor& rSED : _out_rEvents)
{
rSED.ListenerType = lcl_getQualifiedKnownListenerName( rSED );
}
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
}
}
void EventHandler::impl_getComponentListenerTypes_nothrow( std::vector< Type >& _out_rTypes ) const
{
_out_rTypes.clear();
try
{
// we use a set to avoid duplicates
TypeBag aListeners;
Reference< XIntrospection > xIntrospection = theIntrospection::get( m_xContext );
// --- model listeners
lcl_addListenerTypesFor_throw(
m_xComponent, xIntrospection, aListeners );
// --- "secondary component" (usually: "control" listeners)
{
Reference< XInterface > xSecondaryComponent( impl_getSecondaryComponentForEventInspection_throw() );
lcl_addListenerTypesFor_throw( xSecondaryComponent, xIntrospection, aListeners );
::comphelper::disposeComponent( xSecondaryComponent );
}
// now that they're disambiguated, copy these types into our member
_out_rTypes.insert( _out_rTypes.end(), aListeners.begin(), aListeners.end() );
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
}
}
void EventHandler::impl_getDialogElementScriptEvents_nothrow( std::vector < ScriptEventDescriptor >& _out_rEvents ) const
{
_out_rEvents.clear();
try
{
Reference< XScriptEventsSupplier > xEventsSupplier( m_xComponent, UNO_QUERY_THROW );
Reference< XNameContainer > xEvents( xEventsSupplier->getEvents(), UNO_SET_THROW );
Sequence< OUString > aEventNames( xEvents->getElementNames() );
sal_Int32 nEventCount = aEventNames.getLength();
_out_rEvents.resize( nEventCount );
for( sal_Int32 i = 0; i < nEventCount; ++i )
OSL_VERIFY( xEvents->getByName( aEventNames[i] ) >>= _out_rEvents[i] );
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
}
}
Reference< XInterface > EventHandler::impl_getSecondaryComponentForEventInspection_throw( ) const
{
Reference< XInterface > xReturn;
// if it's a form, create a form controller for the additional events
Reference< XForm > xComponentAsForm( m_xComponent, UNO_QUERY );
if ( xComponentAsForm.is() )
{
Reference< XTabControllerModel > xComponentAsTCModel( m_xComponent, UNO_QUERY_THROW );
Reference< XFormController > xController = FormController::create( m_xContext );
xController->setModel( xComponentAsTCModel );
xReturn = xController;
}
else
{
OUString sControlService;
OSL_VERIFY( m_xComponent->getPropertyValue( PROPERTY_DEFAULTCONTROL ) >>= sControlService );
xReturn = m_xContext->getServiceManager()->createInstanceWithContext( sControlService, m_xContext );
}
return xReturn;
}
const EventDescription& EventHandler::impl_getEventForName_throw( const OUString& _rPropertyName ) const
{
EventMap::const_iterator pos = m_aEvents.find( _rPropertyName );
if ( pos == m_aEvents.end() )
throw UnknownPropertyException(_rPropertyName);
return pos->second;
}
namespace
{
bool lcl_endsWith( std::u16string_view _rText, std::u16string_view _rCheck )
{
size_t nTextLen = _rText.size();
size_t nCheckLen = _rCheck.size();
if ( nCheckLen > nTextLen )
return false;
return _rText.find( _rCheck ) == ( nTextLen - nCheckLen );
}
}
void EventHandler::impl_setFormComponentScriptEvent_nothrow( const ScriptEventDescriptor& _rScriptEvent )
{
try
{
OUString sScriptCode( _rScriptEvent.ScriptCode );
OUString sScriptType( _rScriptEvent.ScriptType );
bool bResetScript = sScriptCode.isEmpty();
sal_Int32 nObjectIndex = impl_getComponentIndexInParent_throw();
Reference< XChild > xChild( m_xComponent, UNO_QUERY_THROW );
Reference< XEventAttacherManager > xEventManager( xChild->getParent(), UNO_QUERY_THROW );
std::vector< ScriptEventDescriptor > aEvents;
comphelper::sequenceToContainer( aEvents, xEventManager->getScriptEvents( nObjectIndex ) );
// is there already a registered script for this event?
sal_Int32 eventCount = aEvents.size(), event = 0;
for ( event = 0; event < eventCount; ++event )
{
ScriptEventDescriptor* pEvent = &aEvents[event];
if ( ( pEvent->EventMethod == _rScriptEvent.EventMethod )
&& ( lcl_endsWith( _rScriptEvent.ListenerType, pEvent->ListenerType ) )
// (strange enough, the events we get from getScriptEvents are not fully qualified)
)
{
// yes
if ( !bResetScript )
{
// set to something non-empty -> overwrite
pEvent->ScriptCode = sScriptCode;
pEvent->ScriptType = sScriptType;
}
else
{
// set to empty -> remove from vector
aEvents.erase(aEvents.begin() + event );
--eventCount;
}
break;
}
}
if ( ( event >= eventCount ) && !bResetScript )
{
// no, did not find it -> append
aEvents.push_back( _rScriptEvent );
}
xEventManager->revokeScriptEvents( nObjectIndex );
xEventManager->registerScriptEvents( nObjectIndex, comphelper::containerToSequence(aEvents) );
PropertyHandlerHelper::setContextDocumentModified( m_xContext );
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
}
}
void EventHandler::impl_setDialogElementScriptEvent_nothrow( const ScriptEventDescriptor& _rScriptEvent )
{
try
{
OUString sScriptCode( _rScriptEvent.ScriptCode );
bool bResetScript = sScriptCode.isEmpty();
Reference< XScriptEventsSupplier > xEventsSupplier( m_xComponent, UNO_QUERY_THROW );
Reference< XNameContainer > xEvents( xEventsSupplier->getEvents(), UNO_SET_THROW );
OUString sCompleteName =
_rScriptEvent.ListenerType +
"::" +
_rScriptEvent.EventMethod;
bool bExists = xEvents->hasByName( sCompleteName );
if ( bResetScript )
{
if ( bExists )
xEvents->removeByName( sCompleteName );
}
else
{
Any aNewValue; aNewValue <<= _rScriptEvent;
if ( bExists )
xEvents->replaceByName( sCompleteName, aNewValue );
else
xEvents->insertByName( sCompleteName, aNewValue );
}
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
}
}
bool EventHandler::impl_filterMethod_nothrow( const EventDescription& _rEvent ) const
{
// some (control-triggered) events do not make sense for certain grid control columns. However,
// our mechanism to retrieve control-triggered events does not know about this, so we do some
// late filtering here.
switch ( m_nGridColumnType )
{
case FormComponentType::COMBOBOX:
if ( UID_BRWEVT_ACTIONPERFORMED == _rEvent.sUniqueBrowseId )
return false;
break;
case FormComponentType::LISTBOX:
if ( ( UID_BRWEVT_CHANGED == _rEvent.sUniqueBrowseId )
|| ( UID_BRWEVT_ACTIONPERFORMED == _rEvent.sUniqueBrowseId )
)
return false;
break;
}
return true;
}
} // namespace pcr
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
extensions_propctrlr_EventHandler_get_implementation(
css::uno::XComponentContext* context , css::uno::Sequence<css::uno::Any> const&)
{
return cppu::acquire(new pcr::EventHandler(context));
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|