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
|
/* -*- 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 .
*/
#ifndef INCLUDED_FORMS_SOURCE_INC_FORMCOMPONENT_HXX
#define INCLUDED_FORMS_SOURCE_INC_FORMCOMPONENT_HXX
#include "cloneable.hxx"
#include "property.hrc"
#include "property.hxx"
#include "propertybaghelper.hxx"
#include "resettable.hxx"
#include "services.hxx"
#include "windowstateguard.hxx"
#include <com/sun/star/awt/XControl.hpp>
#include <com/sun/star/beans/XPropertyAccess.hpp>
#include <com/sun/star/beans/XPropertyContainer.hpp>
#include <com/sun/star/container/XChild.hpp>
#include <com/sun/star/container/XNamed.hpp>
#include <com/sun/star/form/binding/XBindableValue.hpp>
#include <com/sun/star/form/FormComponentType.hpp>
#include <com/sun/star/form/validation/XValidatableFormComponent.hpp>
#include <com/sun/star/form/validation/XValidityConstraintListener.hpp>
#include <com/sun/star/form/XBoundComponent.hpp>
#include <com/sun/star/form/XBoundControl.hpp>
#include <com/sun/star/form/XFormComponent.hpp>
#include <com/sun/star/form/XLoadListener.hpp>
#include <com/sun/star/form/XReset.hpp>
#include <com/sun/star/io/XMarkableStream.hpp>
#include <com/sun/star/io/XPersistObject.hpp>
#include <com/sun/star/lang/DisposedException.hpp>
#include <com/sun/star/lang/XEventListener.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/sdb/XColumn.hpp>
#include <com/sun/star/sdb/XColumnUpdate.hpp>
#include <com/sun/star/sdb/XRowSetChangeListener.hpp>
#include <com/sun/star/sdbc/XRowSet.hpp>
#include <com/sun/star/sdbcx/XColumnsSupplier.hpp>
#include <com/sun/star/uno/XAggregation.hpp>
#include <com/sun/star/util/XCloneable.hpp>
#include <com/sun/star/util/XModifyListener.hpp>
#include <com/sun/star/form/XLoadable.hpp>
#include <comphelper/propagg.hxx>
#include <comphelper/propertybag.hxx>
#include <comphelper/propmultiplex.hxx>
#include <comphelper/sequence.hxx>
#include <comphelper/uno3.hxx>
#include <cppuhelper/component.hxx>
#include <cppuhelper/implbase1.hxx>
#include <cppuhelper/implbase2.hxx>
#include <cppuhelper/implbase3.hxx>
#include <cppuhelper/implbase4.hxx>
#include <cppuhelper/implbase7.hxx>
#include <osl/mutex.hxx>
#include <rtl/ustring.hxx>
namespace frm
{
// default tab index for components
const sal_Int16 FRM_DEFAULT_TABINDEX = 0;
// macros for quickly declaring/implementing XServiceInfo
#define DECLARE_XPERSISTOBJECT() \
virtual OUString SAL_CALL getServiceName() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE; \
virtual void SAL_CALL write(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectOutputStream>& _rxOutStream) throw(::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE; \
virtual void SAL_CALL read(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectInputStream>& _rxInStream) throw(::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE; \
// old macro for quickly implementing XServiceInfo::getImplementationName
#define IMPLEMENTATION_NAME(ImplName) \
virtual OUString SAL_CALL getImplementationName( ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE \
{ return OUString("com.sun.star.comp.forms." #ImplName); }
class OControlModel;
//= ControlModelLock
/** class whose instances lock a OControlModel
Locking here merely means locking the OControlModel's mutex.
In addition to the locking facility, the class is also able to fire property
change notifications. This happens when the last ControlModelLock instance on a stack
dies.
*/
class ControlModelLock
{
public:
ControlModelLock( OControlModel& _rModel )
:m_rModel( _rModel )
,m_bLocked( false )
{
acquire();
}
~ControlModelLock()
{
if ( m_bLocked )
release();
}
inline void acquire();
inline void release();
inline OControlModel& getModel() const { return m_rModel; };
/** adds a property change notification, which is to be fired when the last lock on the model
(in the current thread) is released.
*/
void addPropertyNotification(
const sal_Int32 _nHandle,
const ::com::sun::star::uno::Any& _rOldValue,
const ::com::sun::star::uno::Any& _rNewValue
);
private:
void impl_notifyAll_nothrow();
private:
OControlModel& m_rModel;
bool m_bLocked;
::com::sun::star::uno::Sequence< sal_Int32 > m_aHandles;
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > m_aOldValues;
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > m_aNewValues;
private:
ControlModelLock( const ControlModelLock& ) SAL_DELETED_FUNCTION;
ControlModelLock& operator=( const ControlModelLock& ) SAL_DELETED_FUNCTION;
};
//= OControl
//= base class for form layer controls
typedef ::cppu::ImplHelper3 < ::com::sun::star::awt::XControl
, ::com::sun::star::lang::XEventListener
, ::com::sun::star::lang::XServiceInfo
> OControl_BASE;
class OControl :public ::cppu::OComponentHelper
,public OControl_BASE
{
protected:
::osl::Mutex m_aMutex;
::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl >
m_xControl;
::com::sun::star::uno::Reference< ::com::sun::star::uno::XAggregation>
m_xAggregate;
::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
m_xContext;
WindowStateGuard m_aWindowStateGuard;
public:
/** constructs a control
@param _rFactory
the service factory for this control
@param _rAggregateService
the service name of the component to aggregate
@param _bSetDelegator
set this to <FALSE/> if you don't want the constructor to set the delegator at
the aggregate. In this case, you <em>have</em> to call doSetDelegator within your
own constructor.
This is helpful, if your derived class wants to cache an interface of the aggregate.
In this case, the aggregate needs to be queried for this interface <b>before</b> the
<member scope="com::sun::star::uno">XAggregation::setDelegator</member> call.
In such a case, pass <FALSE/> to this parameter. Then, cache the aggregate's interface(s)
as needed. Afterwards, call <member>doSetDelegator</member>.
In your destructor, you need to call <member>doResetDelegator</member> before
resetting the cached interfaces. This will reset the aggregates delegator to <NULL/>,
which will ensure that the <member scope="com::sun::star::uno">XInterface::release</member>
calls on the cached interfaces are really applied to the aggregate, instead of
the <type>OControl</type> itself.
*/
OControl(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rFactory,
const OUString& _rAggregateService,
const bool _bSetDelegator = true
);
/** initializes the given peer with various settings necessary for form controls
*/
static void initFormControlPeer(
const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindowPeer >& _rxPeer );
protected:
virtual ~OControl();
/** sets the control as delegator at the aggregate
This has to be called from within your derived class' constructor, if and only
if you passed <FALSE/> to the <arg>_bSetDelegator</arg> parameter of the
<type>OControl</type> constructor.
*/
void doSetDelegator();
void doResetDelegator();
// UNO
DECLARE_UNO3_AGG_DEFAULTS(OControl, OComponentHelper)
virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation( const ::com::sun::star::uno::Type& _rType ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XTypeProvider
virtual ::com::sun::star::uno::Sequence<sal_Int8> SAL_CALL getImplementationId() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> SAL_CALL getTypes() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// OComponentHelper
virtual void SAL_CALL disposing() SAL_OVERRIDE;
// XComponent (as base of XControl)
virtual void SAL_CALL dispose( ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE
{ OComponentHelper::dispose(); }
virtual void SAL_CALL addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener>& _rxListener) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE
{ OComponentHelper::addEventListener(_rxListener); }
virtual void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener>& _rxListener) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE
{ OComponentHelper::removeEventListener(_rxListener); }
// XEventListener
virtual void SAL_CALL disposing(const ::com::sun::star::lang::EventObject& Source) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XServiceInfo
virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual StringSequence SAL_CALL getSupportedServiceNames() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual OUString SAL_CALL getImplementationName() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE = 0;
// XServiceInfo - static version
static StringSequence SAL_CALL getSupportedServiceNames_Static() throw(::com::sun::star::uno::RuntimeException);
// XControl
virtual void SAL_CALL setContext(const InterfaceRef& Context) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual InterfaceRef SAL_CALL getContext() throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL createPeer(const ::com::sun::star::uno::Reference<css::awt::XToolkit>& Toolkit, const ::com::sun::star::uno::Reference<css::awt::XWindowPeer>& Parent) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Reference<css::awt::XWindowPeer> SAL_CALL getPeer() throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual sal_Bool SAL_CALL setModel(const ::com::sun::star::uno::Reference<css::awt::XControlModel>& Model) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Reference<css::awt::XControlModel> SAL_CALL getModel() throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Reference<css::awt::XView> SAL_CALL getView() throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL setDesignMode(sal_Bool bOn) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual sal_Bool SAL_CALL isDesignMode() throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual sal_Bool SAL_CALL isTransparent() throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
protected:
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> _getTypes();
// overwrite this and call the base class if you have additional types
::com::sun::star::uno::Sequence< OUString > getAggregateServiceNames();
private:
void impl_resetStateGuard_nothrow();
};
// a form control implementing the XBoundControl interface
typedef ::cppu::ImplHelper1 < ::com::sun::star::form::XBoundControl
> OBoundControl_BASE;
class OBoundControl :public OControl
,public OBoundControl_BASE
{
protected:
bool m_bLocked : 1;
OUString m_sOriginalHelpText; // as long as the text/value is invalid, we change the help text of our peer
::com::sun::star::awt::FontDescriptor
m_aOriginalFont; // as long as the text/value is invalid, we also change the font
sal_Int32 m_nOriginalTextLineColor; // (we add red underlining)
public:
OBoundControl(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext,
const OUString& _rAggregateService,
const bool _bSetDelegator = true
);
virtual ~OBoundControl();
DECLARE_UNO3_AGG_DEFAULTS(OBoundControl, OControl)
virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation( const ::com::sun::star::uno::Type& _rType ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XBoundControl
virtual sal_Bool SAL_CALL getLock() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL setLock(sal_Bool _bLock) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// default implementation just disables the controls, overwrite _setLock to change this behaviour
// XControl
virtual sal_Bool SAL_CALL setModel(const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel >& Model) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XEventListener
virtual void SAL_CALL disposing(const ::com::sun::star::lang::EventObject& Source) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// OComponentHelper
virtual void SAL_CALL disposing() SAL_OVERRIDE;
protected:
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> _getTypes() SAL_OVERRIDE;
// implement the lock setting
void _setLock(bool _bLock);
};
//= OControlModel
//= model of a form layer control
//added for exporting OCX control
#define INVALID_OBJ_ID_IN_MSO 0xFFFF
typedef ::cppu::ImplHelper7 < ::com::sun::star::form::XFormComponent
, ::com::sun::star::io::XPersistObject
, ::com::sun::star::container::XNamed
, ::com::sun::star::lang::XServiceInfo
, ::com::sun::star::util::XCloneable
, ::com::sun::star::beans::XPropertyContainer
, ::com::sun::star::beans::XPropertyAccess
> OControlModel_BASE;
class OControlModel :public ::cppu::OComponentHelper
,public OPropertySetAggregationHelper
,public OControlModel_BASE
,public OCloneableAggregation
,public IPropertyBagHelperContext
{
protected:
css::uno::Reference<css::uno::XComponentContext> m_xContext;
::osl::Mutex m_aMutex;
oslInterlockedCount m_lockCount;
InterfaceRef m_xParent; // ParentComponent
PropertyBagHelper m_aPropertyBagHelper;
const css::uno::Reference<css::uno::XComponentContext>&
getContext() const { return m_xContext; }
// <properties>
OUString m_aName; // name of the control
OUString m_aTag; // tag for additional data
sal_Int16 m_nTabIndex; // index within the taborder
sal_Int16 m_nClassId; // type of the control
bool m_bNativeLook; // should the control use the native platform look?
bool m_bGenerateVbEvents; // should the control generate fake vba events
//added for exporting OCX control
sal_Int16 m_nControlTypeinMSO; //keep the MS office control type for exporting to MS binarary file
sal_uInt16 m_nObjIDinMSO; //keep the OCX control obj id for exporting to MS binarary file
// </properties>
protected:
OControlModel(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rFactory, // factory to create the aggregate with
const OUString& _rUnoControlModelTypeName, // service name of te model to aggregate
const OUString& rDefault = OUString(), // service name of the default control
const bool _bSetDelegator = true // set to sal_False if you want to call setDelegator later (after returning from this ctor)
);
OControlModel(
const OControlModel* _pOriginal, // the original object to clone
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rFactory, // factory to create the aggregate with
const bool _bCloneAggregate = true, // should the aggregate of the original be cloned, too?
const bool _bSetDelegator = true // set to sal_False if you want to call setDelegator later (after returning from this ctor)
);
virtual ~OControlModel();
/** to be called after a OBoundControlModel (a derivee, respectively) has been cloned
<p>This method contains late initializations which cannot be done in the
constructor of this base class, since the virtual method of derived classes do
not yet work there.</p>
*/
virtual void clonedFrom( const OControlModel* _pOriginal );
using OComponentHelper::rBHelper;
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> _getTypes();
void readHelpTextCompatibly(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectInputStream >& _rxInStream);
void writeHelpTextCompatibly(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectOutputStream >& _rxOutStream);
void doSetDelegator();
void doResetDelegator();
::com::sun::star::uno::Sequence< OUString > getAggregateServiceNames();
public:
DECLARE_UNO3_AGG_DEFAULTS(OControl, OComponentHelper)
virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation( const ::com::sun::star::uno::Type& _rType ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XTypeProvider
virtual ::com::sun::star::uno::Sequence<sal_Int8> SAL_CALL getImplementationId() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> SAL_CALL getTypes() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// OComponentHelper
virtual void SAL_CALL disposing() SAL_OVERRIDE;
// XNamed
virtual OUString SAL_CALL getName() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL setName(const OUString& aName) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XServiceInfo
virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual StringSequence SAL_CALL getSupportedServiceNames() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual OUString SAL_CALL getImplementationName() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE = 0;
// XSericeInfo - static version(s)
static StringSequence SAL_CALL getSupportedServiceNames_Static() throw(::com::sun::star::uno::RuntimeException);
// XPersistObject
virtual OUString SAL_CALL getServiceName() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE = 0;
virtual void SAL_CALL
write(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectOutputStream>& _rxOutStream) throw(::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL
read(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectInputStream>& _rxInStream) throw(::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XChild (base of XFormComponent)
virtual InterfaceRef SAL_CALL getParent() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL setParent(const InterfaceRef& Parent) throw(::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XEventListener
virtual void SAL_CALL disposing(const ::com::sun::star::lang::EventObject& Source) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XPropertySet
virtual void SAL_CALL getFastPropertyValue(::com::sun::star::uno::Any& rValue, sal_Int32 nHandle) const SAL_OVERRIDE;
virtual sal_Bool SAL_CALL convertFastPropertyValue(
::com::sun::star::uno::Any& _rConvertedValue, ::com::sun::star::uno::Any& _rOldValue, sal_Int32 _nHandle, const ::com::sun::star::uno::Any& _rValue )
throw (::com::sun::star::lang::IllegalArgumentException) SAL_OVERRIDE;
virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue )
throw (::com::sun::star::uno::Exception, std::exception) SAL_OVERRIDE;
using ::cppu::OPropertySetHelper::getFastPropertyValue;
// ::com::sun::star::beans::XPropertyState
virtual ::com::sun::star::beans::PropertyState getPropertyStateByHandle(sal_Int32 nHandle) SAL_OVERRIDE;
virtual void setPropertyToDefaultByHandle(sal_Int32 nHandle) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Any getPropertyDefaultByHandle( sal_Int32 nHandle ) const SAL_OVERRIDE;
// XCloneable
virtual ::com::sun::star::uno::Reference< ::com::sun::star::util::XCloneable > SAL_CALL createClone( ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE = 0;
// XPropertyContainer
virtual void SAL_CALL addProperty( const OUString& Name, ::sal_Int16 Attributes, const ::com::sun::star::uno::Any& DefaultValue ) throw (::com::sun::star::beans::PropertyExistException, ::com::sun::star::beans::IllegalTypeException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removeProperty( const OUString& Name ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::NotRemoveableException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XPropertyAccess
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > SAL_CALL getPropertyValues( ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL setPropertyValues( const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& aProps ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
protected:
using OPropertySetAggregationHelper::setPropertyValues;
using OPropertySetAggregationHelper::getPropertyValues;
protected:
virtual void writeAggregate( const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectOutputStream >& _rxOutStream ) const;
virtual void readAggregate( const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectInputStream >& _rxInStream );
protected:
// XPropertySet
virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo> SAL_CALL getPropertySetInfo() throw( ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// OPropertySetHelper
virtual cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper() SAL_OVERRIDE;
/** describes the properties provided by this class, or its respective
derived class
Derived classes usually call the base class first, and then append own properties.
*/
virtual void describeFixedProperties(
::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >& /* [out] */ _rProps
) const;
// IPropertyBagHelperContext
virtual ::osl::Mutex& getMutex() SAL_OVERRIDE;
virtual void describeFixedAndAggregateProperties(
::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >& _out_rFixedProperties,
::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >& _out_rAggregateProperties
) const SAL_OVERRIDE;
virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XMultiPropertySet >
getPropertiesInterface() SAL_OVERRIDE;
/** describes the properties of our aggregate
The default implementation simply asks m_xAggregateSet for its properties.
You usually only need to override this method if you want to filter the
aggregate properties.
*/
virtual void describeAggregateProperties(
::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >& /* [out] */ _rAggregateProps
) const;
public:
struct LockAccess { friend class ControlModelLock; private: LockAccess() { } };
void lockInstance( LockAccess );
oslInterlockedCount unlockInstance( LockAccess );
void firePropertyChanges(
const ::com::sun::star::uno::Sequence< sal_Int32 >& _rHandles,
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& _rOldValues,
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& _rNewValues,
LockAccess
);
inline ::osl::Mutex&
getInstanceMutex() { return m_aMutex; }
};
// constructor for cloning a class
#define DECLARE_DEFAULT_CLONE_CTOR( classname ) \
classname( \
const classname* _pOriginal, \
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rxFactory \
); \
// all xtors for an inner class of the object hierarchy
#define DECLARE_DEFAULT_XTOR( classname ) \
classname( \
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rxFactory, \
const OUString& _rUnoControlModelTypeName, \
const OUString& _rDefault \
); \
DECLARE_DEFAULT_CLONE_CTOR( classname ) \
virtual ~classname() \
// all xtors for an inner class of the object hierarchy which is *bound*
#define DECLARE_DEFAULT_BOUND_XTOR( classname ) \
classname( \
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rxFactory, \
const OUString& _rUnoControlModelTypeName, \
const OUString& _rDefault, \
const bool _bSupportExternalBinding, \
const bool _bSupportsValidation \
); \
DECLARE_DEFAULT_CLONE_CTOR( classname ) \
virtual ~classname() \
// all xtors for a leas class of the object hierarchy
#define DECLARE_DEFAULT_LEAF_XTOR( classname ) \
classname( \
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rxFactory \
); \
classname( \
const classname* _pOriginal, \
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rxFactory \
); \
virtual ~classname() \
#define IMPLEMENT_DEFAULT_CLONING( classname ) \
::com::sun::star::uno::Reference< ::com::sun::star::util::XCloneable > SAL_CALL classname::createClone( ) throw (::com::sun::star::uno::RuntimeException, std::exception) \
{ \
classname* pClone = new classname( this, getContext() ); \
pClone->clonedFrom( this ); \
return pClone; \
}
//= OBoundControlModel
//= model of a form layer control which is bound to a data source field
typedef ::cppu::ImplHelper4 < ::com::sun::star::form::XLoadListener
, ::com::sun::star::form::XReset
, ::com::sun::star::beans::XPropertyChangeListener
, ::com::sun::star::sdb::XRowSetChangeListener
> OBoundControlModel_BASE1;
// separated into an own base class since derivees can disable the support for this
// interface, thus we want to easily exclude it in the queryInterface and getTypes
typedef ::cppu::ImplHelper1 < ::com::sun::star::form::XBoundComponent
> OBoundControlModel_COMMITTING;
// dito
typedef ::cppu::ImplHelper2 < ::com::sun::star::form::binding::XBindableValue
, ::com::sun::star::util::XModifyListener
> OBoundControlModel_BINDING;
// dito
typedef ::cppu::ImplHelper2 < ::com::sun::star::form::validation::XValidityConstraintListener
, ::com::sun::star::form::validation::XValidatableFormComponent
> OBoundControlModel_VALIDATION;
class OBoundControlModel :public OControlModel
,public OBoundControlModel_BASE1
,public OBoundControlModel_COMMITTING
,public OBoundControlModel_BINDING
,public OBoundControlModel_VALIDATION
,public ::comphelper::OPropertyChangeListener
{
protected:
enum ValueChangeInstigator
{
eDbColumnBinding,
eExternalBinding,
eOther
};
private:
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
m_xField;
// the form which controls supplies the field we bind to.
::com::sun::star::uno::Reference< ::com::sun::star::form::XLoadable >
m_xAmbientForm;
OUString m_sValuePropertyName;
sal_Int32 m_nValuePropertyAggregateHandle;
sal_Int32 m_nFieldType;
::com::sun::star::uno::Type m_aValuePropertyType;
bool m_bValuePropertyMayBeVoid;
ResetHelper m_aResetHelper;
::cppu::OInterfaceContainerHelper m_aUpdateListeners;
::cppu::OInterfaceContainerHelper m_aFormComponentListeners;
::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XValueBinding >
m_xExternalBinding;
::com::sun::star::uno::Reference< ::com::sun::star::form::validation::XValidator >
m_xValidator;
::com::sun::star::uno::Type m_aExternalValueType;
// <properties>
OUString m_aControlSource; // Datenquelle, Name des Feldes
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
m_xLabelControl; // reference to a sibling control (model) which is our label
bool m_bInputRequired;
// </properties>
::comphelper::OPropertyChangeMultiplexer*
m_pAggPropMultiplexer;
bool m_bFormListening : 1; // are we currently a XLoadListener at our ambient form?
bool m_bLoaded : 1;
bool m_bRequired : 1;
const bool m_bCommitable : 1; // do we support XBoundComponent?
const bool m_bSupportsExternalBinding : 1; // do we support XBindableValue?
const bool m_bSupportsValidation : 1; // do we support XValidatable?
bool m_bForwardValueChanges : 1; // do we currently handle changes in the bound database field?
bool m_bTransferingValue : 1; // true if we're currently transferring our value to an external binding
bool m_bIsCurrentValueValid : 1; // flag specifying whether our current value is valid, relative to our external validator
bool m_bBindingControlsRO : 1; // is our ReadOnly property currently controlled by our external binding?
bool m_bBindingControlsEnable : 1; // is our Enabled property currently controlled by our external binding?
ValueChangeInstigator m_eControlValueChangeInstigator;
protected:
OUString m_aLabelServiceName;
// when setting the label for our control (property FM_PROP_CONTROLLABEL, member m_xLabelControl),
// we accept only objects supporting an XControlModel interface, an XServiceInfo interface and
// support for a service (XServiceInfo::supportsService) determined by this string.
// Any other arguments will throw an IllegalArgumentException.
// The default value is FM_COMPONENT_FIXEDTEXT.
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet >
m_xCursor;
::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumnUpdate >
m_xColumnUpdate;
::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumn >
m_xColumn;
protected:
inline const OUString& getValuePropertyName( ) const { return m_sValuePropertyName; }
inline sal_Int32 getValuePropertyAggHandle( ) const { return m_nValuePropertyAggregateHandle; }
inline const OUString& getControlSource( ) const { return m_aControlSource; }
inline bool isRequired() const { return m_bRequired; }
inline bool isLoaded() const { return m_bLoaded; }
protected:
OBoundControlModel(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rxContext,
// factory to create the aggregate with
const OUString& _rUnoControlModelTypeName, // service name of te model to aggregate
const OUString& _rDefault, // service name of the default control
const bool _bCommitable, // is the control (model) commitable ?
const bool _bSupportExternalBinding, // set to sal_True if you want to support XBindableValue
const bool _bSupportsValidation // set to sal_True if you want to support XValidatable
);
OBoundControlModel(
const OBoundControlModel* _pOriginal, // the original object to clone
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rxContext
// factory to create the aggregate with
);
virtual ~OBoundControlModel();
/// late ctor after cloning
virtual void clonedFrom( const OControlModel* _pOriginal ) SAL_OVERRIDE;
/** initializes the part of the class which is related to the control value.
<p>Kind of late ctor, to be called for derivees which have a dedicated value property.<br/>
The value property is the property which's value is synced with either the database
column the object is bound to, or with the external value binding, if present.<br/>
E.g. for a text control model, this property will most probably be "Text".</p>
<p>Derived classes are stronly recommend to call this method - at least the
"DataFieldProperty" (exposed in getFastPropertyValue) relies on the information
given herein, and needs to be supplied otherwise else.</p>
<p>If this method has been called properly, then <member>setControlValue</member>
does not need to be overridden - it will simply set the property value at the
aggregate then.</p>
@precond
The method has not be called before during the life time of the object.
@param _rValuePropertyName
the name of the value property
@param _nValuePropertyExternalHandle
the handle of the property, as exposed to external components.<br/>
Normally, this information can be obtained dynamically (e.g. from describeFixedProperties),
but since this method is to be called from within the constructor of derived classes,
we prefer to be on the *really* safe side here ....
@see setControlValue
@see suspendValueListening
@see resumeValueListening
@see describeFixedProperties
*/
void initValueProperty(
const OUString& _rValuePropertyName,
sal_Int32 _nValuePropertyExternalHandle
);
/** initializes the part of the class which is related to the control value.
<p>In opposite to ->initValueProperty, this method is to be used for value properties which are <em>not</em>
implemented by our aggregate, but by ourselves.</p>
<p>Certain functionality is not available when using own value properties. This includes binding to an external
value and external validation. (This is not a conceptual limit, but simply missing implementation.)</p>
*/
void initOwnValueProperty(
const OUString& i_rValuePropertyName
);
/** suspends listening at the value property
<p>As long as this listening is suspended, changes in the value property will not be
recognized and not be handled.</p>
@see initValueProperty
@see resumeValueListening
*/
void suspendValueListening( );
/** resumes listening at the value property
<p>As long as this listening is suspended, changes in the value property will not be
recognized and not be handled.</p>
@precond
listening at the value property is currently suspended
@see initValueProperty
@see resumeValueListening
*/
void resumeValueListening( );
/** (to be) called when the value property changed
Normally, this is done automatically, since the value property is a property of our aggregate, and we're
a listener at this property.
However, in some cases the value property might not be an aggregate property, but a property of the
delegator instance. In this case, you'll need to call <code>onValuePropertyChange</code> whenever this
property changes.
*/
void onValuePropertyChange( ControlModelLock& i_rControLock );
/** starts listening at the aggregate, for changes in the given property
<p>The OBoundControlModel automatically registers a multiplexer which listens for
changes in the aggregate property values. By default, only the control value property
is observed. You may add additional properties to be observed with this method.</p>
@see initValueProperty
@see _propertyChanged
*/
void startAggregatePropertyListening( const OUString& _rPropertyName );
/** returns the default which should be used when resetting the control
<p>The default implementation returns an empty Any.</p>
@see resetNoBroadcast
*/
virtual ::com::sun::star::uno::Any
getDefaultForReset() const;
/** translates a db column value into a control value.
<p>Must transform the very current value of the database column we're bound to
(<member>m_xColumn</member>) into a value which can be used as current value
for the control.</p>
@see setControlValue
@pure
*/
virtual ::com::sun::star::uno::Any
translateDbColumnToControlValue( ) = 0;
/** returns the data types which the control could use to exchange data with
an external value binding
The types returned here are completely independent from the concrete value binding,
they're just candidates which depend on the control type, and possible the concrete state
of the control (i.e. some property value).
If a control implementation supports multiple types, the ordering in the returned
sequence indicates preference: Preferred types are mentioned first.
The default implementation returns the type of our value property.
*/
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type >
getSupportedBindingTypes();
/** translates the given value, which was obtained from the current external value binding,
to a value which can be used in setControlValue
<p>The default implementation returns the value itself, exception when it is VOID, and
our value property is not allowed to be void - in this case, the returned value is a
default-constructed value of the type required by our value property.
@see hasExternalValueBinding
@see getExternalValueType
*/
virtual ::com::sun::star::uno::Any
translateExternalValueToControlValue( const ::com::sun::star::uno::Any& _rExternalValue ) const;
/** commits the current control value to our external value binding
<p>The default implementation simply calls getControlValue.</p>
@see hasExternalValueBinding
@see initValueProperty
*/
virtual ::com::sun::star::uno::Any
translateControlValueToExternalValue( ) const;
/** commits the current control value to the database column we're bound to
@precond
we're properly bound to a database column, especially <member>m_xColumnUpdate</member>
is not <NULL/>
@param _bPostReset
<TRUE/> if and only if the current control value results from a reset (<member>getDefaultForReset</member>)
@pure
*/
virtual bool commitControlValueToDbColumn(
bool _bPostReset
) = 0;
/** sets the given value as new current value for the control
Besides some administrative work (such as caring for <member>m_eControlValueChangeInstigator</member>),
this method simply calls <member>doSetControlValue</member>.
@precond
Our own mutex is locked.
@param _rValue
The value to set. This value is guaranteed to be created by
<member>translateDbColumnToControlValue</member> or
<member>translateExternalValueToControlValue</member>
@param _eInstigator
the instigator of the value change
*/
void setControlValue(
const ::com::sun::star::uno::Any& _rValue,
ValueChangeInstigator _eInstigator
);
/**
<p>The default implementation will forward the given value to the aggregate, using
m_nValuePropertyAggregateHandle and/or m_sValuePropertyName.</p>
@precond
Our own mutex is locked.
@param _rValue
The value to set. This value is guaranteed to be created by
<member>translateDbColumnToControlValue</member> or
<member>translateExternalValueToControlValue</member>
*/
virtual void doSetControlValue(
const ::com::sun::star::uno::Any& _rValue
);
/** retrieves the current value of the control
<p>The default implementation will ask the aggregate for the property value
determined by either m_nValuePropertyAggregateHandle and/or m_sValuePropertyName.</p>
@precond
Our own mutex is locked.
*/
virtual ::com::sun::star::uno::Any
getControlValue( ) const;
/** called whenever a connection to a database column has been established
*/
virtual void onConnectedDbColumn( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxForm );
/** called whenever a connection to a database column has been suspended
*/
virtual void onDisconnectedDbColumn();
/** called whenever a connection to an external supplier of values (XValueBinding) has been established
@see m_xExternalBinding
*/
virtual void onConnectedExternalValue( );
/** called whenever a connection to an external supplier of values (XValueBinding) has been suspended
*/
void onDisconnectedExternalValue();
/** called whenever an external validator has been registered
*/
void onConnectedValidator( );
/** called whenever an external validator has been revoked
*/
void onDisconnectedValidator( );
/** nFieldType is the type of the field, on which the model will be linked.
The linking happens when sal_True is returned.
The default-implementation allows everything but the three binary types
and FieldType_OTHER.
*/
virtual bool approveDbColumnType(sal_Int32 _nColumnType);
/** retrieves the current value of the control, in a shape which can be used with our
external validator.
The default implementation simply calls <member>>translateControlValueToExternalValue</member>.
@precond
Our own mutex is locked.
*/
virtual ::com::sun::star::uno::Any
translateControlValueToValidatableValue( ) const;
/** retrieves the current value of the form component
This is the implementation method for XValidatableFormComponent::getCurrentValue. The default implementation
calls translateControlValueToValidatableValue if a validator is present, otherwise getControlValue.
@precond
our mutex is locked when this method is called
*/
virtual ::com::sun::star::uno::Any
getCurrentFormComponentValue() const;
/** We can't write (new) common properties in this base class, as the file format doesn't allow this
(unfortunately). So derived classes may use the following two methods. They secure the written
data with marks, so any new common properties in newer versions will be skipped by older ones.
*/
void writeCommonProperties(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectOutputStream>& _rxOutStream);
void readCommonProperties(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectInputStream>& _rxInStream);
// the next method may be used in derived classes's read when an unknown version is encountered
void defaultCommonProperties();
/** called to reset the control to some kind of default.
<p>The semantics of "default" is finally defined by the derived class (in particular,
by <member>getDefaultForReset</member>).</p>
<p>No listener notification needs to be done in the derived class.</p>
<p>Normally, you won't override this method, but <member>getDefaultForReset</member> instead.</p>
@see getDefaultForReset
*/
virtual void resetNoBroadcast();
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> _getTypes() SAL_OVERRIDE;
/// sets m_xField to the given new value, without notifying our listeners
void impl_setField_noNotify(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxField
);
inline bool hasField() const
{
return m_xField.is();
}
inline sal_Int32 getFieldType() const
{
return m_nFieldType;
}
// OControlModel's property handling
virtual void describeFixedProperties(
::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >& /* [out] */ _rProps
) const SAL_OVERRIDE;
public:
inline const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& getField() const
{
return m_xField;
}
public:
// UNO link
DECLARE_UNO3_AGG_DEFAULTS(OBoundControlModel, OControlModel)
virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation( const ::com::sun::star::uno::Type& _rType ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// OComponentHelper
virtual void SAL_CALL disposing() SAL_OVERRIDE;
// XReset
virtual void SAL_CALL reset( ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL addResetListener( const ::com::sun::star::uno::Reference< ::com::sun::star::form::XResetListener >& aListener ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removeResetListener( const ::com::sun::star::uno::Reference< ::com::sun::star::form::XResetListener >& aListener ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XServiceInfo
virtual StringSequence SAL_CALL getSupportedServiceNames( ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XServiceInfo - static version
static StringSequence SAL_CALL getSupportedServiceNames_Static() throw(::com::sun::star::uno::RuntimeException);
// XChild
virtual void SAL_CALL setParent( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& Parent ) throw(::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XPersistObject
virtual void SAL_CALL write( const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectOutputStream >& OutStream ) throw(::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL read( const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectInputStream >& InStream ) throw(::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XBoundComponent
virtual sal_Bool SAL_CALL commit() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XUpdateBroadcaster (base of XBoundComponent)
virtual void SAL_CALL addUpdateListener( const ::com::sun::star::uno::Reference< ::com::sun::star::form::XUpdateListener >& aListener ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removeUpdateListener( const ::com::sun::star::uno::Reference< ::com::sun::star::form::XUpdateListener >& aListener ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XPropertySet
virtual void SAL_CALL getFastPropertyValue(::com::sun::star::uno::Any& rValue, sal_Int32 nHandle) const SAL_OVERRIDE;
virtual sal_Bool SAL_CALL convertFastPropertyValue(
::com::sun::star::uno::Any& _rConvertedValue, ::com::sun::star::uno::Any& _rOldValue, sal_Int32 _nHandle, const ::com::sun::star::uno::Any& _rValue )
throw (::com::sun::star::lang::IllegalArgumentException) SAL_OVERRIDE;
virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue )
throw (::com::sun::star::uno::Exception, std::exception) SAL_OVERRIDE;
using ::cppu::OPropertySetHelper::getFastPropertyValue;
// ::com::sun::star::beans::XPropertyState
virtual ::com::sun::star::uno::Any getPropertyDefaultByHandle( sal_Int32 nHandle ) const SAL_OVERRIDE;
// XEventListener
virtual void SAL_CALL disposing(const ::com::sun::star::lang::EventObject& Source) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XPropertyChangeListener
virtual void SAL_CALL propertyChange( const ::com::sun::star::beans::PropertyChangeEvent& evt ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XRowSetChangeListener
virtual void SAL_CALL onRowSetChanged( const ::com::sun::star::lang::EventObject& i_Event ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XLoadListener
virtual void SAL_CALL loaded( const ::com::sun::star::lang::EventObject& aEvent ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL unloading( const ::com::sun::star::lang::EventObject& aEvent ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL unloaded( const ::com::sun::star::lang::EventObject& aEvent ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL reloading( const ::com::sun::star::lang::EventObject& aEvent ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL reloaded( const ::com::sun::star::lang::EventObject& aEvent ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
protected:
// XBindableValue
virtual void SAL_CALL setValueBinding( const ::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XValueBinding >& _rxBinding ) throw (::com::sun::star::form::binding::IncompatibleTypesException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XValueBinding > SAL_CALL getValueBinding( ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XModifyListener
virtual void SAL_CALL modified( const ::com::sun::star::lang::EventObject& _rEvent ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XValidatable
virtual void SAL_CALL setValidator( const ::com::sun::star::uno::Reference< ::com::sun::star::form::validation::XValidator >& Validator ) throw (::com::sun::star::util::VetoException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Reference< ::com::sun::star::form::validation::XValidator > SAL_CALL getValidator( ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XValidityConstraintListener
virtual void SAL_CALL validityConstraintChanged( const ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XValidatableFormComponent
virtual sal_Bool SAL_CALL isValid( ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Any SAL_CALL getCurrentValue( ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL addFormComponentValidityListener( const ::com::sun::star::uno::Reference< ::com::sun::star::form::validation::XFormComponentValidityListener >& Listener ) throw (::com::sun::star::lang::NullPointerException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removeFormComponentValidityListener( const ::com::sun::star::uno::Reference< ::com::sun::star::form::validation::XFormComponentValidityListener >& Listener ) throw (::com::sun::star::lang::NullPointerException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
protected:
// OPropertyChangeListener
virtual void
_propertyChanged( const ::com::sun::star::beans::PropertyChangeEvent& _rEvt ) throw ( ::com::sun::star::uno::RuntimeException ) SAL_OVERRIDE;
/// checks whether we currently have an external value binding in place
inline bool hasExternalValueBinding() const { return m_xExternalBinding.is(); }
// checks whether we currently have an external validator
inline bool hasValidator() const { return m_xValidator.is(); }
/** transfers the very current value of the db column we're bound to the control
@precond
our own mutex is locked
@precond
we don't have an external binding in place
*/
void transferDbValueToControl( );
/** transfers the current value of the active external binding to the control
@precond
we do have an active external binding in place
*/
void transferExternalValueToControl( ControlModelLock& _rInstanceLock );
/** transfers the control value to the external binding
@precond
our own mutex is locked, and _rInstanceLock is the guard locking it
@precond
we do have an active external binding in place
*/
void transferControlValueToExternal( ControlModelLock& _rInstanceLock );
/** calculates the type which is to be used to communicate with the current external binding,
and stores it in m_aExternalValueType
The method checks the possible type candidates as returned by getSupportedBindingTypes,
and the types supported by the current external binding, if any.
*/
void calculateExternalValueType();
/** returns the type which should be used to exchange data with our external value binding
@see initValueProperty
*/
const ::com::sun::star::uno::Type&
getExternalValueType() const { return m_aExternalValueType; }
/** initializes the control from m_xField
Basically, this method calls transferDbValueToControl - but only if our cursor is positioned
on a valid row. Otherwise, the control is reset.
@precond
m_xField is not <NULL/>
*/
void initFromField( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet>& _rxForm );
private:
bool connectToField( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet>& _rxForm );
void resetField();
/** does a new validation of the control value
If necessary, our <member>m_bIsCurrentValueValid</member> member will be adjusted,
and changes will be notified.
Note that it's not necessary that we're connected to a validator. If we are not,
it's assumed that our value is valid, and this is handled appropriately.
Use this method if there is a potential that <b>only</b> the validity flag changed. If
any of the other aspects (our current value, or our current text) changed, then
pass <TRUE/> for <member>_bForceNotification</member>.
@param _bForceNotification
if <TRUE/>, then the validity listeners will be notified, not matter whether the validity
changed.
*/
void recheckValidity( bool _bForceNotification );
/// initializes m_pAggPropMultiplexer
void implInitAggMultiplexer( );
/// initializes listening at the value property
void implInitValuePropertyListening( ) const;
/** adds or removes the component as load listener to/from our form, and (if necessary) as RowSetChange listener at
our parent.
@precond there must no external value binding be in place
*/
void doFormListening( const bool _bStart );
inline bool isFormListening() const { return m_bFormListening; }
/** determines the new value of m_xAmbientForm
*/
void impl_determineAmbientForm_nothrow();
/** connects to a value supplier which is an database column.
The column is take from our parent, which must be a database form respectively row set.
@precond The control does not have an external value supplier
@param _bFromReload
Determines whether the connection is made after the row set has been loaded (<FALSE/>)
or reloaded (<TRUE/>)
@see impl_disconnectDatabaseColumn_noNotify
*/
void impl_connectDatabaseColumn_noNotify(
bool _bFromReload
);
/** disconnects from a value supplier which is an database column
@precond The control does not have an external value supplier
@see impl_connectDatabaseColumn_noNotify
*/
void impl_disconnectDatabaseColumn_noNotify();
/** connects to an external value binding
<p>Note that by definition, external data bindings superseede the SQL data binding which
is defined by our RowSet-column-related properties. This means that in case we're currently
connected to a database column when this is called, this connection is suspended.</p>
@precond
the new external binding has already been approved (see <member>impl_approveValueBinding_nolock</member>)
@precond
there currently is no external binding in place
*/
void connectExternalValueBinding(
const ::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XValueBinding >& _rxBinding,
ControlModelLock& _rInstanceLock
);
/** disconnects from an external value binding
@precond
there currently is an external binding in place
*/
void disconnectExternalValueBinding( );
/** connects the component to an external validator
@precond
there currently is no active validator
@precond
our mutex is currently locked exactly once
*/
void connectValidator(
const ::com::sun::star::uno::Reference< ::com::sun::star::form::validation::XValidator >& _rxValidator
);
/** disconnects the component from its current an external validator
@precond
there currently is an active validator
@precond
our mutex is currently locked exactly once
*/
void disconnectValidator( );
/** called from within <member scope="com::sun::star:::form::binding">XBindableValue::setValueBinding</member>
to approve the new binding
The default implementation approves the binding if and only if it is not <NULL/>, and supports
the type returned by getExternalValueType.
@param _rxBinding
the binding which applies for being responsible for our value, Must not be
<NULL/>
@return
<TRUE/> if and only if the given binding can supply values in the proper type
@seealso getExternalValueType
*/
bool impl_approveValueBinding_nolock(
const ::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XValueBinding >& _rxBinding
);
};
//= inlines
inline void ControlModelLock::acquire()
{
m_rModel.lockInstance( OControlModel::LockAccess() );
m_bLocked = true;
}
inline void ControlModelLock::release()
{
OSL_ENSURE( m_bLocked, "ControlModelLock::release: not locked!" );
m_bLocked = false;
if ( 0 == m_rModel.unlockInstance( OControlModel::LockAccess() ) )
impl_notifyAll_nothrow();
}
}
#endif // INCLUDED_FORMS_SOURCE_INC_FORMCOMPONENT_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|