1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
|
/* -*- 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_SW_INC_DOC_HXX
#define INCLUDED_SW_INC_DOC_HXX
// SwDoc interfaces
#include <IInterface.hxx>
#include <IDocumentMarkAccess.hxx>
#include <com/sun/star/embed/XEmbeddedObject.hpp>
#include <com/sun/star/embed/XStorage.hpp>
#include <vcl/timer.hxx>
#include <vcl/idle.hxx>
#include <sal/macros.h>
#include "swdllapi.h"
#include <swtypes.hxx>
#include <swatrset.hxx>
#include <toxe.hxx>
#include <flyenum.hxx>
#include <flypos.hxx>
#include <itabenum.hxx>
#include <swdbdata.hxx>
#include <com/sun/star/linguistic2/XSpellChecker1.hpp>
#include <com/sun/star/linguistic2/XHyphenatedWord.hpp>
#include <sfx2/objsh.hxx>
#include <svl/style.hxx>
#include <editeng/numitem.hxx>
#include <com/sun/star/linguistic2/XProofreadingIterator.hpp>
#include <com/sun/star/script/vba/XVBAEventProcessor.hpp>
#include <tox.hxx>
#include <frmfmt.hxx>
#include <charfmt.hxx>
#include <docary.hxx>
#include <pagedesc.hxx>
#include "tblenum.hxx"
#include <svtools/embedhlp.hxx>
#include <memory>
#include <set>
#include <unordered_map>
#include <vector>
namespace editeng { class SvxBorderLine; }
class SvxForbiddenCharactersTable;
class SwExtTextInput;
class DateTime;
class EditFieldInfo;
class Color;
class Outliner;
class OutputDevice;
class Point;
class SbxArray;
class SdrObject;
class SdrUndoAction;
class SvNumberFormatter;
class SvxMacro;
class SwAutoCompleteWord;
class SwAutoCorrExceptWord;
class SwCellFrame;
class SwCellStyleTable;
class SwCharFormat;
class SwCharFormats;
class SwConditionTextFormatColl;
class SwCursorShell;
class SwCursor;
class SwDocShell;
class SwDocUpdateField;
class SwDrawFrameFormat;
class SwDrawView;
class SwEditShell;
class SwFieldType;
class SwField;
class SwTextField;
class SwFieldTypes;
class SwFlyFrameFormat;
class SwFormatsBase;
class SwFormat;
class SwFormatINetFormat;
class SwFormatRefMark;
class SwFrameFormat;
class SwFrameFormats;
class SwFootnoteIdxs;
class SwFootnoteInfo;
class SwEndNoteInfo;
class SwGrfFormatColl;
class SwGrfFormatColls;
class SwLineNumberInfo;
class SwDBManager;
class SwNodeIndex;
class SwNodeRange;
class SwNodes;
class SwNumRule;
class SwNumRuleTable;
class SwPagePreviewPrtData;
class SwRootFrame;
class SwRubyListEntry;
class SwSectionFormat;
class SwSectionFormats;
class SwSectionData;
class SwSelBoxes;
class SwTableAutoFormatTable;
class SwTOXBaseSection;
class SwTOXTypes;
class SwTabCols;
class SwTable;
class SwTableAutoFormat;
class SwTableBox;
class SwTableBoxFormat;
class SwTableFormat;
class SwTableLineFormat;
class SwTableNode;
class SwTextBlocks;
class SwTextFormatColl;
class SwTextFormatColls;
class SwURLStateChanged;
class SwUnoCursor;
class SwViewShell;
class SetGetExpField;
class SwDrawContact;
class SwLayouter;
class SdrView;
class SdrMarkList;
class SwAuthEntry;
class SwLayoutCache;
class IStyleAccess;
struct SwCallMouseEvent;
struct SwDocStat;
struct SwHash;
struct SwSortOptions;
struct SwDefTOXBase_Impl;
class SwPrintData;
class SwPrintUIOptions;
class SdrPageView;
struct SwConversionArgs;
class SwRewriter;
class SwMsgPoolItem;
class SwChartDataProvider;
class SwChartLockController_Helper;
class IGrammarContact;
class SwPrintData;
class SwRenderData;
class SwPageFrame;
class SwViewOption;
class SwList;
class IDocumentUndoRedo;
class IDocumentSettingAccess;
class IDocumentDeviceAccess;
class IDocumentDrawModelAccess;
class IDocumentChartDataProviderAccess;
class IDocumentTimerAccess;
class IDocumentLinksAdministration;
class IDocumentListItems;
class IDocumentListsAccess;
class IDocumentOutlineNodes;
class IDocumentContentOperations;
class IDocumentRedlineAccess;
class IDocumentStatistics;
class IDocumentState;
class IDocumentLayoutAccess;
class IDocumentStylePoolAccess;
class IDocumentExternalData;
class SetGetExpFields;
namespace sw { namespace mark {
class MarkManager;
}}
namespace sw {
class MetaFieldManager;
class UndoManager;
class IShellCursorSupplier;
class DocumentSettingManager;
class DocumentDeviceManager;
class DocumentDrawModelManager;
class DocumentChartDataProviderManager;
class DocumentTimerManager;
class DocumentLinksAdministrationManager;
class DocumentListItemsManager;
class DocumentListsManager;
class DocumentOutlineNodesManager;
class DocumentContentOperationsManager;
class DocumentRedlineManager;
class DocumentFieldsManager;
class DocumentStatisticsManager;
class DocumentStateManager;
class DocumentLayoutManager;
class DocumentStylePoolManager;
class DocumentExternalDataManager;
}
namespace com { namespace sun { namespace star {
namespace i18n {
struct ForbiddenCharacters; //< comes from the I18N UNO interface
}
namespace uno {
template < class > class Sequence;
}
namespace container {
class XNameContainer; //< for getXForms()/isXForms()/initXForms() methods
}
}}}
namespace sfx2 {
class SvLinkSource;
class IXmlIdRegistry;
class LinkManager;
}
void SetAllScriptItem( SfxItemSet& rSet, const SfxPoolItem& rItem );
// global function to start grammar checking in the document
void StartGrammarChecking( SwDoc &rDoc );
using SwRubyList = std::vector<std::unique_ptr<SwRubyListEntry>>;
// Represents the model of a Writer document.
class SW_DLLPUBLIC SwDoc :
public IInterface
{
friend class ::sw::DocumentContentOperationsManager;
friend void InitCore();
friend void FinitCore();
// private Member
std::unique_ptr<SwNodes> m_pNodes; //< document content (Nodes Array)
SwAttrPool* mpAttrPool; //< the attribute pool
SwPageDescs m_PageDescs; //< PageDescriptors
Link<bool,void> maOle2Link; //< OLE 2.0-notification
/* @@@MAINTAINABILITY-HORROR@@@
Timer should not be members of the model
*/
Idle maOLEModifiedIdle; //< Timer for update modified OLE-Objects
SwDBData maDBData; //< database descriptor
OUString msTOIAutoMarkURL; //< URL of table of index AutoMark file
std::vector<OUString> m_PatternNames; //< Array for names of document-templates
css::uno::Reference<css::container::XNameContainer>
mxXForms; //< container with XForms models
mutable css::uno::Reference< css::linguistic2::XProofreadingIterator > m_xGCIterator;
const std::unique_ptr< ::sw::mark::MarkManager> mpMarkManager;
const std::unique_ptr< ::sw::MetaFieldManager > m_pMetaFieldManager;
const std::unique_ptr< ::sw::DocumentDrawModelManager > m_pDocumentDrawModelManager;
const std::unique_ptr< ::sw::DocumentRedlineManager > m_pDocumentRedlineManager;
const std::unique_ptr< ::sw::DocumentStateManager > m_pDocumentStateManager;
const std::unique_ptr< ::sw::UndoManager > m_pUndoManager;
const std::unique_ptr< ::sw::DocumentSettingManager > m_pDocumentSettingManager;
const std::unique_ptr< ::sw::DocumentChartDataProviderManager > m_pDocumentChartDataProviderManager;
std::unique_ptr< ::sw::DocumentDeviceManager > m_pDeviceAccess;
const std::unique_ptr< ::sw::DocumentTimerManager > m_pDocumentTimerManager;
const std::unique_ptr< ::sw::DocumentLinksAdministrationManager > m_pDocumentLinksAdministrationManager;
const std::unique_ptr< ::sw::DocumentListItemsManager > m_pDocumentListItemsManager;
const std::unique_ptr< ::sw::DocumentListsManager > m_pDocumentListsManager;
const std::unique_ptr< ::sw::DocumentOutlineNodesManager > m_pDocumentOutlineNodesManager;
const std::unique_ptr< ::sw::DocumentContentOperationsManager > m_pDocumentContentOperationsManager;
const std::unique_ptr< ::sw::DocumentFieldsManager > m_pDocumentFieldsManager;
const std::unique_ptr< ::sw::DocumentStatisticsManager > m_pDocumentStatisticsManager;
const std::unique_ptr< ::sw::DocumentLayoutManager > m_pDocumentLayoutManager;
const std::unique_ptr< ::sw::DocumentStylePoolManager > m_pDocumentStylePoolManager;
const std::unique_ptr< ::sw::DocumentExternalDataManager > m_pDocumentExternalDataManager;
// Pointer
SwFrameFormat *mpDfltFrameFormat; //< Default formats.
SwFrameFormat *mpEmptyPageFormat; //< Format for the default empty page
SwFrameFormat *mpColumnContFormat; //< Format for column container
SwCharFormat *mpDfltCharFormat;
SwTextFormatColl *mpDfltTextFormatColl; //< Defaultformatcollections
SwGrfFormatColl *mpDfltGrfFormatColl;
SwFrameFormats *mpFrameFormatTable; //< Format table
SwCharFormats *mpCharFormatTable;
SwFrameFormats *mpSpzFrameFormatTable;
SwSectionFormats *mpSectionFormatTable;
SwFrameFormats *mpTableFrameFormatTable; //< For tables
SwTextFormatColls *mpTextFormatCollTable; //< FormatCollections
SwGrfFormatColls *mpGrfFormatCollTable;
SwTOXTypes *mpTOXTypes; //< Tables/indices
SwDefTOXBase_Impl * mpDefTOXBases; //< defaults of SwTOXBase's
SwDBManager *mpDBManager; //< Pointer to the DBManager for evaluation of DB-fields.
SwNumRule *mpOutlineRule;
SwFootnoteInfo *mpFootnoteInfo;
SwEndNoteInfo *mpEndNoteInfo;
SwLineNumberInfo*mpLineNumberInfo;
SwFootnoteIdxs *mpFootnoteIdxs;
SwDocShell *mpDocShell; //< Ptr to SfxDocShell of Doc.
SfxObjectShellLock mxTmpDocShell; //< A temporary shell that is used to copy OLE-Nodes
SwAutoCorrExceptWord *mpACEWord; /**< For the automated takeover of
auto-corrected words that are "re-corrected". */
SwURLStateChanged *mpURLStateChgd; //< SfxClient for changes in INetHistory
SvNumberFormatter *mpNumberFormatter; //< NumFormatter for tables / fields
mutable SwNumRuleTable *mpNumRuleTable; //< List of all named NumRules.
// Hash map to find numrules by name
mutable std::unordered_map<OUString, SwNumRule *, OUStringHash> maNumRuleMap;
SwPagePreviewPrtData *mpPgPViewPrtData; //< Indenting / spacing for printing of page view.
SwPaM *mpExtInputRing;
IStyleAccess *mpStyleAccess; //< handling of automatic styles
SwLayoutCache *mpLayoutCache; /**< Layout cache to read and save with the
document for a faster formatting */
IGrammarContact *mpGrammarContact; //< for grammar checking in paragraphs during editing
css::uno::Reference< css::script::vba::XVBAEventProcessor > mxVbaEvents;
css::uno::Reference<css::container::XNameContainer> m_xTemplateToProjectCache;
/// Table styles (autoformats that are applied with table changes).
std::unique_ptr<SwTableAutoFormatTable> mpTableStyles;
/// Cell Styles not assigned to a Table Style
std::unique_ptr<SwCellStyleTable> mpCellStyles;
private:
std::unique_ptr< ::sfx2::IXmlIdRegistry > m_pXmlIdRegistry;
// other
sal_uInt32 mnRsid; //< current session ID of the document
sal_uInt32 mnRsidRoot; //< session ID when the document was created
sal_Int32 mReferenceCount;
bool mbDtor : 1; /**< TRUE: is in SwDoc DTOR.
and unfortunately temporarily also in
SwSwgReader::InLayout() when flawed
frames need deletion. */
bool mbCopyIsMove : 1; //< TRUE: Copy is a hidden Move.
bool mbInReading : 1; //< TRUE: Document is in the process of being read.
bool mbInMailMerge : 1; //< TRUE: Document is in the process of being written by mail merge.
bool mbInXMLImport : 1; //< TRUE: During xml import, attribute portion building is not necessary.
bool mbUpdateTOX : 1; //< TRUE: After loading document, update TOX.
bool mbInLoadAsynchron : 1; //< TRUE: Document is in the process of being loaded asynchronously.
bool mbIsAutoFormatRedline : 1; //< TRUE: Redlines are recorded by Autoformat.
bool mbOLEPrtNotifyPending : 1; /**< TRUE: Printer has changed. At creation of View
notification of OLE-Objects PrtOLENotify() is required. */
bool mbAllOLENotify : 1; //< True: Notification of all objects is required.
bool mbInsOnlyTextGlssry : 1; //< True: insert 'only text' glossary into doc
bool mbContains_MSVBasic : 1; //< True: MS-VBasic exist is in our storage
bool mbClipBoard : 1; //< TRUE: this document represents the clipboard
bool mbColumnSelection : 1; //< TRUE: this content has been created by a column selection (clipboard docs only)
bool mbIsPrepareSelAll : 1;
#ifdef DBG_UTIL
bool mbXMLExport : 1; //< true: during XML export
#endif
// true: Document contains at least one anchored object, which is anchored AT_PAGE with a content position.
// Thus, certain adjustment needed during formatting for these kind of anchored objects.
bool mbContainsAtPageObjWithContentAnchor : 1;
static SwAutoCompleteWord *mpACmpltWords; //< List of all words for AutoComplete
// private methods
SwFlyFrameFormat* MakeFlySection_( const SwPosition& rAnchPos,
const SwContentNode& rNode, RndStdIds eRequestId,
const SfxItemSet* pFlyAttrSet,
SwFrameFormat* );
sal_Int8 SetFlyFrameAnchor( SwFrameFormat& rFlyFormat, SfxItemSet& rSet, bool bNewFrames );
typedef SwFormat* (SwDoc:: *FNCopyFormat)( const OUString&, SwFormat*, bool, bool );
SwFormat* CopyFormat( const SwFormat& rFormat, const SwFormatsBase& rFormatArr,
FNCopyFormat fnCopyFormat, const SwFormat& rDfltFormat );
void CopyFormatArr( const SwFormatsBase& rSourceArr, SwFormatsBase& rDestArr,
FNCopyFormat fnCopyFormat, SwFormat& rDfltFormat );
void CopyPageDescHeaderFooterImpl( bool bCpyHeader,
const SwFrameFormat& rSrcFormat, SwFrameFormat& rDestFormat );
static SwFormat* FindFormatByName( const SwFormatsBase& rFormatArr, const OUString& rName );
SwDoc( const SwDoc &) = delete;
// Database fields:
void AddUsedDBToList( std::vector<OUString>& rDBNameList,
const std::vector<OUString>& rUsedDBNames );
void AddUsedDBToList( std::vector<OUString>& rDBNameList, const OUString& rDBName );
static bool IsNameInArray( const std::vector<OUString>& rOldNames, const OUString& rName );
void GetAllDBNames( std::vector<OUString>& rAllDBNames );
static OUString ReplaceUsedDBs( const std::vector<OUString>& rUsedDBNames,
const OUString& rNewName, const OUString& rFormula );
static std::vector<OUString>& FindUsedDBs( const std::vector<OUString>& rAllDBNames,
const OUString& rFormula,
std::vector<OUString>& rUsedDBNames );
void CreateNumberFormatter();
bool UnProtectTableCells( SwTable& rTable );
/** Create sub-documents according to the given collection.
If no collection is given, take chapter style of the 1st level. */
bool SplitDoc( sal_uInt16 eDocType, const OUString& rPath, bool bOutline,
const SwTextFormatColl* pSplitColl, int nOutlineLevel = 0 );
// Update charts of given table.
void UpdateCharts_( const SwTable& rTable, SwViewShell const & rVSh ) const;
static bool SelectNextRubyChars( SwPaM& rPam, SwRubyListEntry& rRubyEntry );
// CharTimer calls this method.
void DoUpdateAllCharts();
DECL_LINK( DoUpdateModifiedOLE, Timer *, void );
public:
SwFormat *MakeCharFormat_(const OUString &, SwFormat *, bool, bool );
SwFormat *MakeFrameFormat_(const OUString &, SwFormat *, bool, bool );
private:
SwFormat *MakeTextFormatColl_(const OUString &, SwFormat *, bool, bool );
private:
OUString msDocAccTitle;
void InitTOXTypes();
public:
enum DocumentType {
DOCTYPE_NATIVE,
DOCTYPE_MSWORD // This doc model comes from MS Word
};
DocumentType meDocType;
DocumentType GetDocumentType(){ return meDocType; }
void SetDocumentType( DocumentType eDocType ) { meDocType = eDocType; }
// Life cycle
SwDoc();
virtual ~SwDoc() override;
bool IsInDtor() const { return mbDtor; }
/* @@@MAINTAINABILITY-HORROR@@@
Implementation details made public.
*/
SwNodes & GetNodes() { return *m_pNodes; }
SwNodes const& GetNodes() const { return *m_pNodes; }
// IInterface
virtual sal_Int32 acquire() override;
virtual sal_Int32 release() override;
virtual sal_Int32 getReferenceCount() const override;
// IDocumentSettingAccess
IDocumentSettingAccess const & getIDocumentSettingAccess() const; //The IDocumentSettingAccess interface
IDocumentSettingAccess & getIDocumentSettingAccess();
::sw::DocumentSettingManager & GetDocumentSettingManager(); //The implementation of the interface with some additional methods
::sw::DocumentSettingManager const& GetDocumentSettingManager() const;
sal_uInt32 getRsid() const;
void setRsid( sal_uInt32 nVal );
sal_uInt32 getRsidRoot() const;
void setRsidRoot( sal_uInt32 nVal );
// IDocumentDeviceAccess
IDocumentDeviceAccess const & getIDocumentDeviceAccess() const;
IDocumentDeviceAccess & getIDocumentDeviceAccess();
// IDocumentMarkAccess
IDocumentMarkAccess* getIDocumentMarkAccess();
const IDocumentMarkAccess* getIDocumentMarkAccess() const;
// IDocumentRedlineAccess
IDocumentRedlineAccess const& getIDocumentRedlineAccess() const;
IDocumentRedlineAccess& getIDocumentRedlineAccess();
::sw::DocumentRedlineManager const& GetDocumentRedlineManager() const;
::sw::DocumentRedlineManager& GetDocumentRedlineManager();
// IDocumentUndoRedo
IDocumentUndoRedo & GetIDocumentUndoRedo();
IDocumentUndoRedo const& GetIDocumentUndoRedo() const;
// IDocumentLinksAdministration
IDocumentLinksAdministration const & getIDocumentLinksAdministration() const;
IDocumentLinksAdministration & getIDocumentLinksAdministration();
::sw::DocumentLinksAdministrationManager const & GetDocumentLinksAdministrationManager() const;
::sw::DocumentLinksAdministrationManager & GetDocumentLinksAdministrationManager();
// IDocumentFieldsAccess
IDocumentFieldsAccess const & getIDocumentFieldsAccess() const;
IDocumentFieldsAccess & getIDocumentFieldsAccess();
::sw::DocumentFieldsManager & GetDocumentFieldsManager();
// IDocumentContentOperations
IDocumentContentOperations const & getIDocumentContentOperations() const;
IDocumentContentOperations & getIDocumentContentOperations();
::sw::DocumentContentOperationsManager const & GetDocumentContentOperationsManager() const;
::sw::DocumentContentOperationsManager & GetDocumentContentOperationsManager();
bool UpdateParRsid( SwTextNode *pTextNode, sal_uInt32 nVal = 0 );
bool UpdateRsid( const SwPaM &rRg, sal_Int32 nLen );
// IDocumentStylePoolAccess
IDocumentStylePoolAccess const & getIDocumentStylePoolAccess() const;
IDocumentStylePoolAccess & getIDocumentStylePoolAccess();
// SwLineNumberInfo
const SwLineNumberInfo& GetLineNumberInfo() const;
void SetLineNumberInfo(const SwLineNumberInfo& rInfo);
// IDocumentStatistics
IDocumentStatistics const & getIDocumentStatistics() const;
IDocumentStatistics & getIDocumentStatistics();
::sw::DocumentStatisticsManager const & GetDocumentStatisticsManager() const;
::sw::DocumentStatisticsManager & GetDocumentStatisticsManager();
// IDocumentState
IDocumentState const & getIDocumentState() const;
IDocumentState & getIDocumentState();
// IDocumentDrawModelAccess
DECL_LINK( AddDrawUndo, SdrUndoAction *, void );
IDocumentDrawModelAccess const & getIDocumentDrawModelAccess() const;
IDocumentDrawModelAccess & getIDocumentDrawModelAccess();
::sw::DocumentDrawModelManager const & GetDocumentDrawModelManager() const;
::sw::DocumentDrawModelManager & GetDocumentDrawModelManager();
// IDocumentLayoutAccess
IDocumentLayoutAccess const & getIDocumentLayoutAccess() const;
IDocumentLayoutAccess & getIDocumentLayoutAccess();
::sw::DocumentLayoutManager const & GetDocumentLayoutManager() const;
::sw::DocumentLayoutManager & GetDocumentLayoutManager();
// IDocumentTimerAccess
// Our own 'IdleTimer' calls the following method
IDocumentTimerAccess const & getIDocumentTimerAccess() const;
IDocumentTimerAccess & getIDocumentTimerAccess();
// IDocumentChartDataProviderAccess
IDocumentChartDataProviderAccess const & getIDocumentChartDataProviderAccess() const;
IDocumentChartDataProviderAccess & getIDocumentChartDataProviderAccess();
// IDocumentListItems
IDocumentListItems const & getIDocumentListItems() const;
IDocumentListItems & getIDocumentListItems();
// IDocumentOutlineNodes
IDocumentOutlineNodes const & getIDocumentOutlineNodes() const;
IDocumentOutlineNodes & getIDocumentOutlineNodes();
// IDocumentListsAccess
IDocumentListsAccess const & getIDocumentListsAccess() const;
IDocumentListsAccess & getIDocumentListsAccess();
//IDocumentExternalData
IDocumentExternalData const & getIDocumentExternalData() const;
IDocumentExternalData & getIDocumentExternalData();
//End of Interfaces
void setDocAccTitle( const OUString& rTitle ) { msDocAccTitle = rTitle; }
const OUString& getDocAccTitle() const { return msDocAccTitle; }
// INextInterface here
DECL_LINK(CalcFieldValueHdl, EditFieldInfo*, void);
// OLE ???
bool IsOLEPrtNotifyPending() const { return mbOLEPrtNotifyPending; }
inline void SetOLEPrtNotifyPending( bool bSet = true );
void PrtOLENotify( bool bAll ); // All or only marked
#ifdef DBG_UTIL
bool InXMLExport() const { return mbXMLExport; }
#endif
bool IsPrepareSelAll() const { return mbIsPrepareSelAll; }
void SetPrepareSelAll() { mbIsPrepareSelAll = true; }
void SetContainsAtPageObjWithContentAnchor( const bool bFlag )
{
mbContainsAtPageObjWithContentAnchor = bFlag;
}
bool DoesContainAtPageObjWithContentAnchor()
{
return mbContainsAtPageObjWithContentAnchor;
}
/** Returns positions of all FlyFrames in the document.
If a Pam-Pointer is passed the FlyFrames attached to paragraphes
have to be surrounded completely by css::awt::Selection.
( Start < Pos < End ) !!!
(Required for Writers.) */
SwPosFlyFrames GetAllFlyFormats( const SwPaM*,
bool bDrawAlso,
bool bAsCharAlso = false ) const;
// Because swrtf.cxx and define private public here now.
SwFlyFrameFormat *MakeFlyFrameFormat (const OUString &rFormatName, SwFrameFormat *pDerivedFrom);
SwDrawFrameFormat *MakeDrawFrameFormat(const OUString &rFormatName, SwFrameFormat *pDerivedFrom);
// From now on this interface has to be used for Flys.
// pAnchorPos must be set, if they are not attached to pages AND
// Anchor is not already set at valid ContentPos
// in FlySet/FrameFormat.
/* new parameter bCalledFromShell
true: An existing adjust item at pAnchorPos is propagated to
the content node of the new fly section. That propagation only
takes place if there is no adjust item in the paragraph style
for the new fly section.
false: no propagation
*/
SwFlyFrameFormat* MakeFlySection( RndStdIds eAnchorType,
const SwPosition* pAnchorPos,
const SfxItemSet* pSet = nullptr,
SwFrameFormat *pParent = nullptr,
bool bCalledFromShell = false );
SwFlyFrameFormat* MakeFlyAndMove( const SwPaM& rPam, const SfxItemSet& rSet,
const SwSelBoxes* pSelBoxes,
SwFrameFormat *pParent );
// Helper that checks for unique items for DrawingLayer items of type NameOrIndex
// and evtl. corrects that items to ensure unique names for that type. This call may
// modify/correct entries inside of the given SfxItemSet, and it will apply a name to
// the items in question (what is essential to make the named slots associated with
// these items work for the UNO API and thus e.g. for ODF im/export)
void CheckForUniqueItemForLineFillNameOrIndex(SfxItemSet& rSet);
bool SetFlyFrameAttr( SwFrameFormat& rFlyFormat, SfxItemSet& rSet );
bool SetFrameFormatToFly( SwFrameFormat& rFlyFormat, SwFrameFormat& rNewFormat,
SfxItemSet* pSet = nullptr, bool bKeepOrient = false );
void SetFlyFrameTitle( SwFlyFrameFormat& rFlyFrameFormat,
const OUString& sNewTitle );
void SetFlyFrameDescription( SwFlyFrameFormat& rFlyFrameFormat,
const OUString& sNewDescription );
// Footnotes
// Footnote information
const SwFootnoteInfo& GetFootnoteInfo() const { return *mpFootnoteInfo; }
void SetFootnoteInfo(const SwFootnoteInfo& rInfo);
const SwEndNoteInfo& GetEndNoteInfo() const { return *mpEndNoteInfo; }
void SetEndNoteInfo(const SwEndNoteInfo& rInfo);
SwFootnoteIdxs& GetFootnoteIdxs() { return *mpFootnoteIdxs; }
const SwFootnoteIdxs& GetFootnoteIdxs() const { return *mpFootnoteIdxs; }
// change footnotes in area
bool SetCurFootnote( const SwPaM& rPam, const OUString& rNumStr,
sal_uInt16 nNumber, bool bIsEndNote );
/** Operations on the content of the document e.g.
spell-checking/hyphenating/word-counting
*/
css::uno::Any
Spell( SwPaM&, css::uno::Reference< css::linguistic2::XSpellChecker1 > &,
sal_uInt16* pPageCnt, sal_uInt16* pPageSt, bool bGrammarCheck,
SwConversionArgs *pConvArgs = nullptr ) const;
css::uno::Reference< css::linguistic2::XHyphenatedWord >
Hyphenate( SwPaM *pPam, const Point &rCursorPos,
sal_uInt16* pPageCnt, sal_uInt16* pPageSt );
// count words in pam
static void CountWords( const SwPaM& rPaM, SwDocStat& rStat );
// Glossary Document
bool IsInsOnlyTextGlossary() const { return mbInsOnlyTextGlssry; }
void Summary( SwDoc* pExtDoc, sal_uInt8 nLevel, sal_uInt8 nPara, bool bImpress );
void ChangeAuthorityData(const SwAuthEntry* pNewData);
bool IsInHeaderFooter( const SwNodeIndex& rIdx ) const;
SvxFrameDirection GetTextDirection( const SwPosition& rPos,
const Point* pPt = nullptr ) const;
bool IsInVerticalText( const SwPosition& rPos ) const;
// Database and DB-Manager
void SetDBManager( SwDBManager* pNewMgr ) { mpDBManager = pNewMgr; }
SwDBManager* GetDBManager() const { return mpDBManager; }
void ChangeDBFields( const std::vector<OUString>& rOldNames,
const OUString& rNewName );
void SetInitDBFields(bool b);
// Find out which databases are used by fields.
void GetAllUsedDB( std::vector<OUString>& rDBNameList,
const std::vector<OUString>* pAllDBNames = nullptr );
void ChgDBData( const SwDBData& rNewData );
SwDBData GetDBData();
const SwDBData& GetDBDesc();
// Some helper functions
OUString GetUniqueGrfName() const;
OUString GetUniqueOLEName() const;
OUString GetUniqueFrameName() const;
OUString GetUniqueShapeName() const;
std::set<SwRootFrame*> GetAllLayouts();
void SetFlyName( SwFlyFrameFormat& rFormat, const OUString& rName );
const SwFlyFrameFormat* FindFlyByName( const OUString& rName, SwNodeType nNdTyp = SwNodeType::NONE ) const;
static void GetGrfNms( const SwFlyFrameFormat& rFormat, OUString* pGrfName, OUString* pFltName );
// Set a valid name for all Flys that have none (Called by Readers after reading).
void SetAllUniqueFlyNames();
/** Reset attributes. All TextHints and (if completely selected) all hard-
formatted stuff (auto-formats) are removed.
Introduce new optional parameter <bSendDataChangedEvents> in order to
control, if the side effect "send data changed events" is triggered or not. */
void ResetAttrs( const SwPaM &rRg,
bool bTextAttr = true,
const std::set<sal_uInt16> &rAttrs = std::set<sal_uInt16>(),
const bool bSendDataChangedEvents = true );
void RstTextAttrs(const SwPaM &rRg, bool bInclRefToxMark = false, bool bExactRange = false );
/** Set attribute in given format.1y
* If Undo is enabled, the old values is added to the Undo history. */
void SetAttr( const SfxPoolItem&, SwFormat& );
/** Set attribute in given format.1y
* If Undo is enabled, the old values is added to the Undo history. */
void SetAttr( const SfxItemSet&, SwFormat& );
// method to reset a certain attribute at the given format
void ResetAttrAtFormat( const sal_uInt16 nWhichId,
SwFormat& rChangedFormat );
/** Set attribute as new default attribute in current document.
If Undo is activated, the old one is listed in Undo-History. */
void SetDefault( const SfxPoolItem& );
void SetDefault( const SfxItemSet& );
// Query default attribute in this document.
const SfxPoolItem& GetDefault( sal_uInt16 nFormatHint ) const;
// Do not expand text attributes.
bool DontExpandFormat( const SwPosition& rPos, bool bFlag = true );
// Formats
const SwFrameFormats* GetFrameFormats() const { return mpFrameFormatTable; }
SwFrameFormats* GetFrameFormats() { return mpFrameFormatTable; }
const SwCharFormats* GetCharFormats() const { return mpCharFormatTable;}
SwCharFormats* GetCharFormats() { return mpCharFormatTable;}
// LayoutFormats (frames, DrawObjects), sometimes const sometimes not
const SwFrameFormats* GetSpzFrameFormats() const { return mpSpzFrameFormatTable; }
SwFrameFormats* GetSpzFrameFormats() { return mpSpzFrameFormatTable; }
const SwFrameFormat *GetDfltFrameFormat() const { return mpDfltFrameFormat; }
SwFrameFormat *GetDfltFrameFormat() { return mpDfltFrameFormat; }
const SwFrameFormat *GetEmptyPageFormat() const { return mpEmptyPageFormat; }
SwFrameFormat *GetEmptyPageFormat() { return mpEmptyPageFormat; }
const SwFrameFormat *GetColumnContFormat() const{ return mpColumnContFormat; }
SwFrameFormat *GetColumnContFormat() { return mpColumnContFormat; }
const SwCharFormat *GetDfltCharFormat() const { return mpDfltCharFormat;}
SwCharFormat *GetDfltCharFormat() { return mpDfltCharFormat;}
// @return the interface of the management of (auto)styles
IStyleAccess& GetIStyleAccess() { return *mpStyleAccess; }
// Remove all language dependencies from all existing formats
void RemoveAllFormatLanguageDependencies();
SwFrameFormat *MakeFrameFormat(const OUString &rFormatName, SwFrameFormat *pDerivedFrom,
bool bBroadcast = false, bool bAuto = true);
void DelFrameFormat( SwFrameFormat *pFormat, bool bBroadcast = false );
SwFrameFormat* FindFrameFormatByName( const OUString& rName ) const
{ return static_cast<SwFrameFormat*>(FindFormatByName( static_cast<SwFormatsBase&>(*mpFrameFormatTable), rName )); }
SwCharFormat *MakeCharFormat(const OUString &rFormatName, SwCharFormat *pDerivedFrom,
bool bBroadcast = false );
void DelCharFormat(size_t nFormat, bool bBroadcast = false);
void DelCharFormat(SwCharFormat* pFormat, bool bBroadcast = false);
SwCharFormat* FindCharFormatByName( const OUString& rName ) const
{ return static_cast<SwCharFormat*>(FindFormatByName( *mpCharFormatTable, rName )); }
// Formatcollections (styles)
// TXT
const SwTextFormatColl* GetDfltTextFormatColl() const { return mpDfltTextFormatColl; }
SwTextFormatColl* GetDfltTextFormatColl() { return mpDfltTextFormatColl; }
const SwTextFormatColls *GetTextFormatColls() const { return mpTextFormatCollTable; }
SwTextFormatColls *GetTextFormatColls() { return mpTextFormatCollTable; }
SwTextFormatColl *MakeTextFormatColl( const OUString &rFormatName,
SwTextFormatColl *pDerivedFrom,
bool bBroadcast = false);
SwConditionTextFormatColl* MakeCondTextFormatColl( const OUString &rFormatName,
SwTextFormatColl *pDerivedFrom,
bool bBroadcast = false);
void DelTextFormatColl(size_t nFormat, bool bBroadcast = false);
void DelTextFormatColl( SwTextFormatColl* pColl, bool bBroadcast = false );
/** Add 4th optional parameter <bResetListAttrs>.
'side effect' of <SetTextFormatColl> with <bReset = true> is that the hard
attributes of the affected text nodes are cleared, except the break
attribute, the page description attribute and the list style attribute.
The new parameter <bResetListAttrs> indicates, if the list attributes
(list style, restart at and restart with) are cleared as well in case
that <bReset = true> and the paragraph style has a list style attribute set. */
bool SetTextFormatColl(const SwPaM &rRg, SwTextFormatColl *pFormat,
const bool bReset = true,
const bool bResetListAttrs = false);
SwTextFormatColl* FindTextFormatCollByName( const OUString& rName ) const
{ return static_cast<SwTextFormatColl*>(FindFormatByName( *mpTextFormatCollTable, rName )); }
void ChkCondColls();
const SwGrfFormatColl* GetDfltGrfFormatColl() const { return mpDfltGrfFormatColl; }
SwGrfFormatColl* GetDfltGrfFormatColl() { return mpDfltGrfFormatColl; }
const SwGrfFormatColls *GetGrfFormatColls() const { return mpGrfFormatCollTable; }
SwGrfFormatColl *MakeGrfFormatColl(const OUString &rFormatName,
SwGrfFormatColl *pDerivedFrom);
// Table formatting
const SwFrameFormats* GetTableFrameFormats() const { return mpTableFrameFormatTable; }
SwFrameFormats* GetTableFrameFormats() { return mpTableFrameFormatTable; }
size_t GetTableFrameFormatCount( bool bUsed ) const;
SwFrameFormat& GetTableFrameFormat(size_t nFormat, bool bUsed ) const;
SwTableFormat* MakeTableFrameFormat(const OUString &rFormatName, SwFrameFormat *pDerivedFrom);
void DelTableFrameFormat( SwTableFormat* pFormat );
SwTableFormat* FindTableFormatByName( const OUString& rName, bool bAll = false ) const;
/** Access to frames.
Iterate over Flys - for Basic-Collections. */
size_t GetFlyCount( FlyCntType eType, bool bIgnoreTextBoxes = false ) const;
SwFrameFormat* GetFlyNum(size_t nIdx, FlyCntType eType, bool bIgnoreTextBoxes = false );
std::vector<SwFrameFormat const*> GetFlyFrameFormats(
FlyCntType eType,
bool bIgnoreTextBoxes);
// Copy formats in own arrays and return them.
SwFrameFormat *CopyFrameFormat ( const SwFrameFormat& );
SwCharFormat *CopyCharFormat( const SwCharFormat& );
SwTextFormatColl* CopyTextColl( const SwTextFormatColl& rColl );
SwGrfFormatColl* CopyGrfColl( const SwGrfFormatColl& rColl );
// Replace all styles with those from rSource.
void ReplaceStyles( const SwDoc& rSource, bool bIncludePageStyles = true );
// Replace all property defaults with those from rSource.
void ReplaceDefaults( const SwDoc& rSource );
// Replace all compatibility options with those from rSource.
void ReplaceCompatibilityOptions( const SwDoc& rSource );
/** Replace all user defined document properties with xSourceDocProps.
Convenince function used by ReplaceDocumentProperties to skip some UNO calls.
*/
void ReplaceUserDefinedDocumentProperties( const css::uno::Reference< css::document::XDocumentProperties >& xSourceDocProps );
/** Replace document properties with those from rSource.
This includes the user defined document properties!
*/
void ReplaceDocumentProperties(const SwDoc& rSource, bool mailMerge = false);
// Query if style (paragraph- / character- / frame- / page-) is used.
bool IsUsed( const SwModify& ) const;
/// Query if table style is used.
bool IsUsed( const SwTableAutoFormat& ) const;
static bool IsUsed( const SwNumRule& );
// Set name of newly loaded document template.
size_t SetDocPattern(const OUString& rPatternName);
// @return name of document template. Can be 0!
const OUString* GetDocPattern(size_t nPos) const;
// travel over PaM Ring
bool InsertGlossary( SwTextBlocks& rBlock, const OUString& rEntry,
SwPaM& rPaM, SwCursorShell* pShell = nullptr);
/** get the set of printable pages for the XRenderable API by
evaluating the respective settings (see implementation) */
static void CalculatePagesForPrinting( const SwRootFrame& rLayout, SwRenderData &rData, const SwPrintUIOptions &rOptions, bool bIsPDFExport,
sal_Int32 nDocPageCount );
static void UpdatePagesForPrintingWithPostItData( SwRenderData &rData, const SwPrintUIOptions &rOptions,
sal_Int32 nDocPageCount );
static void CalculatePagePairsForProspectPrinting( const SwRootFrame& rLayout, SwRenderData &rData, const SwPrintUIOptions &rOptions,
sal_Int32 nDocPageCount );
// PageDescriptor interface.
size_t GetPageDescCnt() const { return m_PageDescs.size(); }
const SwPageDesc& GetPageDesc(const size_t i) const { return *m_PageDescs[i]; }
SwPageDesc& GetPageDesc(size_t const i) { return *m_PageDescs[i]; }
SwPageDesc* FindPageDesc(const OUString& rName, size_t* pPos = nullptr) const;
// Just searches the pointer in the m_PageDescs vector!
bool ContainsPageDesc(const SwPageDesc *pDesc, size_t* pPos) const;
/** Copy the complete PageDesc - beyond document and "deep"!
Optionally copying of PoolFormatId, -HlpId can be prevented. */
void CopyPageDesc( const SwPageDesc& rSrcDesc, SwPageDesc& rDstDesc,
bool bCopyPoolIds = true );
/** Copy header (with contents) from SrcFormat to DestFormat
(can also be copied into other document). */
void CopyHeader( const SwFrameFormat& rSrcFormat, SwFrameFormat& rDestFormat )
{ CopyPageDescHeaderFooterImpl( true, rSrcFormat, rDestFormat ); }
/** Copy footer (with contents) from SrcFormat to DestFormat.
(can also be copied into other document). */
void CopyFooter( const SwFrameFormat& rSrcFormat, SwFrameFormat& rDestFormat )
{ CopyPageDescHeaderFooterImpl( false, rSrcFormat, rDestFormat ); }
// For Reader
void ChgPageDesc( const OUString & rName, const SwPageDesc& );
void ChgPageDesc( size_t i, const SwPageDesc& );
void DelPageDesc( const OUString & rName, bool bBroadcast = false);
void DelPageDesc( size_t i, bool bBroadcast = false );
void PreDelPageDesc(SwPageDesc * pDel);
SwPageDesc* MakePageDesc(const OUString &rName, const SwPageDesc* pCpy = nullptr,
bool bRegardLanguage = true,
bool bBroadcast = false);
void BroadcastStyleOperation(const OUString& rName, SfxStyleFamily eFamily,
SfxHintId nOp);
/** The html import sometimes overwrites the page sizes set in
the page descriptions. This function is used to correct this. */
void CheckDefaultPageFormat();
// Methods for tables/indices
static sal_uInt16 GetCurTOXMark( const SwPosition& rPos, SwTOXMarks& );
void DeleteTOXMark( const SwTOXMark* pTOXMark );
const SwTOXMark& GotoTOXMark( const SwTOXMark& rCurTOXMark,
SwTOXSearch eDir, bool bInReadOnly );
// Insert/Renew table/index
SwTOXBaseSection* InsertTableOf( const SwPosition& rPos,
const SwTOXBase& rTOX,
const SfxItemSet* pSet = nullptr,
bool bExpand = false );
void InsertTableOf( sal_uLong nSttNd, sal_uLong nEndNd,
const SwTOXBase& rTOX,
const SfxItemSet* pSet );
static SwTOXBase* GetCurTOX( const SwPosition& rPos );
static const SwAttrSet& GetTOXBaseAttrSet(const SwTOXBase& rTOX);
bool DeleteTOX( const SwTOXBase& rTOXBase, bool bDelNodes );
OUString GetUniqueTOXBaseName( const SwTOXType& rType,
const OUString& sChkStr ) const;
bool SetTOXBaseName(const SwTOXBase& rTOXBase, const OUString& rName);
// After reading file update all tables/indices
void SetUpdateTOX( bool bFlag ) { mbUpdateTOX = bFlag; }
bool IsUpdateTOX() const { return mbUpdateTOX; }
const OUString& GetTOIAutoMarkURL() const {return msTOIAutoMarkURL;}
void SetTOIAutoMarkURL(const OUString& rSet) {msTOIAutoMarkURL = rSet;}
bool IsInReading() const { return mbInReading; }
void SetInReading( bool bNew ) { mbInReading = bNew; }
bool IsInMailMerge() const { return mbInMailMerge; }
void SetInMailMerge( bool bNew ) { mbInMailMerge = bNew; }
bool IsClipBoard() const { return mbClipBoard; }
// N.B.: must be called right after constructor! (@see GetXmlIdRegistry)
void SetClipBoard( bool bNew ) { mbClipBoard = bNew; }
bool IsColumnSelection() const { return mbColumnSelection; }
void SetColumnSelection( bool bNew ) { mbColumnSelection = bNew; }
bool IsInXMLImport() const { return mbInXMLImport; }
void SetInXMLImport( bool bNew ) { mbInXMLImport = bNew; }
// Manage types of tables/indices
sal_uInt16 GetTOXTypeCount( TOXTypes eTyp ) const;
const SwTOXType* GetTOXType( TOXTypes eTyp, sal_uInt16 nId ) const;
const SwTOXType* InsertTOXType( const SwTOXType& rTyp );
const SwTOXTypes& GetTOXTypes() const { return *mpTOXTypes; }
const SwTOXBase* GetDefaultTOXBase( TOXTypes eTyp, bool bCreate );
void SetDefaultTOXBase(const SwTOXBase& rBase);
// Key for management of index.
void GetTOIKeys( SwTOIKeyType eTyp, std::vector<OUString>& rArr ) const;
// Sort table text.
bool SortTable(const SwSelBoxes& rBoxes, const SwSortOptions&);
bool SortText(const SwPaM&, const SwSortOptions&);
// Correct the SwPosition-Objects that are registered with the document
// e. g. Bookmarks or tables/indices.
// If bMoveCursor is set move Cursor too.
// Set everything in rOldNode on rNewPos + Offset.
void CorrAbs(
const SwNodeIndex& rOldNode,
const SwPosition& rNewPos,
const sal_Int32 nOffset = 0,
bool bMoveCursor = false );
// Set everything in the range of [rStartNode, rEndNode] to rNewPos.
static void CorrAbs(
const SwNodeIndex& rStartNode,
const SwNodeIndex& rEndNode,
const SwPosition& rNewPos,
bool bMoveCursor = false );
// Set everything in this range from rRange to rNewPos.
static void CorrAbs(
const SwPaM& rRange,
const SwPosition& rNewPos,
bool bMoveCursor = false );
// Set everything in rOldNode to relative Pos.
void CorrRel(
const SwNodeIndex& rOldNode,
const SwPosition& rNewPos,
const sal_Int32 nOffset = 0,
bool bMoveCursor = false );
// Query / set rules for Outline.
SwNumRule* GetOutlineNumRule() const
{
return mpOutlineRule;
}
void SetOutlineNumRule( const SwNumRule& rRule );
void PropagateOutlineRule();
// Outline - promote / demote.
bool OutlineUpDown( const SwPaM& rPam, short nOffset );
// Ountline - move up / move down.
bool MoveOutlinePara( const SwPaM& rPam, SwOutlineNodes::difference_type nOffset);
bool GotoOutline( SwPosition& rPos, const OUString& rName ) const;
/** Accept changes of outline styles for OUtlineRule.
re-use unused 3rd parameter
Optional parameter <bResetIndentAttrs> - default value false:
If <bResetIndentAttrs> equals true, the indent attributes "before text"
and "first line indent" are additionally reset at the provided PaM, if
the list style makes use of the new list level attributes.
Parameters <bCreateNewList> and <sContinuedListId>:
<bCreateNewList> indicates, if a new list is created by applying the given list style.
If <bCreateNewList> equals false, <sContinuedListId> may contain the
list Id of a list, which has to be continued by applying the given list style
Returns the set ListId if bSetItem is true */
OUString SetNumRule( const SwPaM&,
const SwNumRule&,
bool bCreateNewList,
const OUString& sContinuedListId = OUString(),
bool bSetItem = true,
const bool bResetIndentAttrs = false );
void SetCounted( const SwPaM&, bool bCounted);
void MakeUniqueNumRules(const SwPaM & rPaM);
void SetNumRuleStart( const SwPosition& rPos, bool bFlag = true );
void SetNodeNumStart( const SwPosition& rPos, sal_uInt16 nStt );
static SwNumRule* GetNumRuleAtPos( const SwPosition& rPos );
const SwNumRuleTable& GetNumRuleTable() const { return *mpNumRuleTable; }
/**
Add numbering rule to document.
@param pRule rule to add
*/
void AddNumRule(SwNumRule * pRule);
// add optional parameter <eDefaultNumberFormatPositionAndSpaceMode>
sal_uInt16 MakeNumRule( const OUString &rName,
const SwNumRule* pCpy = nullptr,
bool bBroadcast = false,
const SvxNumberFormat::SvxNumPositionAndSpaceMode eDefaultNumberFormatPositionAndSpaceMode =
SvxNumberFormat::LABEL_WIDTH_AND_POSITION );
sal_uInt16 FindNumRule( const OUString& rName ) const;
SwNumRule* FindNumRulePtr( const OUString& rName ) const;
// Deletion only possible if Rule is not used!
bool RenameNumRule(const OUString & aOldName, const OUString & aNewName,
bool bBroadcast = false);
bool DelNumRule( const OUString& rName, bool bBroadCast = false );
OUString GetUniqueNumRuleName( const OUString* pChkStr = nullptr, bool bAutoNum = true ) const;
void UpdateNumRule(); // Update all invalids.
void ChgNumRuleFormats( const SwNumRule& rRule );
bool ReplaceNumRule( const SwPosition& rPos, const OUString& rOldRule,
const OUString& rNewRule );
// Goto next/previous on same level.
static bool GotoNextNum( SwPosition&, bool bOverUpper = true,
sal_uInt8* pUpper = nullptr, sal_uInt8* pLower = nullptr );
static bool GotoPrevNum( SwPosition&, bool bOverUpper = true,
sal_uInt8* pUpper = nullptr, sal_uInt8* pLower = nullptr );
/** Searches for a text node with a numbering rule.
add optional parameter <bInvestigateStartNode>
add output parameter <sListId>
\param rPos position to start search
\param bForward - true: search forward
- false: search backward
\param bNum - true: search for enumeration
- false: search for itemize
\param bOutline - true: search for outline numbering rule
- false: search for non-outline numbering rule
\param nNonEmptyAllowed number of non-empty paragraphs allowed between
rPos and found paragraph
@param sListId
output parameter - in case a list style is found, <sListId> holds the
list id, to which the text node belongs, which applies the found list style.
@param bInvestigateStartNode
input parameter - boolean, indicating, if start node, determined by given
start position has to be investigated or not.
*/
const SwNumRule * SearchNumRule(const SwPosition & rPos,
const bool bForward,
const bool bNum,
const bool bOutline,
int nNonEmptyAllowed,
OUString& sListId,
const bool bInvestigateStartNode = false );
// Paragraphs without numbering but with indents.
bool NoNum( const SwPaM& );
// Delete, splitting of numbering list.
void DelNumRules( const SwPaM& );
// Invalidates all numrules
void InvalidateNumRules();
bool NumUpDown( const SwPaM&, bool bDown );
/** Move selected paragraphes (not only numberings)
according to offsets. (if negative: go to doc start). */
bool MoveParagraph( const SwPaM&, long nOffset, bool bIsOutlMv = false );
bool NumOrNoNum( const SwNodeIndex& rIdx, bool bDel = false);
void StopNumRuleAnimations( OutputDevice* );
/** Insert new table at position @param rPos (will be inserted before Node!).
For AutoFormat at input: columns have to be set at predefined width.
The array holds the positions of the columns (not their widths).
new @param bCalledFromShell:
true: called from shell -> propagate existing adjust item at
rPos to every new cell. A existing adjust item in the table
heading or table contents paragraph style prevent that
propagation.
false: do not propagate
*/
const SwTable* InsertTable( const SwInsertTableOptions& rInsTableOpts, // HEADLINE_NO_BORDER
const SwPosition& rPos, sal_uInt16 nRows,
sal_uInt16 nCols, short eAdjust,
const SwTableAutoFormat* pTAFormat = nullptr,
const std::vector<sal_uInt16> *pColArr = nullptr,
bool bCalledFromShell = false,
bool bNewModel = true );
// If index is in a table, return TableNode, else 0.
SwTableNode* IsIdxInTable( const SwNodeIndex& rIdx );
inline const SwTableNode* IsIdxInTable( const SwNodeIndex& rIdx ) const;
// Create a balanced table out of the selected range.
const SwTable* TextToTable( const SwInsertTableOptions& rInsTableOpts, // HEADLINE_NO_BORDER,
const SwPaM& rRange, sal_Unicode cCh,
short eAdjust,
const SwTableAutoFormat* );
// text to table conversion - API support
const SwTable* TextToTable( const std::vector< std::vector<SwNodeRange> >& rTableNodes );
bool TableToText( const SwTableNode* pTableNd, sal_Unicode cCh );
// Create columns / rows in table.
bool InsertCol( const SwCursor& rCursor,
sal_uInt16 nCnt = 1, bool bBehind = true );
bool InsertCol( const SwSelBoxes& rBoxes,
sal_uInt16 nCnt = 1, bool bBehind = true );
bool InsertRow( const SwCursor& rCursor,
sal_uInt16 nCnt = 1, bool bBehind = true );
bool InsertRow( const SwSelBoxes& rBoxes,
sal_uInt16 nCnt = 1, bool bBehind = true );
// Delete Columns/Rows in table.
bool DeleteRowCol( const SwSelBoxes& rBoxes, bool bColumn = false );
bool DeleteRow( const SwCursor& rCursor );
bool DeleteCol( const SwCursor& rCursor );
// Split / concatenate boxes in table.
bool SplitTable( const SwSelBoxes& rBoxes, bool bVert,
sal_uInt16 nCnt, bool bSameHeight = false );
TableMergeErr MergeTable( SwPaM& rPam );
OUString GetUniqueTableName() const;
bool IsInsTableFormatNum() const;
bool IsInsTableChangeNumFormat() const;
bool IsInsTableAlignNum() const;
// From FEShell (for Undo and BModified).
static void GetTabCols( SwTabCols &rFill, const SwCursor* pCursor,
const SwCellFrame* pBoxFrame );
void SetTabCols( const SwTabCols &rNew, bool bCurRowOnly,
const SwCellFrame* pBoxFrame );
static void GetTabRows( SwTabCols &rFill, const SwCursor* pCursor,
const SwCellFrame* pBoxFrame );
void SetTabRows( const SwTabCols &rNew, bool bCurColOnly,
const SwCellFrame* pBoxFrame );
// Direct access for UNO.
void SetTabCols(SwTable& rTab, const SwTabCols &rNew, const SwTabCols &rOld,
const SwTableBox *pStart, bool bCurRowOnly);
void SetRowsToRepeat( SwTable &rTable, sal_uInt16 nSet );
/// AutoFormat for table/table selection.
/// @param bResetDirect Reset direct formatting that might be applied to the cells.
bool SetTableAutoFormat(const SwSelBoxes& rBoxes, const SwTableAutoFormat& rNew, bool bResetDirect = false, bool isSetStyleName = false);
// Query attributes.
bool GetTableAutoFormat( const SwSelBoxes& rBoxes, SwTableAutoFormat& rGet );
/// Return the available table styles.
SwTableAutoFormatTable& GetTableStyles() { return *mpTableStyles.get(); }
const SwTableAutoFormatTable& GetTableStyles() const { return *mpTableStyles.get(); }
// Create a new table style. Tracked by Undo.
SwTableAutoFormat* MakeTableStyle(const OUString& rName, bool bBroadcast = false);
// Delete table style named rName. Tracked by undo.
std::unique_ptr<SwTableAutoFormat> DelTableStyle(const OUString& rName, bool bBroadcast = false);
// Change (replace) a table style named rName. Tracked by undo.
void ChgTableStyle(const OUString& rName, const SwTableAutoFormat& rNewFormat);
const SwCellStyleTable& GetCellStyles() const { return *mpCellStyles.get(); }
SwCellStyleTable& GetCellStyles() { return *mpCellStyles.get(); }
void AppendUndoForInsertFromDB( const SwPaM& rPam, bool bIsTable );
bool SetColRowWidthHeight( SwTableBox& rAktBox, TableChgWidthHeightType eType,
SwTwips nAbsDiff, SwTwips nRelDiff );
SwTableBoxFormat* MakeTableBoxFormat();
SwTableLineFormat* MakeTableLineFormat();
// helper function: cleanup before checking number value
bool IsNumberFormat( const OUString& rString, sal_uInt32& F_Index, double& fOutNumber);
// Check if box has numerical value. Change format of box if required.
void ChkBoxNumFormat( SwTableBox& rAktBox, bool bCallUpdate );
void SetTableBoxFormulaAttrs( SwTableBox& rBox, const SfxItemSet& rSet );
void ClearBoxNumAttrs( const SwNodeIndex& rNode );
void ClearLineNumAttrs( SwPosition & rPos );
bool InsCopyOfTable( SwPosition& rInsPos, const SwSelBoxes& rBoxes,
const SwTable* pCpyTable, bool bCpyName = false,
bool bCorrPos = false );
bool UnProtectCells( const OUString& rTableName );
bool UnProtectCells( const SwSelBoxes& rBoxes );
bool UnProtectTables( const SwPaM& rPam );
bool HasTableAnyProtection( const SwPosition* pPos,
const OUString* pTableName,
bool* pFullTableProtection );
// Split table at baseline position, i.e. create a new table.
bool SplitTable( const SwPosition& rPos, SplitTable_HeadlineOption eMode,
bool bCalcNewSize );
/** And vice versa: rPos must be in the table that remains. The flag indicates
whether the current table is merged with the one before or behind it. */
bool MergeTable( const SwPosition& rPos, bool bWithPrev,
sal_uInt16 nMode = 0 );
// Make charts of given table update.
void UpdateCharts( const OUString &rName ) const;
// Update all charts, for that exists any table.
void UpdateAllCharts() { DoUpdateAllCharts(); }
// Table is renamed and refreshes charts.
void SetTableName( SwFrameFormat& rTableFormat, const OUString &rNewName );
// @return the reference in document that is set for name.
const SwFormatRefMark* GetRefMark( const OUString& rName ) const;
// @return RefMark via index - for UNO.
const SwFormatRefMark* GetRefMark( sal_uInt16 nIndex ) const;
/** @return names of all references that are set in document.
If array pointer is 0 return only whether a RefMark is set in document. */
sal_uInt16 GetRefMarks( std::vector<OUString>* = nullptr ) const;
// Insert label. If a FlyFormat is created, return it.
SwFlyFrameFormat* InsertLabel( const SwLabelType eType, const OUString &rText, const OUString& rSeparator,
const OUString& rNumberingSeparator,
const bool bBefore, const sal_uInt16 nId, const sal_uLong nIdx,
const OUString& rCharacterStyle,
const bool bCpyBrd );
SwFlyFrameFormat* InsertDrawLabel(
const OUString &rText, const OUString& rSeparator, const OUString& rNumberSeparator,
const sal_uInt16 nId, const OUString& rCharacterStyle, SdrObject& rObj );
// Query attribute pool.
const SwAttrPool& GetAttrPool() const { return *mpAttrPool; }
SwAttrPool& GetAttrPool() { return *mpAttrPool; }
// Search for an EditShell.
SwEditShell const * GetEditShell() const;
SwEditShell* GetEditShell();
::sw::IShellCursorSupplier * GetIShellCursorSupplier();
// OLE 2.0-notification.
void SetOle2Link(const Link<bool,void>& rLink) {maOle2Link = rLink;}
const Link<bool,void>& GetOle2Link() const {return maOle2Link;}
// insert section (the ODF kind of section, not the nodesarray kind)
SwSection * InsertSwSection(SwPaM const& rRange, SwSectionData &,
SwTOXBase const*const pTOXBase,
SfxItemSet const*const pAttr, bool const bUpdate = true);
static sal_uInt16 IsInsRegionAvailable( const SwPaM& rRange,
const SwNode** ppSttNd = nullptr );
static SwSection* GetCurrSection( const SwPosition& rPos );
SwSectionFormats& GetSections() { return *mpSectionFormatTable; }
const SwSectionFormats& GetSections() const { return *mpSectionFormatTable; }
SwSectionFormat *MakeSectionFormat();
void DelSectionFormat( SwSectionFormat *pFormat, bool bDelNodes = false );
void UpdateSection(size_t const nSect, SwSectionData &,
SfxItemSet const*const = nullptr, bool const bPreventLinkUpdate = false);
OUString GetUniqueSectionName( const OUString* pChkStr = nullptr ) const;
/* @@@MAINTAINABILITY-HORROR@@@
The model should not have anything to do with a shell.
Unnecessary compile/link time dependency.
*/
// Pointer to SfxDocShell from Doc. Can be 0!!
SwDocShell* GetDocShell() { return mpDocShell; }
const SwDocShell* GetDocShell() const { return mpDocShell; }
void SetDocShell( SwDocShell* pDSh );
/** in case during copying of embedded object a new shell is created,
it should be set here and cleaned later */
void SetTmpDocShell( SfxObjectShellLock rLock ) { mxTmpDocShell = rLock; }
const SfxObjectShellLock& GetTmpDocShell() { return mxTmpDocShell; }
// For Autotexts? (text modules) They have only one SVPersist at their disposal.
SfxObjectShell* GetPersist() const;
// Pointer to storage of SfxDocShells. Can be 0!!!
css::uno::Reference< css::embed::XStorage > GetDocStorage();
// Query / set flag indicating if document is loaded asynchronously at this moment.
bool IsInLoadAsynchron() const { return mbInLoadAsynchron; }
void SetInLoadAsynchron( bool bFlag ) { mbInLoadAsynchron = bFlag; }
// For Drag&Move: (e.g. allow "moving" of RefMarks)
bool IsCopyIsMove() const { return mbCopyIsMove; }
void SetCopyIsMove( bool bFlag ) { mbCopyIsMove = bFlag; }
SwDrawContact* GroupSelection( SdrView& );
void UnGroupSelection( SdrView& );
bool DeleteSelection( SwDrawView& );
// Invalidates OnlineSpell-WrongLists.
void SpellItAgainSam( bool bInvalid, bool bOnlyWrong, bool bSmartTags );
void InvalidateAutoCompleteFlag();
void SetCalcFieldValueHdl(Outliner* pOutliner);
// Query if URL was visited.
// Query via Doc, if only a Bookmark has been given.
// In this case the document name has to be set in front.
bool IsVisitedURL( const OUString& rURL );
// Save current values for automatic registration of exceptions in Autocorrection.
void SetAutoCorrExceptWord( SwAutoCorrExceptWord* pNew );
SwAutoCorrExceptWord* GetAutoCorrExceptWord() { return mpACEWord; }
void DeleteAutoCorrExceptWord();
const SwFormatINetFormat* FindINetAttr( const OUString& rName ) const;
// Call into intransparent Basic; expect possible Return String.
bool ExecMacro( const SvxMacro& rMacro, OUString* pRet, SbxArray* pArgs );
// Call into intransparent Basic / JavaScript.
sal_uInt16 CallEvent( sal_uInt16 nEvent, const SwCallMouseEvent& rCallEvent,
bool bChkPtr = false );
/** Adjust left margin via object bar (similar to adjustment of numerations).
One can either change the margin "by" adding or subtracting a given
offset or set it "to" this position (bModulus = true). */
void MoveLeftMargin( const SwPaM& rPam, bool bRight, bool bModulus );
// Query NumberFormatter.
inline SvNumberFormatter* GetNumberFormatter( bool bCreate = true );
inline const SvNumberFormatter* GetNumberFormatter( bool bCreate = true ) const;
bool HasInvisibleContent() const;
// delete invisible content, like hidden sections and paragraphs
bool RemoveInvisibleContent();
// restore the invisible content if it's available on the undo stack
bool RestoreInvisibleContent();
bool ConvertFieldsToText();
// Create sub-documents according to given collection.
// If no collection is given, use chapter styles for 1st level.
bool GenerateGlobalDoc( const OUString& rPath,
const SwTextFormatColl* pSplitColl );
bool GenerateGlobalDoc( const OUString& rPath, int nOutlineLevel );
bool GenerateHTMLDoc( const OUString& rPath,
const SwTextFormatColl* pSplitColl );
bool GenerateHTMLDoc( const OUString& rPath, int nOutlineLevel );
// Compare two documents.
long CompareDoc( const SwDoc& rDoc );
// Merge two documents.
long MergeDoc( const SwDoc& rDoc );
bool IsAutoFormatRedline() const { return mbIsAutoFormatRedline; }
void SetAutoFormatRedline( bool bFlag ) { mbIsAutoFormatRedline = bFlag; }
// For AutoFormat: with Undo/Redlining.
void SetTextFormatCollByAutoFormat( const SwPosition& rPos, sal_uInt16 nPoolId,
const SfxItemSet* pSet );
void SetFormatItemByAutoFormat( const SwPaM& rPam, const SfxItemSet& );
// Only for SW-textbloxks! Does not pay any attention to layout!
void ClearDoc(); // Deletes all content!
// Query /set data for PagePreview.
const SwPagePreviewPrtData* GetPreviewPrtData() const { return mpPgPViewPrtData; }
// If pointer == 0 destroy pointer in document.
// Else copy object.
// Pointer is not transferred to ownership by document!
void SetPreviewPrtData( const SwPagePreviewPrtData* pData );
/** update all modified OLE-Objects. The modification is called over the
StarOne - Interface */
void SetOLEObjModified();
// Uno - Interfaces
std::shared_ptr<SwUnoCursor> CreateUnoCursor( const SwPosition& rPos, bool bTableCursor = false );
// FeShell - Interfaces
// !!! These assume always an existing layout !!!
bool ChgAnchor( const SdrMarkList& _rMrkList,
RndStdIds _eAnchorType,
const bool _bSameOnly,
const bool _bPosCorr );
void SetRowHeight( const SwCursor& rCursor, const SwFormatFrameSize &rNew );
static void GetRowHeight( const SwCursor& rCursor, SwFormatFrameSize *& rpSz );
void SetRowSplit( const SwCursor& rCursor, const SwFormatRowSplit &rNew );
static void GetRowSplit( const SwCursor& rCursor, SwFormatRowSplit *& rpSz );
bool BalanceRowHeight( const SwCursor& rCursor, bool bTstOnly );
void SetRowBackground( const SwCursor& rCursor, const SvxBrushItem &rNew );
static bool GetRowBackground( const SwCursor& rCursor, SvxBrushItem &rToFill );
void SetTabBorders( const SwCursor& rCursor, const SfxItemSet& rSet );
void SetTabLineStyle( const SwCursor& rCursor,
const Color* pColor, bool bSetLine,
const editeng::SvxBorderLine* pBorderLine );
static void GetTabBorders( const SwCursor& rCursor, SfxItemSet& rSet );
void SetBoxAttr( const SwCursor& rCursor, const SfxPoolItem &rNew );
/**
Retrieves a box attribute from the given cursor.
@return Whether the property is set over the current box selection.
@remarks A property is 'set' if it's set to the same value over all boxes in the current selection.
The property value is retrieved from the first box in the current selection. It is then compared to
the values of the same property over any other boxes in the selection; if any value is different from
that of the first box, the property is unset (and false is returned).
*/
static bool GetBoxAttr( const SwCursor& rCursor, SfxPoolItem &rToFill );
void SetBoxAlign( const SwCursor& rCursor, sal_uInt16 nAlign );
static sal_uInt16 GetBoxAlign( const SwCursor& rCursor );
void AdjustCellWidth( const SwCursor& rCursor, bool bBalance );
SwChainRet Chainable( const SwFrameFormat &rSource, const SwFrameFormat &rDest );
SwChainRet Chain( SwFrameFormat &rSource, const SwFrameFormat &rDest );
void Unchain( SwFrameFormat &rFormat );
// For Copy/Move from FrameShell.
SdrObject* CloneSdrObj( const SdrObject&, bool bMoveWithinDoc = false,
bool bInsInPage = true );
// FeShell - Interface end
// Interface for TextInputData - for text input of Chinese and Japanese.
SwExtTextInput* CreateExtTextInput( const SwPaM& rPam );
void DeleteExtTextInput( SwExtTextInput* pDel );
SwExtTextInput* GetExtTextInput( const SwNode& rNd,
sal_Int32 nContentPos = -1) const;
SwExtTextInput* GetExtTextInput() const;
// Interface for access to AutoComplete-List.
static SwAutoCompleteWord& GetAutoCompleteWords() { return *mpACmpltWords; }
bool ContainsMSVBasic() const { return mbContains_MSVBasic; }
void SetContainsMSVBasic( bool bFlag ) { mbContains_MSVBasic = bFlag; }
// Interface for the list of Ruby - texts/attributes
static sal_uInt16 FillRubyList( const SwPaM& rPam, SwRubyList& rList );
void SetRubyList( const SwPaM& rPam, const SwRubyList& rList );
void ReadLayoutCache( SvStream& rStream );
void WriteLayoutCache( SvStream& rStream );
SwLayoutCache* GetLayoutCache() const { return mpLayoutCache; }
/** Checks if any of the text node contains hidden characters.
Used for optimization. Changing the view option 'view hidden text'
has to trigger a reformatting only if some of the text is hidden.
*/
bool ContainsHiddenChars() const;
IGrammarContact* getGrammarContact() const { return mpGrammarContact; }
/** Marks/Unmarks a list level of a certain list
levels of a certain lists are marked now
@param sListId list Id of the list whose level has to be marked/unmarked
@param nListLevel level to mark
@param bValue - true mark the level
- false unmark the level
*/
void MarkListLevel( const OUString& sListId,
const int nListLevel,
const bool bValue );
// Change a format undoable.
void ChgFormat(SwFormat & rFormat, const SfxItemSet & rSet);
void RenameFormat(SwFormat & rFormat, const OUString & sNewName,
bool bBroadcast = false);
// Change a TOX undoable.
void ChgTOX(SwTOXBase & rTOX, const SwTOXBase & rNew);
/**
Returns a textual description of a PaM.
@param rPaM the PaM to describe
If rPaM only spans one paragraph the result is:
'<text in the PaM>'
<text in the PaM> is shortened to nUndoStringLength characters.
If rPaM spans more than one paragraph the result is:
paragraphs (STR_PARAGRAPHS)
@return the textual description of rPaM
*/
static OUString GetPaMDescr(const SwPaM & rPaM);
static bool IsFirstOfNumRuleAtPos( const SwPosition & rPos );
// access methods for XForms model(s)
// access container for XForms model; will be NULL if !isXForms()
const css::uno::Reference<css::container::XNameContainer>&
getXForms() const { return mxXForms;}
css::uno::Reference< css::linguistic2::XProofreadingIterator > const & GetGCIterator() const;
// #i31958# is this an XForms document?
bool isXForms() const;
// #i31958# initialize XForms models; turn this into an XForms document
void initXForms( bool bCreateDefaultModel );
// #i113606# for disposing XForms
void disposeXForms( );
//Update all the page masters
void SetDefaultPageMode(bool bSquaredPageMode);
bool IsSquaredPageMode() const;
css::uno::Reference< css::script::vba::XVBAEventProcessor > const & GetVbaEventProcessor();
void SetVBATemplateToProjectCache( css::uno::Reference< css::container::XNameContainer >& xCache ) { m_xTemplateToProjectCache = xCache; };
const css::uno::Reference< css::container::XNameContainer >& GetVBATemplateToProjectCache() { return m_xTemplateToProjectCache; };
::sfx2::IXmlIdRegistry& GetXmlIdRegistry();
::sw::MetaFieldManager & GetMetaFieldManager();
::sw::UndoManager & GetUndoManager();
::sw::UndoManager const& GetUndoManager() const;
SfxObjectShell* CreateCopy(bool bCallInitNew, bool bEmpty) const;
SwNodeIndex AppendDoc(const SwDoc& rSource, sal_uInt16 nStartPageNumber,
bool bDeletePrevious, int physicalPageOffset,
const sal_uLong nDocNo = 1);
/**
* Dumps the entire nodes structure to the given destination (file nodes.xml in the current directory by default)
* @since 3.5
*/
void dumpAsXml(struct _xmlTextWriter* = nullptr) const;
std::set<Color> GetDocColors();
std::vector< std::weak_ptr<SwUnoCursor> > mvUnoCursorTable;
// Remove expired UnoCursor weak pointers the document keeps to notify about document death.
void cleanupUnoCursorTable() const
{
auto & rTable = const_cast<SwDoc*>(this)->mvUnoCursorTable;
// In most cases we'll remove most of the elements.
rTable.erase( std::remove_if(rTable.begin(),
rTable.end(),
[] (std::weak_ptr<SwUnoCursor> const & x) { return x.expired(); }),
rTable.end());
}
private:
// Copies master header to left / first one, if necessary - used by ChgPageDesc().
void CopyMasterHeader(const SwPageDesc &rChged, const SwFormatHeader &rHead, SwPageDesc &pDesc, bool bLeft, bool bFirst);
// Copies master footer to left / first one, if necessary - used by ChgPageDesc().
void CopyMasterFooter(const SwPageDesc &rChged, const SwFormatFooter &rFoot, SwPageDesc &pDesc, bool bLeft, bool bFirst);
};
// This method is called in Dtor of SwDoc and deletes cache of ContourObjects.
void ClrContourCache();
inline const SwTableNode* SwDoc::IsIdxInTable( const SwNodeIndex& rIdx ) const
{
return const_cast<SwDoc*>(this)->IsIdxInTable( rIdx );
}
inline SvNumberFormatter* SwDoc::GetNumberFormatter( bool bCreate )
{
if( bCreate && !mpNumberFormatter )
CreateNumberFormatter();
return mpNumberFormatter;
}
inline const SvNumberFormatter* SwDoc::GetNumberFormatter( bool bCreate ) const
{
return const_cast<SwDoc*>(this)->GetNumberFormatter( bCreate );
}
inline void SwDoc::SetOLEPrtNotifyPending( bool bSet )
{
mbOLEPrtNotifyPending = bSet;
if( !bSet )
mbAllOLENotify = false;
}
bool sw_GetPostIts( IDocumentFieldsAccess* pIDFA, SetGetExpFields * pSrtLst );
#endif //_DOC_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|