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
|
/* -*- 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_SVX_SVDMODEL_HXX
#define INCLUDED_SVX_SVDMODEL_HXX
#include <com/sun/star/uno/Sequence.hxx>
#include <cppuhelper/weakref.hxx>
#include <editeng/forbiddencharacterstable.hxx>
#include <editeng/outliner.hxx>
#include <rtl/ustring.hxx>
#include <tools/link.hxx>
#include <tools/weakbase.hxx>
#include <vcl/mapmod.hxx>
#include <svl/SfxBroadcaster.hxx>
#include <tools/datetime.hxx>
#include <tools/fract.hxx>
#include <svl/hint.hxx>
#include <o3tl/typed_flags_set.hxx>
#include <svl/style.hxx>
#include <svx/xtable.hxx>
#include <svx/pageitem.hxx>
#include <vcl/field.hxx>
#include <LibreOfficeKit/LibreOfficeKitTypes.h>
class OutputDevice;
#include <svx/svdtypes.hxx>
#include <svx/svxdllapi.h>
#include <rtl/ref.hxx>
#include <deque>
#define DEGREE_CHAR ((sal_Unicode)0x00B0) /* U+00B0 DEGREE SIGN */
class SdrOutliner;
class SdrLayerAdmin;
class SdrObjList;
class SdrObject;
class SdrPage;
class SdrPageView;
class SdrTextObj;
class SdrUndoAction;
class SdrUndoGroup;
class AutoTimer;
class SfxItemPool;
class SfxItemSet;
class SfxRepeatTarget;
class SfxStyleSheet;
class SfxUndoAction;
class SfxUndoManager;
class XBitmapList;
class XColorList;
class XDashList;
class XGradientList;
class XHatchList;
class XLineEndList;
class SvxForbiddenCharactersTable;
class SvNumberFormatter;
class SdrOutlinerCache;
class SdrUndoFactory;
class ImageMap;
class TextChain;
namespace comphelper
{
class IEmbeddedHelper;
class LifecycleProxy;
}
namespace sfx2
{
class LinkManager;
}
enum class SdrSwapGraphicsMode
{
TEMP = 0x0001,
PURGE = 0x0100,
DEFAULT = TEMP | PURGE,
};
namespace o3tl
{
template<> struct typed_flags<SdrSwapGraphicsMode> : is_typed_flags<SdrSwapGraphicsMode, 0x0101> {};
}
enum SdrHintKind
{
HINT_UNKNOWN, // Unknown
HINT_LAYERCHG, // changed layer definition
HINT_LAYERORDERCHG, // order of layer changed (Insert/Remove/ChangePos)
HINT_PAGEORDERCHG, // order of pages (object pages or master pages) changed (Insert/Remove/ChangePos)
HINT_OBJCHG, // object changed
HINT_OBJINSERTED, // new object inserted
HINT_OBJREMOVED, // symbol object removed from list
HINT_MODELCLEARED, // deleted the whole model (no pages exist anymore). not impl.
HINT_REFDEVICECHG, // RefDevice changed
HINT_DEFAULTTABCHG, // Default tabulator width changed
HINT_DEFFONTHGTCHG, // Default FontHeight changed
HINT_MODELSAVED, // Document was saved
HINT_SWITCHTOPAGE, // #94278# UNDO/REDO at an object evtl. on another page
HINT_BEGEDIT, // Is called after the object has entered text edit mode
HINT_ENDEDIT // Is called after the object has left text edit mode
};
class SVX_DLLPUBLIC SdrHint: public SfxHint
{
public:
Rectangle maRectangle;
const SdrPage* mpPage;
const SdrObject* mpObj;
SdrHintKind meHint;
public:
explicit SdrHint(SdrHintKind eNewHint);
explicit SdrHint(const SdrObject& rNewObj);
void SetPage(const SdrPage* pNewPage);
void SetObject(const SdrObject* pNewObj);
void SetKind(SdrHintKind eNewKind);
const SdrPage* GetPage() const { return mpPage;}
const SdrObject* GetObject() const { return mpObj;}
SdrHintKind GetKind() const { return meHint;}
};
struct SdrModelImpl;
class SVX_DLLPUBLIC SdrModel : public SfxBroadcaster, public tools::WeakBase< SdrModel >, public OutlinerSearchable
{
protected:
std::vector<SdrPage*> maMaPag; // master pages
std::vector<SdrPage*> maPages;
Link<SdrUndoAction*,void> aUndoLink; // link to a NotifyUndo-Handler
OUString aTablePath;
Size aMaxObjSize; // e.g. for auto-growing text
Fraction aObjUnit; // description of the coordinate units for ClipBoard, Drag&Drop, ...
MapUnit eObjUnit; // see above
FieldUnit eUIUnit; // unit, scale (e.g. 1/1000) for the UI (status bar) is set by ImpSetUIUnit()
Fraction aUIScale; // see above
OUString aUIUnitStr; // see above
Fraction aUIUnitFact; // see above
int nUIUnitKomma; // see above
SdrLayerAdmin* pLayerAdmin;
SfxItemPool* pItemPool;
comphelper::IEmbeddedHelper*
m_pEmbeddedHelper; // helper for embedded objects to get rid of the SfxObjectShell
SdrOutliner* pDrawOutliner; // an Outliner for outputting text
SdrOutliner* pHitTestOutliner;// an Outliner for the HitTest
SdrOutliner* pChainingOutliner; // an Outliner for chaining overflowing text
sal_uIntPtr nDefTextHgt; // Default text height in logical units
VclPtr<OutputDevice> pRefOutDev; // ReferenceDevice for the EditEngine
LibreOfficeKitCallback mpLibreOfficeKitCallback;
void* mpLibreOfficeKitData;
/// Set if we are in the middle of a tiled search.
bool mbTiledSearching;
sal_uIntPtr nProgressAkt; // for the
sal_uIntPtr nProgressMax; // ProgressBar-
sal_uIntPtr nProgressOfs; // -Handler
rtl::Reference< SfxStyleSheetBasePool > mxStyleSheetPool;
SfxStyleSheet* pDefaultStyleSheet;
SfxStyleSheet* mpDefaultStyleSheetForSdrGrafObjAndSdrOle2Obj; // #i119287#
sfx2::LinkManager* pLinkManager; // LinkManager
std::deque<SfxUndoAction*>* pUndoStack;
std::deque<SfxUndoAction*>* pRedoStack;
SdrUndoGroup* pAktUndoGroup; // for deeper
sal_uInt16 nUndoLevel; // undo nesting
sal_uInt16 nProgressPercent; // for the ProgressBar-Handler
sal_uInt16 nLoadVersion; // version number of the loaded file
bool bMyPool:1; // to clean up pMyPool from 303a
bool bUIOnlyKomma:1; // see eUIUnit
bool mbUndoEnabled:1; // If false no undo is recorded or we are during the execution of an undo action
bool bExtColorTable:1; // ne separate ColorTable
bool mbChanged:1;
bool bInfoChanged:1;
bool bPagNumsDirty:1;
bool bMPgNumsDirty:1;
bool bTransportContainer:1; // doc is temporary object container, no display (e.g. clipboard)
bool bSavePortable:1; // save metafiles portably
bool bNoBitmapCaching:1; // cache bitmaps for screen output
bool bReadOnly:1;
bool bTransparentTextFrames:1;
bool bSaveCompressed:1;
bool bSwapGraphics:1;
bool bPasteResize:1; // Objects are being resized due to Paste with different MapMode
bool bSaveOLEPreview:1; // save preview metafile of OLE objects
bool bSaveNative:1;
bool bStarDrawPreviewMode:1;
bool mbDisableTextEditUsesCommonUndoManager:1;
SvStreamEndian nStreamNumberFormat;
sal_uInt16 nDefaultTabulator;
sal_uInt32 nMaxUndoCount;
TextChain* pTextChain;
// sdr::Comment interface
private:
// the next unique comment ID, used for counting added comments. Initialized
// to 0. UI shows one more due to the fact that 0 is a no-no for users.
sal_uInt32 mnUniqueCommentID;
public:
sal_uInt16 nStarDrawPreviewMasterPageNum;
SvxForbiddenCharactersTable* mpForbiddenCharactersTable;
SdrSwapGraphicsMode nSwapGraphicsMode;
SdrOutlinerCache* mpOutlinerCache;
//get a vector of all the SdrOutliner belonging to the model
std::vector<SdrOutliner*> GetActiveOutliners() const;
SdrModelImpl* mpImpl;
sal_uInt16 mnCharCompressType;
sal_uInt16 mnHandoutPageCount;
sal_uInt16 nReserveUInt6;
sal_uInt16 nReserveUInt7;
bool mbModelLocked;
bool mbKernAsianPunctuation;
bool mbAddExtLeading;
bool mbInDestruction;
// Color, Dash, Line-End, Hatch, Gradient, Bitmap property lists ...
XPropertyListRef maProperties[XPROPERTY_LIST_COUNT];
// New src638: NumberFormatter for drawing layer and
// method for getting it. It is constructed on demand
// and destroyed when destroying the SdrModel.
SvNumberFormatter* mpNumberFormatter;
public:
sal_uInt16 getHandoutPageCount() const { return mnHandoutPageCount; }
void setHandoutPageCount( sal_uInt16 nHandoutPageCount ) { mnHandoutPageCount = nHandoutPageCount; }
protected:
virtual css::uno::Reference< css::uno::XInterface > createUnoModel();
private:
SdrModel(const SdrModel& rSrcModel) = delete;
void operator=(const SdrModel& rSrcModel) = delete;
bool operator==(const SdrModel& rCmpModel) const = delete;
SVX_DLLPRIVATE void ImpPostUndoAction(SdrUndoAction* pUndo);
SVX_DLLPRIVATE void ImpSetUIUnit();
SVX_DLLPRIVATE void ImpSetOutlinerDefaults( SdrOutliner* pOutliner, bool bInit = false );
SVX_DLLPRIVATE void ImpReformatAllTextObjects();
SVX_DLLPRIVATE void ImpReformatAllEdgeObjects();
SVX_DLLPRIVATE void ImpCreateTables();
SVX_DLLPRIVATE void ImpCtor(SfxItemPool* pPool, ::comphelper::IEmbeddedHelper* pPers, bool bUseExtColorTable);
// this is a weak reference to a possible living api wrapper for this model
css::uno::Reference< css::uno::XInterface > mxUnoModel;
public:
SVX_DLLPRIVATE virtual bool IsCreatingDataObj() const { return false; }
bool IsTransportContainer() const { return bTransportContainer; }
bool IsPasteResize() const { return bPasteResize; }
void SetPasteResize(bool bOn) { bPasteResize=bOn; }
// If a custom Pool is put here, the class will call methods
// on it (Put(), Remove()). On disposal of SdrModel the pool
// will be deleted with delete.
// If you give NULL instead, it will create an own pool (SdrItemPool)
// which will also be disposed in the destructor.
// If you do use a custom Pool, make sure you inherit from SdrItemPool,
// if you want to use symbol objects inherited from SdrAttrObj.
// If, however, you use objects inheriting from SdrObject you are free
// to chose a pool of your liking.
explicit SdrModel();
explicit SdrModel(SfxItemPool* pPool, ::comphelper::IEmbeddedHelper* pPers, bool bUseExtColorTable);
explicit SdrModel(const OUString& rPath, SfxItemPool* pPool, ::comphelper::IEmbeddedHelper* pPers, bool bUseExtColorTable);
virtual ~SdrModel();
void ClearModel(bool bCalledFromDestructor);
// Override this to enable the Swap/LoadOnDemand of graphics.
// If rbDeleteAfterUse is set to sal_True the SvStream instance from
// the caller will be disposed after use.
// If this method returns NULL, a temporary file will be allocated for
// swapping.
// The stream from which the model was loaded or in which is was saved last
// needs to be delivered
virtual css::uno::Reference<
css::embed::XStorage> GetDocumentStorage() const;
css::uno::Reference<
css::io::XInputStream >
GetDocumentStream(OUString const& rURL,
::comphelper::LifecycleProxy & rProxy) const;
// Change the template attributes of the symbol objects to hard attributes
void BurnInStyleSheetAttributes();
// If you inherit from SdrPage you also need to inherit from SdrModel
// and implement both VM AllocPage() and AllocModel()...
virtual SdrPage* AllocPage(bool bMasterPage);
virtual SdrModel* AllocModel() const;
// Changes on the layers set the modified flag and broadcast on the model!
const SdrLayerAdmin& GetLayerAdmin() const { return *pLayerAdmin; }
SdrLayerAdmin& GetLayerAdmin() { return *pLayerAdmin; }
const SfxItemPool& GetItemPool() const { return *pItemPool; }
SfxItemPool& GetItemPool() { return *pItemPool; }
SdrOutliner& GetDrawOutliner(const SdrTextObj* pObj=nullptr) const;
SdrOutliner& GetHitTestOutliner() const { return *pHitTestOutliner; }
const SdrTextObj* GetFormattingTextObj() const;
// put the TextDefaults (Font,Height,Color) in a Set
void SetTextDefaults() const;
static void SetTextDefaults( SfxItemPool* pItemPool, sal_uIntPtr nDefTextHgt );
SdrOutliner& GetChainingOutliner(const SdrTextObj* pObj=nullptr) const;
TextChain * GetTextChain() const;
// ReferenceDevice for the EditEngine
void SetRefDevice(OutputDevice* pDev);
OutputDevice* GetRefDevice() const { return pRefOutDev.get(); }
/// The actual implementation of the vcl::ITiledRenderable::registerCallback() API.
void registerLibreOfficeKitCallback(LibreOfficeKitCallback pCallback, void* pLibreOfficeKitData);
/// Gets the LOK data registered by registerLibreOfficeKitCallback().
void* getLibreOfficeKitData() const;
/// Invokes the registered callback, if there are any.
void libreOfficeKitCallback(int nType, const char* pPayload) const override;
/// Set if we are doing tiled searching.
void setTiledSearching(bool bTiledSearching);
/// Are we doing tiled searching?
bool isTiledSearching() const;
// If a new MapMode is set on the RefDevice (or similar)
void RefDeviceChanged(); // not yet implemented
// default font height in logical units
void SetDefaultFontHeight(sal_uIntPtr nVal);
sal_uIntPtr GetDefaultFontHeight() const { return nDefTextHgt; }
// default tabulator width for the EditEngine
void SetDefaultTabulator(sal_uInt16 nVal);
sal_uInt16 GetDefaultTabulator() const { return nDefaultTabulator; }
// The DefaultStyleSheet will be used in every symbol object which is inserted
// in this model and does not have a StyleSheet set.
SfxStyleSheet* GetDefaultStyleSheet() const { return pDefaultStyleSheet; }
void SetDefaultStyleSheet(SfxStyleSheet* pDefSS) { pDefaultStyleSheet = pDefSS; }
// #i119287# default StyleSheet for SdrGrafObj and SdrOle2Obj
SfxStyleSheet* GetDefaultStyleSheetForSdrGrafObjAndSdrOle2Obj() const { return mpDefaultStyleSheetForSdrGrafObjAndSdrOle2Obj; }
void SetDefaultStyleSheetForSdrGrafObjAndSdrOle2Obj(SfxStyleSheet* pDefSS) { mpDefaultStyleSheetForSdrGrafObjAndSdrOle2Obj = pDefSS; }
sfx2::LinkManager* GetLinkManager() { return pLinkManager; }
void SetLinkManager( sfx2::LinkManager* pLinkMgr ) { pLinkManager = pLinkMgr; }
::comphelper::IEmbeddedHelper* GetPersist() const { return m_pEmbeddedHelper; }
void SetPersist( ::comphelper::IEmbeddedHelper *p ) { m_pEmbeddedHelper = p; }
// Unit for the symbol coordination
// Default is 1 logical unit = 1/100mm (Unit=MAP_100TH_MM, Fract=(1,1)).
// Examples:
// MAP_POINT, Fraction(72,1) : 1 log Einh = 72 Point = 1 Inch
// MAP_POINT, Fraction(1,20) : 1 log Einh = 1/20 Point = 1 Twip
// MAP_TWIP, Fraction(1,1) : 1 log Einh = 1 Twip
// MAP_100TH_MM, Fraction(1,10) : 1 log Einh = 1/1000mm
// MAP_MM, Fraction(1000,1) : 1 log Einh = 1000mm = 1m
// MAP_CM, Fraction(100,1) : 1 log Einh = 100cm = 1m
// MAP_CM, Fraction(100000,1): 1 log Einh = 100000cm = 1km
// (FWIW: you cannot represent light years).
// The scaling unit is needed for the Engine to serve the Clipboard
// with the correct sizes.
MapUnit GetScaleUnit() const { return eObjUnit; }
void SetScaleUnit(MapUnit eMap);
const Fraction& GetScaleFraction() const { return aObjUnit; }
void SetScaleFraction(const Fraction& rFrac);
// Setting both simultaneously performs a little better
void SetScaleUnit(MapUnit eMap, const Fraction& rFrac);
// maximal size e.g. for auto growing texts
const Size& GetMaxObjSize() const { return aMaxObjSize; }
void SetMaxObjSize(const Size& rSiz) { aMaxObjSize=rSiz; }
// For the View! to display sane numbers in the status bar: Default is mm.
void SetUIUnit(FieldUnit eUnit);
FieldUnit GetUIUnit() const { return eUIUnit; }
// The scale of the drawing. Default 1/1.
void SetUIScale(const Fraction& rScale);
const Fraction& GetUIScale() const { return aUIScale; }
// Setting both simultaneously performs a little better
void SetUIUnit(FieldUnit eUnit, const Fraction& rScale);
static void TakeUnitStr(FieldUnit eUnit, OUString& rStr);
void TakeMetricStr(long nVal, OUString& rStr, bool bNoUnitChars = false, sal_Int32 nNumDigits = -1) const;
static void TakeAngleStr(long nAngle, OUString& rStr, bool bNoDegChar = false);
static void TakePercentStr(const Fraction& rVal, OUString& rStr);
// RecalcPageNums is ordinarily only called by the Page.
bool IsPagNumsDirty() const { return bPagNumsDirty; };
bool IsMPgNumsDirty() const { return bMPgNumsDirty; };
void RecalcPageNums(bool bMaster);
// After the Insert the Page belongs to the SdrModel.
virtual void InsertPage(SdrPage* pPage, sal_uInt16 nPos=0xFFFF);
virtual void DeletePage(sal_uInt16 nPgNum);
// Remove means transferring ownership to the caller (opposite of Insert)
virtual SdrPage* RemovePage(sal_uInt16 nPgNum);
virtual void MovePage(sal_uInt16 nPgNum, sal_uInt16 nNewPos);
const SdrPage* GetPage(sal_uInt16 nPgNum) const;
SdrPage* GetPage(sal_uInt16 nPgNum);
sal_uInt16 GetPageCount() const;
virtual void PageListChanged();
// Masterpages
virtual void InsertMasterPage(SdrPage* pPage, sal_uInt16 nPos=0xFFFF);
void DeleteMasterPage(sal_uInt16 nPgNum);
// Remove means transferring ownership to the caller (opposite of Insert)
virtual SdrPage* RemoveMasterPage(sal_uInt16 nPgNum);
void MoveMasterPage(sal_uInt16 nPgNum, sal_uInt16 nNewPos);
const SdrPage* GetMasterPage(sal_uInt16 nPgNum) const;
SdrPage* GetMasterPage(sal_uInt16 nPgNum);
sal_uInt16 GetMasterPageCount() const;
virtual void MasterPageListChanged();
// modified flag. Is set automatically when something changes on the Pages
// symbol objects. You need to reset it yourself, however, e.g. on Save().
bool IsChanged() const { return mbChanged; }
virtual void SetChanged(bool bFlg = true);
// If set to sal_True, graphics from graphics objects will:
// - not be loaded immediately when loading a document,
// but only once they are needed (e.g. displayed).
// - be pruned from memory if they are not needed.
// For that to work, override the virtual method GetDocumentStream().
// Default=FALSE. Flag is not persistent.
bool IsSwapGraphics() const { return bSwapGraphics; }
void SetSwapGraphics();
void SetSwapGraphicsMode(SdrSwapGraphicsMode nMode) { nSwapGraphicsMode = nMode; }
SdrSwapGraphicsMode GetSwapGraphicsMode() const { return nSwapGraphicsMode; }
bool IsSaveOLEPreview() const { return bSaveOLEPreview; }
// Text frames without filling can be select with a mouse click by default (sal_False).
// With this flag set to true you can hit them only in the area in which text is to be
// found.
bool IsPickThroughTransparentTextFrames() const { return bTransparentTextFrames; }
void SetPickThroughTransparentTextFrames(bool bOn) { bTransparentTextFrames=bOn; }
// Can the model be changed at all?
// Is only evaluated by the possibility methods of the View.
// Direct manipulations on the model, ... do not respect this flag.
// Override this and return the appropriate ReadOnly status
// of the files, i.e. true or false. (Method is called multiple
// times, so use one flag only!)
virtual bool IsReadOnly() const;
void SetReadOnly(bool bYes);
// Mixing two SdrModels. Mind that rSourceModel is not const.
// The pages will not be copied but moved, when inserted.
// rSourceModel may very well be empty afterwards.
// nFirstPageNum,nLastPageNum: The pages to take from rSourceModel
// nDestPos..................: position to insert
// bMergeMasterPages.........: sal_True = needed MasterPages will be taken
// from rSourceModel
// sal_False= the MasterPageDescriptors of
// the pages of the rSourceModel will be
// mapped on the exisiting MasterPages.
// bUndo.....................: An undo action is generated for the merging.
// Undo is only for the target model, not for the
// rSourceModel.
// bTreadSourceAsConst.......: sal_True=the SourceModel will not be changed,
// so pages will be copied.
virtual void Merge(SdrModel& rSourceModel,
sal_uInt16 nFirstPageNum=0, sal_uInt16 nLastPageNum=0xFFFF,
sal_uInt16 nDestPos=0xFFFF,
bool bMergeMasterPages = false, bool bAllMasterPages = false,
bool bUndo = true, bool bTreadSourceAsConst = false);
// Behaves like Merge(SourceModel=DestModel,nFirst,nLast,nDest,sal_False,sal_False,bUndo,!bMoveNoCopy);
void CopyPages(sal_uInt16 nFirstPageNum, sal_uInt16 nLastPageNum,
sal_uInt16 nDestPos,
bool bUndo = true, bool bMoveNoCopy = false);
// BegUndo() / EndUndo() enables you to group arbitrarily many UndoActions
// arbitrarily deeply. As comment for the UndoAction the first BegUndo(String) of all
// nestings will be used.
// In that case the NotifyUndoActionHdl will be called on the last EndUndo().
// No UndoAction will be generated for an empty group.
// All direct modifications on the SdrModel do not create an UndoActions.
// Actions on the SdrView however do generate those.
void BegUndo(); // open Undo group
void BegUndo(const OUString& rComment); // open Undo group
void BegUndo(const OUString& rComment, const OUString& rObjDescr, SdrRepeatFunc eFunc=SDRREPFUNC_OBJ_NONE); // open Undo group
void EndUndo(); // close Undo group
void AddUndo(SdrUndoAction* pUndo);
sal_uInt16 GetUndoBracketLevel() const { return nUndoLevel; }
// only after the first BegUndo or before the last EndUndo:
void SetUndoComment(const OUString& rComment);
void SetUndoComment(const OUString& rComment, const OUString& rObjDescr);
// The Undo management is only done if not NotifyUndoAction-Handler is set.
// Default is 16. Minimal MaxUndoActionCount is 1!
void SetMaxUndoActionCount(sal_uIntPtr nCount);
void ClearUndoBuffer();
bool HasUndoActions() const;
bool HasRedoActions() const;
void Undo();
void Redo();
void Repeat(SfxRepeatTarget&);
// The application can set a handler here which collects the UndoActions einsammelt.
// The handler has the following signature:
// void NotifyUndoActionHdl(SfxUndoAction* pUndoAction);
// When calling the handler ownership is transferred;
// The UndoAction belongs to the Handler, not the SdrModel.
void SetNotifyUndoActionHdl(const Link<SdrUndoAction*,void>& rLink) { aUndoLink=rLink; }
/** application can set its own undo manager, BegUndo, EndUndo and AddUndoAction
calls are routed to this interface if given */
void SetSdrUndoManager( SfxUndoManager* pUndoManager );
SfxUndoManager* GetSdrUndoManager() const;
/** applications can set their own undo factory to override creation of
undo actions. The SdrModel will become owner of the given SdrUndoFactory
and delete it upon its destruction. */
void SetSdrUndoFactory( SdrUndoFactory* pUndoFactory );
/** returns the models undo factory. This must be used to create
undo actions for this model. */
SdrUndoFactory& GetSdrUndoFactory() const;
// Accessor methods for Palettes, Lists and Tables
// FIXME: this badly needs re-factoring...
XPropertyListRef GetPropertyList( XPropertyListType t ) const { return maProperties[ t ]; }
void SetPropertyList( XPropertyListRef p ) { maProperties[ p->Type() ] = p; }
// friendlier helpers
XDashListRef GetDashList() const { return XPropertyList::AsDashList(GetPropertyList( XDASH_LIST )); }
XHatchListRef GetHatchList() const { return XPropertyList::AsHatchList(GetPropertyList( XHATCH_LIST )); }
XColorListRef GetColorList() const { return XPropertyList::AsColorList(GetPropertyList( XCOLOR_LIST )); }
XBitmapListRef GetBitmapList() const { return XPropertyList::AsBitmapList(GetPropertyList( XBITMAP_LIST )); }
XLineEndListRef GetLineEndList() const { return XPropertyList::AsLineEndList(GetPropertyList( XLINE_END_LIST )); }
XGradientListRef GetGradientList() const { return XPropertyList::AsGradientList(GetPropertyList( XGRADIENT_LIST )); }
// The DrawingEngine only references the StyleSheetPool, whoever
// made it needs to delete it.
SfxStyleSheetBasePool* GetStyleSheetPool() const { return mxStyleSheetPool.get(); }
void SetStyleSheetPool(SfxStyleSheetBasePool* pPool) { mxStyleSheetPool=pPool; }
void SetStarDrawPreviewMode(bool bPreview);
bool IsStarDrawPreviewMode() { return bStarDrawPreviewMode; }
bool GetDisableTextEditUsesCommonUndoManager() const { return mbDisableTextEditUsesCommonUndoManager; }
void SetDisableTextEditUsesCommonUndoManager(bool bNew) { mbDisableTextEditUsesCommonUndoManager = bNew; }
css::uno::Reference< css::uno::XInterface > getUnoModel();
void setUnoModel( const css::uno::Reference< css::uno::XInterface >& xModel );
// these functions are used by the api to disable repaints during a
// set of api calls.
bool isLocked() const { return mbModelLocked; }
void setLock( bool bLock );
void SetForbiddenCharsTable( const rtl::Reference<SvxForbiddenCharactersTable>& xForbiddenChars );
rtl::Reference<SvxForbiddenCharactersTable> GetForbiddenCharsTable() const { return mpForbiddenCharactersTable;}
void SetCharCompressType( sal_uInt16 nType );
sal_uInt16 GetCharCompressType() const { return mnCharCompressType; }
void SetKernAsianPunctuation( bool bEnabled );
bool IsKernAsianPunctuation() const { return mbKernAsianPunctuation; }
void SetAddExtLeading( bool bEnabled );
bool IsAddExtLeading() const { return mbAddExtLeading; }
void ReformatAllTextObjects();
SdrOutliner* createOutliner( sal_uInt16 nOutlinerMode );
void disposeOutliner( SdrOutliner* pOutliner );
bool IsWriter() const { return !bMyPool; }
/** returns the numbering type that is used to format page fields in drawing shapes */
virtual SvxNumType GetPageNumType() const;
/** copies the items from the source set to the destination set. Both sets must have
same ranges but can have different pools. */
static void MigrateItemSet( const SfxItemSet* pSourceSet, SfxItemSet* pDestSet, SdrModel* pNewModel );
bool IsInDestruction() const { return mbInDestruction;}
static const css::uno::Sequence< sal_Int8 >& getUnoTunnelImplementationId();
virtual ImageMap* GetImageMapForObject(SdrObject*){return nullptr;};
/** enables (true) or disables (false) recording of undo actions
If undo actions are added while undo is disabled, they are deleted.
Disabling undo does not clear the current undo buffer! */
void EnableUndo( bool bEnable );
/** returns true if undo is currently enabled
This returns false if undo was disabled using EnableUndo( false ) and
also during the runtime of the Undo() and Redo() methods. */
bool IsUndoEnabled() const;
virtual void dumpAsXml(struct _xmlTextWriter* pWriter) const;
};
#endif // INCLUDED_SVX_SVDMODEL_HXX
/*
+-----------+
| SdrModel |
+--+------+-+
| +-----------+
+----+-----+ |
| ... | |
+----+---+ +----+---+ +-----+--------+
|SdrPage | |SdrPage | |SdrLayerAdmin |
+---+----+ +-+--+--++ +---+-------+--+
| | | | | +-------------------+
+----+----+ +-----+-----+ +-------+-------+
| ... | | ... | | ... |
+---+---+ +---+---+ +----+----+ +----+----+ +-----+------+ +------+-----+
|SdrObj | |SdrObj | |SdrLayer | |SdrLayer | |SdrLayerSet | |SdrLayerSet |
+-------+ +-------+ +---------+ +---------+ +------------+ +------------+
This class: SdrModel is the head of the data models for the StarView Drawing Engine.
///////////////////////////////////////////////////////////////////////////////////////////////// */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|