1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
|
/* -*- 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_VCL_WINDOW_HXX
#define INCLUDED_VCL_WINDOW_HXX
#include <tools/solar.h>
#include <vcl/dllapi.h>
#include <vcl/outdev.hxx>
#include <tools/link.hxx>
#include <tools/wintypes.hxx>
#include <vcl/vclenum.hxx>
#include <vcl/keycodes.hxx>
#include <vcl/region.hxx>
#include <vcl/uitest/factory.hxx>
#include <vcl/IDialogRenderable.hxx>
#include <rtl/ustring.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <memory>
#include <boost/property_tree/ptree_fwd.hpp>
class VirtualDevice;
struct ImplSVEvent;
struct ImplWinData;
struct ImplFrameData;
struct ImplCalcToTopData;
struct SystemEnvData;
struct SystemParentData;
class ImplBorderWindow;
class Timer;
class DockingManager;
class ScrollBar;
class FixedText;
class MouseEvent;
class KeyEvent;
class CommandEvent;
class TrackingEvent;
class HelpEvent;
class DataChangedEvent;
class VclSimpleEvent;
class NotifyEvent;
class SystemWindow;
class SalFrame;
class MenuFloatingWindow;
class VCLXWindow;
class VclWindowEvent;
class AllSettings;
class InputContext;
enum class ImplPaintFlags;
enum class VclEventId;
enum class PointerStyle;
namespace com::sun::star {
namespace accessibility {
struct AccessibleRelation;
class XAccessible;
}
namespace rendering {
class XCanvas;
class XSpriteCanvas;
}
namespace awt {
class XWindowPeer;
}
namespace uno {
class Any;
}
namespace datatransfer::clipboard {
class XClipboard;
}
namespace datatransfer::dnd {
class XDragGestureRecognizer;
class XDragSource;
class XDropTarget;
}
}
namespace vcl {
struct ControlLayoutData;
}
namespace svt { class PopupWindowControllerImpl; }
namespace weld { class Window; }
template<class T> class VclPtr;
enum class TrackingEventFlags
{
NONE = 0x0000,
Cancel = 0x0001,
Key = 0x0002,
Focus = 0x0004,
Repeat = 0x0100,
End = 0x1000,
};
namespace o3tl
{
template<> struct typed_flags<TrackingEventFlags> : is_typed_flags<TrackingEventFlags, 0x1107> {};
}
// Type for GetWindow()
enum class GetWindowType
{
Parent = 0,
FirstChild = 1,
LastChild = 2,
Prev = 3,
Next = 4,
FirstOverlap = 5,
Overlap = 7,
ParentOverlap = 8,
Client = 9,
RealParent = 10,
Frame = 11,
Border = 12,
FirstTopWindowChild = 13,
NextTopWindowSibling = 16,
};
// Flags for setPosSizePixel()
// These must match the definitions in css::awt::PosSize
enum class PosSizeFlags
{
NONE = 0x0000,
X = 0x0001,
Y = 0x0002,
Width = 0x0004,
Height = 0x0008,
Pos = X | Y,
Size = Width | Height,
PosSize = Pos | Size,
All = PosSize,
};
namespace o3tl
{
template<> struct typed_flags<PosSizeFlags> : is_typed_flags<PosSizeFlags, 0x000f> {};
}
// Flags for Show()
enum class ShowFlags
{
NONE = 0x0000,
NoFocusChange = 0x0002,
NoActivate = 0x0004,
ForegroundTask = 0x0008,
};
namespace o3tl
{
template<> struct typed_flags<ShowFlags> : is_typed_flags<ShowFlags, 0x000e> {};
}
// Flags for SetZOrder()
enum class ZOrderFlags
{
NONE = 0x0000,
Before = 0x0001,
Behind = 0x0002,
First = 0x0004,
Last = 0x0008,
};
namespace o3tl
{
template<> struct typed_flags<ZOrderFlags> : is_typed_flags<ZOrderFlags, 0x000f> {};
}
// Activate-Flags
enum class ActivateModeFlags
{
NONE = 0,
GrabFocus = 0x0001,
};
namespace o3tl
{
template<> struct typed_flags<ActivateModeFlags> : is_typed_flags<ActivateModeFlags, 0x0001> {};
}
// ToTop-Flags
enum class ToTopFlags
{
NONE = 0x0000,
RestoreWhenMin = 0x0001,
ForegroundTask = 0x0002,
NoGrabFocus = 0x0004,
GrabFocusOnly = 0x0008,
};
namespace o3tl
{
template<> struct typed_flags<ToTopFlags> : is_typed_flags<ToTopFlags, 0x000f> {};
}
// Flags for Invalidate
// must match css::awt::InvalidateStyle
enum class InvalidateFlags
{
NONE = 0x0000,
Children = 0x0001,
NoChildren = 0x0002,
NoErase = 0x0004,
Update = 0x0008,
Transparent = 0x0010,
NoTransparent = 0x0020,
NoClipChildren = 0x4000,
};
namespace o3tl
{
template<> struct typed_flags<InvalidateFlags> : is_typed_flags<InvalidateFlags, 0x403f> {};
}
// Flags for Validate
enum class ValidateFlags
{
NONE = 0x0000,
Children = 0x0001,
NoChildren = 0x0002
};
namespace o3tl
{
template<> struct typed_flags<ValidateFlags> : is_typed_flags<ValidateFlags, 0x0003> {};
}
// Flags for Scroll
enum class ScrollFlags
{
NONE = 0x0000,
Clip = 0x0001,
Children = 0x0002,
NoChildren = 0x0004,
UseClipRegion = 0x0008,
Update = 0x0010,
};
namespace o3tl
{
template<> struct typed_flags<ScrollFlags> : is_typed_flags<ScrollFlags, 0x001f> {};
}
// Flags for ParentClipMode
enum class ParentClipMode
{
NONE = 0x0000,
Clip = 0x0001,
NoClip = 0x0002,
};
namespace o3tl
{
template<> struct typed_flags<ParentClipMode> : is_typed_flags<ParentClipMode, 0x0003> {};
}
// Flags for ShowTracking()
enum class ShowTrackFlags {
NONE = 0x0000,
Small = 0x0001,
Big = 0x0002,
Split = 0x0003,
Object = 0x0004,
StyleMask = 0x000F,
TrackWindow = 0x1000,
Clip = 0x2000,
};
namespace o3tl
{
template<> struct typed_flags<ShowTrackFlags> : is_typed_flags<ShowTrackFlags, 0x300f> {};
}
// Flags for StartTracking()
enum class StartTrackingFlags
{
NONE = 0x0001,
KeyMod = 0x0002,
ScrollRepeat = 0x0004,
ButtonRepeat = 0x0008,
};
namespace o3tl
{
template<> struct typed_flags<StartTrackingFlags> : is_typed_flags<StartTrackingFlags, 0x000f> {};
}
// Flags for StartAutoScroll()
enum class StartAutoScrollFlags
{
NONE = 0x0000,
Vert = 0x0001,
Horz = 0x0002,
};
namespace o3tl
{
template<> struct typed_flags<StartAutoScrollFlags> : is_typed_flags<StartAutoScrollFlags, 0x0003> {};
}
// Flags for StateChanged()
enum class StateChangedType : sal_uInt16
{
InitShow = 1,
Visible = 2,
UpdateMode = 3,
Enable = 4,
Text = 5,
Data = 7,
State = 8,
Style = 9,
Zoom = 10,
ControlFont = 13,
ControlForeground = 14,
ControlBackground = 15,
ReadOnly = 16,
Mirroring = 18,
Layout = 19,
ControlFocus = 20
};
// GetFocusFlags
// must match constants in css:awt::FocusChangeReason
enum class GetFocusFlags
{
NONE = 0x0000,
Tab = 0x0001,
CURSOR = 0x0002, // avoid name-clash with X11 #define
Mnemonic = 0x0004,
F6 = 0x0008,
Forward = 0x0010,
Backward = 0x0020,
Around = 0x0040,
UniqueMnemonic = 0x0100,
Init = 0x0200,
FloatWinPopupModeEndCancel = 0x0400,
};
namespace o3tl
{
template<> struct typed_flags<GetFocusFlags> : is_typed_flags<GetFocusFlags, 0x077f> {};
}
// Flags for Draw()
enum class DrawFlags
{
NONE = 0x0000,
Mono = 0x0001,
NoControls = 0x0004,
};
namespace o3tl
{
template<> struct typed_flags<DrawFlags> : is_typed_flags<DrawFlags, 0x0005> {};
}
// DialogControl-Flags
enum class DialogControlFlags
{
NONE = 0x0000,
Return = 0x0001,
WantFocus = 0x0002,
FloatWinPopupModeEndCancel = 0x0004,
};
namespace o3tl
{
template<> struct typed_flags<DialogControlFlags> : is_typed_flags<DialogControlFlags, 0x0007> {};
}
// EndExtTextInput() Flags
enum class EndExtTextInputFlags
{
NONE = 0x0000,
Complete = 0x0001
};
namespace o3tl
{
template<> struct typed_flags<EndExtTextInputFlags> : is_typed_flags<EndExtTextInputFlags, 0x0001> {};
}
#define IMPL_MINSIZE_BUTTON_WIDTH 70
#define IMPL_MINSIZE_BUTTON_HEIGHT 22
#define IMPL_EXTRA_BUTTON_WIDTH 18
#define IMPL_EXTRA_BUTTON_HEIGHT 10
#define IMPL_SEP_BUTTON_X 5
#define IMPL_SEP_BUTTON_Y 5
#define IMPL_MINSIZE_MSGBOX_WIDTH 150
#define IMPL_DIALOG_OFFSET 5
#define IMPL_DIALOG_BAR_OFFSET 3
#define IMPL_MSGBOX_OFFSET_EXTRA_X 0
#define IMPL_MSGBOX_OFFSET_EXTRA_Y 2
#define IMPL_SEP_MSGBOX_IMAGE 8
// ImplGetDlgWindow()
enum class GetDlgWindowType
{
Prev, Next, First
};
#ifdef DBG_UTIL
const char* ImplDbgCheckWindow( const void* pObj );
#endif
namespace vcl { class Window; }
namespace vcl { class Cursor; }
class Dialog;
class WindowImpl;
class PaintHelper;
class VclSizeGroup;
class Application;
class WorkWindow;
class MessBox;
class MessageDialog;
class DockingWindow;
class FloatingWindow;
class GroupBox;
class PushButton;
class RadioButton;
class SystemChildWindow;
class ImplDockingWindowWrapper;
class ImplPopupFloatWin;
class LifecycleTest;
enum class WindowHitTest {
NONE = 0x0000,
Inside = 0x0001,
Transparent = 0x0002
};
namespace o3tl {
template<> struct typed_flags<WindowHitTest> : is_typed_flags<WindowHitTest, 0x0003> {};
};
enum class WindowExtendedStyle {
NONE = 0x0000,
Document = 0x0001,
DocModified = 0x0002,
/**
* This is a frame window that is requested to be hidden (not just "not yet
* shown").
*/
DocHidden = 0x0004,
};
namespace o3tl {
template<> struct typed_flags<WindowExtendedStyle> : is_typed_flags<WindowExtendedStyle, 0x0007> {};
};
namespace vcl {
class VCL_DLLPUBLIC RenderTools
{
public:
// transparent background for selected or checked items in toolboxes etc.
// + selection Color with a text color complementing the selection background
// + rounded edge
static void DrawSelectionBackground(vcl::RenderContext& rRenderContext, vcl::Window const & rWindow,
const tools::Rectangle& rRect, sal_uInt16 nHighlight,
bool bChecked, bool bDrawBorder, bool bDrawExtBorderOnly,
Color* pSelectionTextColor = nullptr, long nCornerRadius = 0,
Color const * pPaintColor = nullptr);
};
class VCL_DLLPUBLIC Window : public ::OutputDevice
{
friend class ::vcl::Cursor;
friend class ::OutputDevice;
friend class ::Application;
friend class ::SystemWindow;
friend class ::WorkWindow;
friend class ::Dialog;
friend class ::MessBox;
friend class ::MessageDialog;
friend class ::DockingWindow;
friend class ::FloatingWindow;
friend class ::GroupBox;
friend class ::PushButton;
friend class ::RadioButton;
friend class ::SystemChildWindow;
friend class ::ImplBorderWindow;
friend class ::PaintHelper;
friend class ::LifecycleTest;
// TODO: improve missing functionality
// only required because of SetFloatingMode()
friend class ::ImplDockingWindowWrapper;
friend class ::ImplPopupFloatWin;
friend class ::MenuFloatingWindow;
friend class ::svt::PopupWindowControllerImpl;
private:
// NOTE: to remove many dependencies of other modules
// to this central file, all members are now hidden
// in the WindowImpl class and all inline functions
// were removed.
// (WindowImpl is a pImpl pattern)
// Please do *not* add new members or inline functions to class Window,
// but use class WindowImpl instead
std::unique_ptr<WindowImpl> mpWindowImpl;
#ifdef DBG_UTIL
friend const char* ::ImplDbgCheckWindow( const void* pObj );
#endif
public:
DECL_DLLPRIVATE_LINK( ImplHandlePaintHdl, Timer*, void );
DECL_DLLPRIVATE_LINK( ImplGenerateMouseMoveHdl, void*, void );
DECL_DLLPRIVATE_LINK( ImplTrackTimerHdl, Timer*, void );
DECL_DLLPRIVATE_LINK( ImplAsyncFocusHdl, void*, void );
DECL_DLLPRIVATE_LINK( ImplHandleResizeTimerHdl, Timer*, void );
SAL_DLLPRIVATE static void ImplInitAppFontData( vcl::Window const * pWindow );
SAL_DLLPRIVATE vcl::Window* ImplGetFrameWindow() const;
weld::Window* GetFrameWeld() const;
vcl::Window* GetFrameWindow() const;
SalFrame* ImplGetFrame() const;
SAL_DLLPRIVATE ImplFrameData* ImplGetFrameData();
vcl::Window* ImplGetWindow() const; ///< if this is a proxy return the client, otherwise itself
SAL_DLLPRIVATE ImplWinData* ImplGetWinData() const;
SAL_DLLPRIVATE vcl::Window* ImplGetClientWindow() const;
SAL_DLLPRIVATE vcl::Window* ImplGetDlgWindow( sal_uInt16 n, GetDlgWindowType nType, sal_uInt16 nStart = 0, sal_uInt16 nEnd = 0xFFFF, sal_uInt16* pIndex = nullptr );
SAL_DLLPRIVATE vcl::Window* ImplGetParent() const;
SAL_DLLPRIVATE vcl::Window* ImplFindWindow( const Point& rFramePos );
SAL_DLLPRIVATE void ImplInvalidateFrameRegion( const vcl::Region* pRegion, InvalidateFlags nFlags );
SAL_DLLPRIVATE void ImplInvalidateOverlapFrameRegion( const vcl::Region& rRegion );
SAL_DLLPRIVATE bool ImplSetClipFlag( bool bSysObjOnlySmaller = false );
SAL_DLLPRIVATE bool ImplIsWindowOrChild( const vcl::Window* pWindow, bool bSystemWindow = false ) const;
SAL_DLLPRIVATE bool ImplIsChild( const vcl::Window* pWindow, bool bSystemWindow = false ) const;
SAL_DLLPRIVATE bool ImplIsFloatingWindow() const;
SAL_DLLPRIVATE bool ImplIsPushButton() const;
SAL_DLLPRIVATE bool ImplIsSplitter() const;
SAL_DLLPRIVATE bool ImplIsOverlapWindow() const;
SAL_DLLPRIVATE void ImplIsInTaskPaneList( bool mbIsInTaskList );
SAL_DLLPRIVATE WindowImpl* ImplGetWindowImpl() const { return mpWindowImpl.get(); }
SAL_DLLPRIVATE Point ImplFrameToOutput( const Point& rPos );
SAL_DLLPRIVATE void ImplGrabFocus( GetFocusFlags nFlags );
SAL_DLLPRIVATE void ImplGrabFocusToDocument( GetFocusFlags nFlags );
SAL_DLLPRIVATE void ImplInvertFocus( const tools::Rectangle& rRect );
SAL_DLLPRIVATE PointerStyle ImplGetMousePointer() const;
SAL_DLLPRIVATE void ImplCallMouseMove( sal_uInt16 nMouseCode, bool bModChanged = false );
SAL_DLLPRIVATE void ImplGenerateMouseMove();
SAL_DLLPRIVATE void ImplNotifyKeyMouseCommandEventListeners( NotifyEvent& rNEvt );
SAL_DLLPRIVATE void ImplNotifyIconifiedState( bool bIconified );
SAL_DLLPRIVATE void ImplUpdateAll();
SAL_DLLPRIVATE void ImplControlFocus( GetFocusFlags nFlags = GetFocusFlags::NONE );
SAL_DLLPRIVATE void ImplMirrorFramePos( Point &pt ) const;
SAL_DLLPRIVATE void ImplPosSizeWindow( long nX, long nY, long nWidth, long nHeight, PosSizeFlags nFlags );
SAL_DLLPRIVATE void ImplCallResize();
SAL_DLLPRIVATE void ImplCallMove();
void IncModalCount();
void DecModalCount();
SAL_DLLPRIVATE static void ImplCalcSymbolRect( tools::Rectangle& rRect );
protected:
/** This is intended to be used to clear any locally held references to other Window-subclass objects */
virtual void dispose() override;
SAL_DLLPRIVATE void ImplInit( vcl::Window* pParent, WinBits nStyle, SystemParentData* pSystemParentData );
SAL_DLLPRIVATE Point ImplOutputToFrame( const Point& rPos );
SAL_DLLPRIVATE void ImplInvalidateParentFrameRegion( vcl::Region& rRegion );
SAL_DLLPRIVATE void ImplValidateFrameRegion( const vcl::Region* rRegion, ValidateFlags nFlags );
SAL_DLLPRIVATE void ImplValidate();
SAL_DLLPRIVATE void ImplMoveInvalidateRegion( const tools::Rectangle& rRect, long nHorzScroll, long nVertScroll, bool bChildren );
SAL_DLLPRIVATE void ImplMoveAllInvalidateRegions( const tools::Rectangle& rRect, long nHorzScroll, long nVertScroll, bool bChildren );
SAL_DLLPRIVATE vcl::Window* ImplGetBorderWindow() const;
SAL_DLLPRIVATE void ImplInvalidate( const vcl::Region* rRegion, InvalidateFlags nFlags );
virtual WindowHitTest ImplHitTest( const Point& rFramePos );
SAL_DLLPRIVATE void ImplSetMouseTransparent( bool bTransparent );
SAL_DLLPRIVATE void ImplScroll( const tools::Rectangle& rRect, long nHorzScroll, long nVertScroll, ScrollFlags nFlags );
SAL_DLLPRIVATE bool ImplSetClipFlagChildren( bool bSysObjOnlySmaller );
SAL_DLLPRIVATE bool ImplSetClipFlagOverlapWindows( bool bSysObjOnlySmaller = false );
SAL_DLLPRIVATE void PushPaintHelper(PaintHelper* pHelper, vcl::RenderContext& rRenderContext);
SAL_DLLPRIVATE void PopPaintHelper(PaintHelper const * pHelper);
private:
SAL_DLLPRIVATE void ImplSetFrameParent( const vcl::Window* pParent );
SAL_DLLPRIVATE void ImplInsertWindow( vcl::Window* pParent );
SAL_DLLPRIVATE void ImplRemoveWindow( bool bRemoveFrameData );
SAL_DLLPRIVATE SalGraphics* ImplGetFrameGraphics() const;
SAL_DLLPRIVATE static void ImplCallFocusChangeActivate( vcl::Window* pNewOverlapWindow, vcl::Window* pOldOverlapWindow );
SAL_DLLPRIVATE vcl::Window* ImplGetFirstOverlapWindow();
SAL_DLLPRIVATE const vcl::Window* ImplGetFirstOverlapWindow() const;
SAL_DLLPRIVATE bool ImplIsRealParentPath( const vcl::Window* pWindow ) const;
SAL_DLLPRIVATE bool ImplTestMousePointerSet();
SAL_DLLPRIVATE void ImplResetReallyVisible();
SAL_DLLPRIVATE void ImplSetReallyVisible();
SAL_DLLPRIVATE void ImplCallInitShow();
SAL_DLLPRIVATE void ImplInitResolutionSettings();
SAL_DLLPRIVATE void ImplPointToLogic(vcl::RenderContext const & rRenderContext, vcl::Font& rFont) const;
SAL_DLLPRIVATE void ImplLogicToPoint(vcl::RenderContext const & rRenderContext, vcl::Font& rFont) const;
SAL_DLLPRIVATE bool ImplSysObjClip( const vcl::Region* pOldRegion );
SAL_DLLPRIVATE void ImplUpdateSysObjChildrenClip();
SAL_DLLPRIVATE void ImplUpdateSysObjOverlapsClip();
SAL_DLLPRIVATE void ImplUpdateSysObjClip();
SAL_DLLPRIVATE void ImplIntersectWindowClipRegion( vcl::Region& rRegion );
SAL_DLLPRIVATE void ImplIntersectWindowRegion( vcl::Region& rRegion );
SAL_DLLPRIVATE void ImplExcludeWindowRegion( vcl::Region& rRegion );
SAL_DLLPRIVATE void ImplExcludeOverlapWindows( vcl::Region& rRegion ) const;
SAL_DLLPRIVATE void ImplExcludeOverlapWindows2( vcl::Region& rRegion );
SAL_DLLPRIVATE void ImplClipBoundaries( vcl::Region& rRegion, bool bThis, bool bOverlaps );
SAL_DLLPRIVATE bool ImplClipChildren( vcl::Region& rRegion ) const;
SAL_DLLPRIVATE void ImplClipAllChildren( vcl::Region& rRegion ) const;
SAL_DLLPRIVATE void ImplClipSiblings( vcl::Region& rRegion ) const;
SAL_DLLPRIVATE void ImplInitWinClipRegion();
SAL_DLLPRIVATE void ImplInitWinChildClipRegion();
SAL_DLLPRIVATE vcl::Region* ImplGetWinChildClipRegion();
SAL_DLLPRIVATE void ImplIntersectAndUnionOverlapWindows( const vcl::Region& rInterRegion, vcl::Region& rRegion ) const;
SAL_DLLPRIVATE void ImplIntersectAndUnionOverlapWindows2( const vcl::Region& rInterRegion, vcl::Region& rRegion );
SAL_DLLPRIVATE void ImplCalcOverlapRegionOverlaps( const vcl::Region& rInterRegion, vcl::Region& rRegion ) const;
SAL_DLLPRIVATE void ImplCalcOverlapRegion( const tools::Rectangle& rSourceRect, vcl::Region& rRegion,
bool bChildren, bool bSiblings );
/** Invoke the actual painting.
This function is kind of recursive - it may be called from the
PaintHelper destructor; and on the other hand it creates PaintHelper
that (when destructed) calls other ImplCallPaint()'s.
*/
SAL_DLLPRIVATE void ImplCallPaint(const vcl::Region* pRegion, ImplPaintFlags nPaintFlags);
SAL_DLLPRIVATE void ImplCallOverlapPaint();
SAL_DLLPRIVATE void ImplUpdateWindowPtr( vcl::Window* pWindow );
SAL_DLLPRIVATE void ImplUpdateWindowPtr();
SAL_DLLPRIVATE void ImplUpdateOverlapWindowPtr( bool bNewFrame );
SAL_DLLPRIVATE bool ImplUpdatePos();
SAL_DLLPRIVATE void ImplUpdateSysObjPos();
SAL_DLLPRIVATE void ImplUpdateGlobalSettings( AllSettings& rSettings, bool bCallHdl = true ) const;
SAL_DLLPRIVATE void ImplToBottomChild();
SAL_DLLPRIVATE void ImplCalcToTop( ImplCalcToTopData* pPrevData );
SAL_DLLPRIVATE void ImplToTop( ToTopFlags nFlags );
SAL_DLLPRIVATE void ImplStartToTop( ToTopFlags nFlags );
SAL_DLLPRIVATE void ImplFocusToTop( ToTopFlags nFlags, bool bReallyVisible );
SAL_DLLPRIVATE void ImplShowAllOverlaps();
SAL_DLLPRIVATE void ImplHideAllOverlaps();
SAL_DLLPRIVATE bool ImplDlgCtrl( const KeyEvent& rKEvt, bool bKeyInput );
SAL_DLLPRIVATE bool ImplHasDlgCtrl() const;
SAL_DLLPRIVATE void ImplDlgCtrlNextWindow();
SAL_DLLPRIVATE void ImplDlgCtrlFocusChanged( vcl::Window* pWindow, bool bGetFocus );
SAL_DLLPRIVATE vcl::Window* ImplFindDlgCtrlWindow( vcl::Window* pWindow );
SAL_DLLPRIVATE static void ImplNewInputContext();
SAL_DLLPRIVATE void ImplCallActivateListeners(vcl::Window*);
SAL_DLLPRIVATE void ImplCallDeactivateListeners(vcl::Window*);
SAL_DLLPRIVATE static void ImplHandleScroll(ScrollBar* pHScrl, double nX, ScrollBar* pVScrl, double nY);
SAL_DLLPRIVATE tools::Rectangle ImplOutputToUnmirroredAbsoluteScreenPixel( const tools::Rectangle& rRect ) const;
SAL_DLLPRIVATE long ImplGetUnmirroredOutOffX();
// retrieves the list of owner draw decorated windows for this window hierarchy
SAL_DLLPRIVATE ::std::vector<VclPtr<vcl::Window> >& ImplGetOwnerDrawList();
SAL_DLLPRIVATE vcl::Window* ImplGetTopmostFrameWindow();
SAL_DLLPRIVATE tools::Rectangle ImplGetWindowExtentsRelative( vcl::Window *pRelativeWindow ) const;
SAL_DLLPRIVATE bool ImplStopDnd();
SAL_DLLPRIVATE void ImplStartDnd();
SAL_DLLPRIVATE void ImplPaintToDevice( ::OutputDevice* pTargetOutDev, const Point& rPos );
SAL_DLLPRIVATE css::uno::Reference< css::rendering::XCanvas >
ImplGetCanvas( bool bSpriteCanvas ) const;
public:
virtual vcl::Region GetActiveClipRegion() const override;
virtual vcl::Region GetOutputBoundsClipRegion() const override;
protected:
// Single argument ctors shall be explicit.
explicit Window( WindowType nType );
void SetCompoundControl( bool bCompound );
void CallEventListeners( VclEventId nEvent, void* pData = nullptr );
static void FireVclEvent( VclSimpleEvent& rEvent );
virtual bool AcquireGraphics() const override;
virtual void ReleaseGraphics( bool bRelease = true ) override;
virtual void InitClipRegion() override;
void ImplClearFontData(bool bNewFontLists) override;
void ImplRefreshFontData(bool bNewFontLists) override;
void ImplInitMapModeObjects() override;
// FIXME: this is a hack to workaround missing layout functionality
virtual void ImplAdjustNWFSizes();
virtual void CopyDeviceArea( SalTwoRect& aPosAry, bool bWindowInvalidate) override;
virtual const OutputDevice* DrawOutDevDirectCheck(const OutputDevice* pSrcDev) const override;
virtual void DrawOutDevDirectProcess( const OutputDevice* pSrcDev, SalTwoRect& rPosAry, SalGraphics* pSrcGraphics ) override;
virtual void ClipToPaintRegion( tools::Rectangle& rDstRect ) override;
virtual bool UsePolyPolygonForComplexGradient() override;
virtual void ApplySettings(vcl::RenderContext& rRenderContext);
public:
bool HasMirroredGraphics() const override;
public:
// Single argument ctors shall be explicit.
explicit Window( vcl::Window* pParent, WinBits nStyle = 0 );
virtual ~Window() override;
::OutputDevice const* GetOutDev() const;
::OutputDevice* GetOutDev();
Color GetBackgroundColor() const override;
virtual void EnableRTL ( bool bEnable = true ) override;
virtual void MouseMove( const MouseEvent& rMEvt );
virtual void MouseButtonDown( const MouseEvent& rMEvt );
virtual void MouseButtonUp( const MouseEvent& rMEvt );
virtual void KeyInput( const KeyEvent& rKEvt );
virtual void KeyUp( const KeyEvent& rKEvt );
virtual void PrePaint(vcl::RenderContext& rRenderContext);
virtual void Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect);
virtual void PostPaint(vcl::RenderContext& rRenderContext);
using OutputDevice::Erase;
void Erase(vcl::RenderContext& rRenderContext);
virtual void Draw( ::OutputDevice* pDev, const Point& rPos, DrawFlags nFlags );
virtual void Move();
virtual void Resize();
virtual void Activate();
virtual void Deactivate();
virtual void GetFocus();
virtual void LoseFocus();
virtual void RequestHelp( const HelpEvent& rHEvt );
virtual void Command( const CommandEvent& rCEvt );
virtual void Tracking( const TrackingEvent& rTEvt );
virtual void StateChanged( StateChangedType nStateChange );
virtual void DataChanged( const DataChangedEvent& rDCEvt );
virtual bool PreNotify( NotifyEvent& rNEvt );
virtual bool EventNotify( NotifyEvent& rNEvt );
// These methods call the relevant virtual method when not in/post dispose
void CompatGetFocus();
void CompatLoseFocus();
void CompatStateChanged( StateChangedType nStateChange );
void CompatDataChanged( const DataChangedEvent& rDCEvt );
bool CompatPreNotify( NotifyEvent& rNEvt );
bool CompatNotify( NotifyEvent& rNEvt );
void AddEventListener( const Link<VclWindowEvent&,void>& rEventListener );
void RemoveEventListener( const Link<VclWindowEvent&,void>& rEventListener );
void AddChildEventListener( const Link<VclWindowEvent&,void>& rEventListener );
void RemoveChildEventListener( const Link<VclWindowEvent&,void>& rEventListener );
ImplSVEvent * PostUserEvent( const Link<void*,void>& rLink, void* pCaller = nullptr, bool bReferenceLink = false );
void RemoveUserEvent( ImplSVEvent * nUserEvent );
// returns the input language used for the last key stroke
// may be LANGUAGE_DONTKNOW if not supported by the OS
LanguageType GetInputLanguage() const;
void SetStyle( WinBits nStyle );
WinBits GetStyle() const;
WinBits GetPrevStyle() const;
void SetExtendedStyle( WindowExtendedStyle nExtendedStyle );
WindowExtendedStyle GetExtendedStyle() const;
void SetType( WindowType nType );
WindowType GetType() const;
bool IsSystemWindow() const;
bool IsDockingWindow() const;
bool IsDialog() const;
bool IsMenuFloatingWindow() const;
bool IsToolbarFloatingWindow() const;
bool IsTopWindow() const;
bool IsDisposed() const;
SystemWindow* GetSystemWindow() const;
/// Can the widget derived from this Window do the double-buffering via RenderContext properly?
bool SupportsDoubleBuffering() const;
/// Enable/disable double-buffering of the frame window and all its children.
void RequestDoubleBuffering(bool bRequest);
void EnableAllResize();
void SetBorderStyle( WindowBorderStyle nBorderStyle );
WindowBorderStyle GetBorderStyle() const;
void GetBorder( sal_Int32& rLeftBorder, sal_Int32& rTopBorder,
sal_Int32& rRightBorder, sal_Int32& rBottomBorder ) const;
Size CalcWindowSize( const Size& rOutSz ) const;
Size CalcOutputSize( const Size& rWinSz ) const;
long CalcTitleWidth() const;
void EnableClipSiblings( bool bClipSiblings = true );
void EnableChildTransparentMode( bool bEnable = true );
bool IsChildTransparentModeEnabled() const;
void SetMouseTransparent( bool bTransparent );
bool IsMouseTransparent() const;
void SetPaintTransparent( bool bTransparent );
bool IsPaintTransparent() const;
void SetDialogControlStart( bool bStart );
bool IsDialogControlStart() const;
void SetDialogControlFlags( DialogControlFlags nFlags );
DialogControlFlags GetDialogControlFlags() const;
struct PointerState
{
sal_uLong mnState; // the button state
Point maPos; // mouse position in output coordinates
};
PointerState GetPointerState();
bool IsMouseOver() const;
void SetInputContext( const InputContext& rInputContext );
const InputContext& GetInputContext() const;
void PostExtTextInputEvent(VclEventId nType, const OUString& rText);
void EndExtTextInput();
void SetCursorRect( const tools::Rectangle* pRect = nullptr, long nExtTextInputWidth = 0 );
const tools::Rectangle* GetCursorRect() const;
long GetCursorExtTextInputWidth() const;
void SetCompositionCharRect( const tools::Rectangle* pRect, long nCompositionLength, bool bVertical = false );
using ::OutputDevice::SetSettings;
virtual void SetSettings( const AllSettings& rSettings ) override;
void SetSettings( const AllSettings& rSettings, bool bChild );
void UpdateSettings( const AllSettings& rSettings, bool bChild = false );
void NotifyAllChildren( DataChangedEvent& rDCEvt );
void SetPointFont(vcl::RenderContext& rRenderContext, const vcl::Font& rFont);
vcl::Font GetPointFont(vcl::RenderContext const & rRenderContext) const;
void SetZoomedPointFont(vcl::RenderContext& rRenderContext, const vcl::Font& rFont);
long GetDrawPixel( ::OutputDevice const * pDev, long nPixels ) const;
vcl::Font GetDrawPixelFont( ::OutputDevice const * pDev ) const;
void SetControlFont();
void SetControlFont( const vcl::Font& rFont );
vcl::Font GetControlFont() const;
bool IsControlFont() const;
void ApplyControlFont(vcl::RenderContext& rRenderContext, const vcl::Font& rDefaultFont);
void SetControlForeground();
void SetControlForeground(const Color& rColor);
const Color& GetControlForeground() const;
bool IsControlForeground() const;
void ApplyControlForeground(vcl::RenderContext& rRenderContext, const Color& rDefaultColor);
void SetControlBackground();
void SetControlBackground( const Color& rColor );
const Color& GetControlBackground() const;
bool IsControlBackground() const;
void ApplyControlBackground(vcl::RenderContext& rRenderContext, const Color& rDefaultColor);
void SetParentClipMode( ParentClipMode nMode = ParentClipMode::NONE );
ParentClipMode GetParentClipMode() const;
void SetWindowRegionPixel();
void SetWindowRegionPixel( const vcl::Region& rRegion );
vcl::Region GetWindowClipRegionPixel() const;
vcl::Region GetPaintRegion() const;
bool IsInPaint() const;
// while IsInPaint returns true ExpandPaintClipRegion adds the
// submitted region to the paint clip region so you can
// paint additional parts of your window if necessary
void ExpandPaintClipRegion( const vcl::Region& rRegion );
void SetParent( vcl::Window* pNewParent );
vcl::Window* GetParent() const;
// return the dialog we are contained in or NULL if un-contained
Dialog* GetParentDialog() const;
bool IsAncestorOf( const vcl::Window& rWindow ) const;
void Show( bool bVisible = true, ShowFlags nFlags = ShowFlags::NONE );
void Hide() { Show( false ); }
bool IsVisible() const;
bool IsReallyVisible() const;
bool IsReallyShown() const;
bool IsInInitShow() const;
void Enable( bool bEnable = true, bool bChild = true );
void Disable( bool bChild = true ) { Enable( false, bChild ); }
bool IsEnabled() const;
void EnableInput( bool bEnable = true, bool bChild = true );
void EnableInput( bool bEnable, const vcl::Window* pExcludeWindow );
bool IsInputEnabled() const;
/** Override <code>EnableInput</code>. This can be necessary due to other people
using EnableInput for whole window hierarchies.
<code>AlwaysEnableInput</code> and <code>AlwaysDisableInput</code> are
mutually exclusive; the last setter wins.
@param bAlways
sets always enabled flag
@param bChild
if true children are recursively set to AlwaysEnableInput
*/
void AlwaysEnableInput( bool bAlways, bool bChild = true );
/** returns the current AlwaysEnableInput state
@return
true if window is in AlwaysEnableInput state
*/
bool IsAlwaysEnableInput() const;
/** Override <code>EnableInput</code>, counterpart to AlwaysEnableInput.
Windows with AlwaysDisableInput will not get key events even if enabled
and input enabled.This can be necessary due to other people using EnableInput
for whole window hierarchies.
<code>AlwaysEnableInput</code> and <code>AlwaysDisableInput</code> are
mutually exclusive; the last setter wins.
@param bAlways
sets always disable flag
@param bChild
if true children are recursively set to AlwaysDisableInput
*/
void AlwaysDisableInput( bool bAlways, bool bChild = true );
/** usually event handlers (see AddEventListener and AddChildEventListener)
are not called on disabled, modal or input disabled windows. There are however rare cases
in which one wants a Window or rather one of its Control subclasses to
not evaluate events but still react to those events externally. In these
rare cases call SetCallHandlersOnInputDisabled( true ) to have your handler
called anyway.
Currently only mouse events get this special treatment.
Use this sparingly, chances are if you want to use it you're working around
the real problem.
@param bCall
Enable/Disable calling event handlers for this disabled, modal or input disabled window.
This call is implicitly done recursively for possible child windows.
*/
void SetCallHandlersOnInputDisabled( bool bCall );
/** get state of SetCallHandlersOnInputDisabled
@returns whether handlers are called regardless of input enabled state
*/
bool IsCallHandlersOnInputDisabled() const;
/** A window is in modal mode if one of its children or subchildren
is a running modal window (a modal dialog)
@returns sal_True if a child or subchild is a running modal window
*/
bool IsInModalMode() const;
void SetActivateMode( ActivateModeFlags nMode );
ActivateModeFlags GetActivateMode() const;
void ToTop( ToTopFlags nFlags = ToTopFlags::NONE );
void SetZOrder( vcl::Window* pRefWindow, ZOrderFlags nFlags );
void EnableAlwaysOnTop( bool bEnable = true );
bool IsAlwaysOnTopEnabled() const;
virtual void setPosSizePixel( long nX, long nY,
long nWidth, long nHeight,
PosSizeFlags nFlags = PosSizeFlags::All );
virtual void SetPosPixel( const Point& rNewPos );
virtual Point GetPosPixel() const;
virtual void SetSizePixel( const Size& rNewSize );
virtual Size GetSizePixel() const;
virtual void SetPosSizePixel( const Point& rNewPos,
const Size& rNewSize );
virtual void SetOutputSizePixel( const Size& rNewSize );
bool IsDefaultPos() const;
bool IsDefaultSize() const;
Point GetOffsetPixelFrom(const vcl::Window& rWindow) const;
// those conversion routines might deliver different results during UI mirroring
Point OutputToScreenPixel( const Point& rPos ) const;
Point ScreenToOutputPixel( const Point& rPos ) const;
// the normalized screen methods work independent from UI mirroring
Point OutputToNormalizedScreenPixel( const Point& rPos ) const;
Point NormalizedScreenToOutputPixel( const Point& rPos ) const;
Point OutputToAbsoluteScreenPixel( const Point& rPos ) const;
Point AbsoluteScreenToOutputPixel( const Point& rPos ) const;
tools::Rectangle GetDesktopRectPixel() const;
// window extents including border and decoration
tools::Rectangle GetWindowExtentsRelative( vcl::Window *pRelativeWindow ) const;
bool IsScrollable() const;
virtual void Scroll( long nHorzScroll, long nVertScroll,
ScrollFlags nFlags = ScrollFlags::NONE );
void Scroll( long nHorzScroll, long nVertScroll,
const tools::Rectangle& rRect, ScrollFlags nFlags = ScrollFlags::NONE );
virtual void Invalidate( InvalidateFlags nFlags = InvalidateFlags::NONE );
virtual void Invalidate( const tools::Rectangle& rRect, InvalidateFlags nFlags = InvalidateFlags::NONE );
virtual void Invalidate( const vcl::Region& rRegion, InvalidateFlags nFlags = InvalidateFlags::NONE );
/**
* Notification about some rectangle of the output device got invalidated.Used for the main
* document window.
*
* @param pRectangle If 0, that means the whole area, otherwise the area in logic coordinates.
*/
virtual void LogicInvalidate(const tools::Rectangle* pRectangle);
/**
* Notification about some rectangle of the output device got invalidated. Used for the
* dialogs and floating windows (e.g. context menu, popup).
*
* @param pRectangle If 0, that means the whole area, otherwise the area in pixel coordinates.
*/
virtual void PixelInvalidate(const tools::Rectangle* pRectangle);
void Validate();
bool HasPaintEvent() const;
void PaintImmediately();
void Flush() override;
// toggles new docking support, enabled via toolkit
void EnableDocking( bool bEnable = true );
// retrieves the single dockingmanager instance
static DockingManager* GetDockingManager();
void EnablePaint( bool bEnable );
bool IsPaintEnabled() const;
void SetUpdateMode( bool bUpdate );
bool IsUpdateMode() const;
void SetParentUpdateMode( bool bUpdate );
void GrabFocus();
bool HasFocus() const;
bool HasChildPathFocus( bool bSystemWindow = false ) const;
bool IsActive() const;
bool HasActiveChildFrame() const;
GetFocusFlags GetGetFocusFlags() const;
void GrabFocusToDocument();
VclPtr<vcl::Window> GetFocusedWindow() const;
/**
* Set this when you need to act as if the window has focus even if it
* doesn't. This is necessary for implementing tab stops inside floating
* windows, but floating windows don't get focus from the system.
*/
void SetFakeFocus( bool bFocus );
bool IsCompoundControl() const;
static VclPtr<vcl::Window> SaveFocus();
static void EndSaveFocus(const VclPtr<vcl::Window>& xFocusWin);
void CaptureMouse();
void ReleaseMouse();
bool IsMouseCaptured() const;
void SetPointer( PointerStyle );
PointerStyle GetPointer() const;
void EnableChildPointerOverwrite( bool bOverwrite );
void SetPointerPosPixel( const Point& rPos );
Point GetPointerPosPixel();
Point GetLastPointerPosPixel();
/// Similar to SetPointerPosPixel(), but sets the frame data's last mouse position instead.
void SetLastMousePos(const Point& rPos);
void ShowPointer( bool bVisible );
void EnterWait();
void LeaveWait();
bool IsWait() const;
void SetCursor( vcl::Cursor* pCursor );
vcl::Cursor* GetCursor() const;
void SetZoom( const Fraction& rZoom );
const Fraction& GetZoom() const;
bool IsZoom() const;
long CalcZoom( long n ) const;
virtual void SetText( const OUString& rStr );
virtual OUString GetText() const;
// return the actual text displayed
// this may have e.g. accelerators removed or portions
// replaced by ellipses
virtual OUString GetDisplayText() const;
// gets the visible background color. for transparent windows
// this may be the parent's background color; for controls
// this may be a child's background color (e.g. ListBox)
virtual const Wallpaper& GetDisplayBackground() const;
void SetHelpText( const OUString& rHelpText );
const OUString& GetHelpText() const;
void SetQuickHelpText( const OUString& rHelpText );
const OUString& GetQuickHelpText() const;
void SetHelpId( const OString& );
const OString& GetHelpId() const;
vcl::Window* FindWindow( const Point& rPos ) const;
sal_uInt16 GetChildCount() const;
vcl::Window* GetChild( sal_uInt16 nChild ) const;
vcl::Window* GetWindow( GetWindowType nType ) const;
bool IsChild( const vcl::Window* pWindow ) const;
bool IsWindowOrChild( const vcl::Window* pWindow, bool bSystemWindow = false ) const;
/// Add all children to rAllChildren recursively.
SAL_DLLPRIVATE void CollectChildren(::std::vector<vcl::Window *>& rAllChildren );
virtual void ShowFocus(const tools::Rectangle& rRect);
void HideFocus();
// transparent background for selected or checked items in toolboxes etc.
void DrawSelectionBackground( const tools::Rectangle& rRect, sal_uInt16 highlight, bool bChecked, bool bDrawBorder );
void ShowTracking( const tools::Rectangle& rRect,
ShowTrackFlags nFlags = ShowTrackFlags::Small );
void HideTracking();
void InvertTracking( const tools::Rectangle& rRect, ShowTrackFlags nFlags );
void StartTracking( StartTrackingFlags nFlags = StartTrackingFlags::NONE );
void EndTracking( TrackingEventFlags nFlags = TrackingEventFlags::NONE );
bool IsTracking() const;
void StartAutoScroll( StartAutoScrollFlags nFlags );
void EndAutoScroll();
bool HandleScrollCommand( const CommandEvent& rCmd,
ScrollBar* pHScrl,
ScrollBar* pVScrl );
void SaveBackground(VirtualDevice& rSaveDevice,
const Point& rPos, const Size& rSize, const Size&) const override;
virtual const SystemEnvData* GetSystemData() const;
// API to set/query the component interfaces
virtual css::uno::Reference< css::awt::XWindowPeer >
GetComponentInterface( bool bCreate = true );
void SetComponentInterface( css::uno::Reference< css::awt::XWindowPeer > const & xIFace );
/// Interface to register for dialog / window tunneling.
void SetLOKNotifier(const vcl::ILibreOfficeKitNotifier* pNotifier, bool bParent = false);
const vcl::ILibreOfficeKitNotifier* GetLOKNotifier() const;
vcl::LOKWindowId GetLOKWindowId() const;
/// Find the nearest parent with LOK Notifier; can be itself if this Window has LOK notifier set.
VclPtr<vcl::Window> GetParentWithLOKNotifier();
/// Indicate that LOK is not going to use this dialog any more.
void ReleaseLOKNotifier();
/// Find an existing Window based on the LOKWindowId.
static VclPtr<vcl::Window> FindLOKWindow(vcl::LOKWindowId nWindowId);
/// check if LOK Window container is empty
static bool IsLOKWindowsEmpty();
/// Dumps itself and potentially its children to a property tree, to be written easily to JSON.
virtual boost::property_tree::ptree DumpAsPropertyTree();
/// Same as MouseButtonDown(), but coordinates are in logic unit. used for LOK
virtual void LogicMouseButtonDown(const MouseEvent&) {};
/// Same as MouseButtonUp(), but coordinates are in logic unit. used for LOK
virtual void LogicMouseButtonUp(const MouseEvent&) {};
/// Same as MouseMove(), but coordinates are in logic unit. used for LOK
virtual void LogicMouseMove(const MouseEvent&) {};
/** @name Accessibility
*/
///@{
public:
css::uno::Reference< css::accessibility::XAccessible >
GetAccessible( bool bCreate = true );
virtual css::uno::Reference< css::accessibility::XAccessible >
CreateAccessible();
void SetAccessible( const css::uno::Reference< css::accessibility::XAccessible >& );
vcl::Window* GetAccessibleParentWindow() const;
sal_uInt16 GetAccessibleChildWindowCount();
vcl::Window* GetAccessibleChildWindow( sal_uInt16 n );
void SetAccessibleRole( sal_uInt16 nRole );
sal_uInt16 GetAccessibleRole() const;
void SetAccessibleName( const OUString& rName );
OUString GetAccessibleName() const;
void SetAccessibleDescription( const OUString& rDescr );
OUString GetAccessibleDescription() const;
void SetAccessibleRelationLabeledBy( vcl::Window* pLabeledBy );
vcl::Window* GetAccessibleRelationLabeledBy() const;
void SetAccessibleRelationLabelFor( vcl::Window* pLabelFor );
vcl::Window* GetAccessibleRelationLabelFor() const;
void SetAccessibleRelationMemberOf( vcl::Window* pMemberOf );
vcl::Window* GetAccessibleRelationMemberOf() const;
void AddExtraAccessibleRelation(const css::accessibility::AccessibleRelation &rRelation);
const std::vector<css::accessibility::AccessibleRelation>& GetExtraAccessibleRelations() const;
void ClearExtraAccessibleRelations();
// to avoid sending accessibility events in cases like closing dialogs
// by default checks complete parent path
bool IsAccessibilityEventsSuppressed( bool bTraverseParentPath = true );
void SetAccessibilityEventsSuppressed(bool bSuppressed);
KeyEvent GetActivationKey() const;
protected:
// These eventually are supposed to go when everything is converted to .ui
SAL_DLLPRIVATE vcl::Window* getLegacyNonLayoutAccessibleRelationMemberOf() const;
SAL_DLLPRIVATE vcl::Window* getLegacyNonLayoutAccessibleRelationLabeledBy() const;
SAL_DLLPRIVATE vcl::Window* getLegacyNonLayoutAccessibleRelationLabelFor() const;
// Let Label override the code part of GetAccessibleRelationLabelFor
virtual vcl::Window* getAccessibleRelationLabelFor() const;
virtual sal_uInt16 getDefaultAccessibleRole() const;
virtual OUString getDefaultAccessibleName() const;
/*
* Advisory Sizing - what is a good size for this widget
*
* Retrieves the preferred size of a widget ignoring
* "width-request" and "height-request" properties.
*
* Implement this in sub-classes to tell layout
* the preferred widget size.
*
* Use get_preferred_size to retrieve this value
* cached and mediated via height and width requests
*/
virtual Size GetOptimalSize() const;
/// clear OptimalSize cache
void InvalidateSizeCache();
private:
SAL_DLLPRIVATE bool ImplIsAccessibleCandidate() const;
SAL_DLLPRIVATE bool ImplIsAccessibleNativeFrame() const;
///@}
/*
* Retrieves the preferred size of a widget taking
* into account the "width-request" and "height-request" properties.
*
* Overrides the result of GetOptimalSize to honor the
* width-request and height-request properties.
*
* So the same as get_ungrouped_preferred_size except
* it ignores groups. A building block of get_preferred_size
* that access the size cache
*
* @see get_preferred_size
*/
Size get_ungrouped_preferred_size() const;
public:
/// request XCanvas render interface for this window
css::uno::Reference< css::rendering::XCanvas >
GetCanvas() const;
/// request XSpriteCanvas render interface for this window
css::uno::Reference< css::rendering::XSpriteCanvas >
GetSpriteCanvas() const;
/* records all DrawText operations within the passed rectangle;
* a synchronous paint is sent to achieve this
*/
void RecordLayoutData( vcl::ControlLayoutData* pLayout, const tools::Rectangle& rRect );
// set and retrieve for Toolkit
VCLXWindow* GetWindowPeer() const;
void SetWindowPeer( css::uno::Reference< css::awt::XWindowPeer > const & xPeer, VCLXWindow* pVCLXWindow );
// remember if it was generated by Toolkit
bool IsCreatedWithToolkit() const;
void SetCreatedWithToolkit( bool b );
// Drag and Drop interfaces
css::uno::Reference< css::datatransfer::dnd::XDropTarget > GetDropTarget();
css::uno::Reference< css::datatransfer::dnd::XDragSource > GetDragSource();
css::uno::Reference< css::datatransfer::dnd::XDragGestureRecognizer > GetDragGestureRecognizer();
// Clipboard/Selection interfaces
css::uno::Reference< css::datatransfer::clipboard::XClipboard > GetClipboard();
/// Sets a custom clipboard for the window's frame, instead of creating it on-demand using css::datatransfer::clipboard::SystemClipboard.
void SetClipboard(css::uno::Reference<css::datatransfer::clipboard::XClipboard> const & xClipboard);
css::uno::Reference< css::datatransfer::clipboard::XClipboard > GetPrimarySelection();
/*
* Widgets call this to inform their owner container that the widget wants
* to renegotiate its size. Should be called when a widget has a new size
* request. e.g. a FixedText Control gets a new label.
*
* akin to gtk_widget_queue_resize
*/
virtual void queue_resize(StateChangedType eReason = StateChangedType::Layout);
/*
* Sets the "height-request" property
*
* Override for height request of the widget, or -1 if natural request
* should be used.
*
* @see get_preferred_size, set_width_request
*/
void set_height_request(sal_Int32 nHeightRequest);
sal_Int32 get_height_request() const;
/*
* Sets the "width-request" property
*
* Override for width request of the widget, or -1 if natural request
* should be used.
*
* @see get_preferred_size, set_height_request
*/
void set_width_request(sal_Int32 nWidthRequest);
sal_Int32 get_width_request() const;
/*
* Retrieves the preferred size of a widget taking
* into account the "width-request" and "height-request" properties.
*
* Overrides the result of GetOptimalSize to honor the
* width-request and height-request properties.
*
* @see GetOptimalSize
*
* akin to gtk_widget_get_preferred_size
*/
Size get_preferred_size() const;
/*
* How to horizontally align this widget
*/
VclAlign get_halign() const;
void set_halign(VclAlign eAlign);
/*
* How to vertically align this widget
*/
VclAlign get_valign() const;
void set_valign(VclAlign eAlign);
/*
* Whether the widget would like to use any available extra horizontal
* space.
*/
bool get_hexpand() const;
void set_hexpand(bool bExpand);
/*
* Whether the widget would like to use any available extra vertical
* space.
*/
bool get_vexpand() const;
void set_vexpand(bool bExpand);
/*
* Whether the widget would like to use any available extra space.
*/
bool get_expand() const;
void set_expand(bool bExpand);
/*
* Whether the widget should receive extra space when the parent grows
*/
bool get_fill() const;
void set_fill(bool bFill);
void set_border_width(sal_Int32 nBorderWidth);
sal_Int32 get_border_width() const;
void set_margin_left(sal_Int32 nWidth);
sal_Int32 get_margin_left() const;
void set_margin_right(sal_Int32 nWidth);
sal_Int32 get_margin_right() const;
void set_margin_top(sal_Int32 nWidth);
sal_Int32 get_margin_top() const;
void set_margin_bottom(sal_Int32 nWidth);
sal_Int32 get_margin_bottom() const;
/*
* How the widget is packed with reference to the start or end of the parent
*/
VclPackType get_pack_type() const;
void set_pack_type(VclPackType ePackType);
/*
* The extra space to put between the widget and its neighbors
*/
sal_Int32 get_padding() const;
void set_padding(sal_Int32 nPadding);
/*
* The number of columns that the widget spans
*/
sal_Int32 get_grid_width() const;
void set_grid_width(sal_Int32 nCols);
/*
* The column number to attach the left side of the widget to
*/
sal_Int32 get_grid_left_attach() const;
void set_grid_left_attach(sal_Int32 nAttach);
/*
* The number of row that the widget spans
*/
sal_Int32 get_grid_height() const;
void set_grid_height(sal_Int32 nRows);
/*
* The row number to attach the top side of the widget to
*/
sal_Int32 get_grid_top_attach() const;
void set_grid_top_attach(sal_Int32 nAttach);
/*
* If true this child appears in a secondary layout group of children
* e.g. help buttons in a buttonbox
*/
bool get_secondary() const;
void set_secondary(bool bSecondary);
/*
* If true this child is exempted from homogeneous sizing
* e.g. special button in a buttonbox
*/
bool get_non_homogeneous() const;
void set_non_homogeneous(bool bNonHomogeneous);
/*
* Sets a widget property
*
* @return false if property is unknown
*/
virtual bool set_property(const OString &rKey, const OUString &rValue);
/*
* Sets a font attribute
*
* @return false if attribute is unknown
*/
bool set_font_attribute(const OString &rKey, const OUString &rValue);
/*
* Adds this widget to the xGroup VclSizeGroup
*
*/
void add_to_size_group(const std::shared_ptr<VclSizeGroup>& xGroup);
void remove_from_all_size_groups();
/*
* add/remove mnemonic label
*/
void add_mnemonic_label(FixedText *pLabel);
void remove_mnemonic_label(FixedText *pLabel);
const std::vector<VclPtr<FixedText> >& list_mnemonic_labels() const;
/*
* Move this widget to be the nNewPosition'd child of its parent
*/
void reorderWithinParent(sal_uInt16 nNewPosition);
/**
* Sets an ID.
*/
void set_id(const OUString& rID);
/**
* Get the ID of the window.
*/
const OUString& get_id() const;
// Native Widget Rendering functions
// form controls must never use native widgets, this can be toggled here
void EnableNativeWidget( bool bEnable = true );
bool IsNativeWidgetEnabled() const;
// a helper method for a Control's Draw method
void PaintToDevice( ::OutputDevice* pDevice, const Point& rPos, const Size& rSize );
/* tdf#119390 set parent to default window. Typically for use in advance of destroying
* a floating windows which has the current focus so focus will revert to the main
* document window and not the first widget in the current parent of the floating
* window.
*/
void SetParentToDefaultWindow();
// Keyboard access functions
/** Query the states of keyboard indicators - Caps Lock, Num Lock and
Scroll Lock. Use the following mask to retrieve the state of each
indicator:
KeyIndicatorState::CAPS_LOCK
KeyIndicatorState::NUM_LOCK
KeyIndicatorState::SCROLL_LOCK
*/
KeyIndicatorState GetIndicatorState() const;
void SimulateKeyPress( sal_uInt16 nKeyCode ) const;
virtual OUString GetSurroundingText() const;
virtual Selection GetSurroundingTextSelection() const;
virtual FactoryFunction GetUITestFactory() const;
virtual bool IsChart() const { return false; }
void SetHelpHdl(const Link<vcl::Window&, bool>& rLink);
void SetMnemonicActivateHdl(const Link<vcl::Window&, bool>& rLink);
void SetModalHierarchyHdl(const Link<bool, void>& rLink);
void SetDumpAsPropertyTreeHdl(const Link<boost::property_tree::ptree&, void>& rLink);
};
}
#endif // INCLUDED_VCL_WINDOW_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|