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
|
/* -*- 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_SC_SOURCE_UI_INC_DOCSH_HXX
#define INCLUDED_SC_SOURCE_UI_INC_DOCSH_HXX
#include <sfx2/objsh.hxx>
#include <sfx2/docfac.hxx>
#include <sfx2/sfxmodelfactory.hxx>
#include <sfx2/viewsh.hxx>
#include "scdllapi.h"
#include "scdll.hxx"
#include "document.hxx"
#include "appoptio.hxx"
#include "formulaopt.hxx"
#include "shellids.hxx"
#include "optutil.hxx"
#include "docuno.hxx"
#include <boost/unordered_map.hpp>
#include <boost/scoped_ptr.hpp>
#include <cppuhelper/implbase1.hxx>
#include <config_telepathy.h>
class ScRefreshTimerProtector;
class ScEditEngineDefaulter;
class SfxStyleSheetBasePool;
class SfxStyleSheetHint;
class INetURLObject;
class ScViewData;
class ScDocFunc;
class ScDrawLayer;
class ScTabViewShell;
class ScSbxDocHelper;
class ScAutoStyleList;
class ScRange;
class ScMarkData;
class ScPaintLockData;
class ScChangeAction;
class VirtualDevice;
class ScImportOptions;
class ScDocShellModificator;
class ScOptSolverSave;
class ScRefreshTimer;
class ScSheetSaveData;
class ScFlatBoolRowSegments;
class HelperModelObj;
struct ScColWidthParam;
#if ENABLE_TELEPATHY
class ScCollaboration;
#endif
namespace sfx2 { class FileDialogHelper; }
struct DocShell_Impl;
typedef ::boost::unordered_map< sal_uLong, sal_uLong > ScChangeActionMergeMap;
//enum ScDBFormat { SC_FORMAT_SDF, SC_FORMAT_DBF };
// Extra flags for Repaint
#define SC_PF_LINES 1
#define SC_PF_TESTMERGE 2
#define SC_PF_WHOLEROWS 4
class SC_DLLPUBLIC ScDocShell: public SfxObjectShell, public SfxListener
{
ScDocument aDocument;
OUString aDdeTextFmt;
double nPrtToScreenFactor;
DocShell_Impl* pImpl;
ScDocFunc* pDocFunc;
bool bHeaderOn;
bool bFooterOn;
bool bIsInplace:1; // Is set by the View
bool bIsEmpty:1;
bool bIsInUndo:1;
bool bDocumentModifiedPending:1;
bool bUpdateEnabled:1;
sal_uInt16 nDocumentLock;
sal_Int16 nCanUpdate; // stores the UpdateDocMode from loading a document till update links
ScDBData* pOldAutoDBRange;
ScSbxDocHelper* pDocHelper;
ScAutoStyleList* pAutoStyleList;
ScPaintLockData* pPaintLockData;
ScOptSolverSave* pSolverSaveData;
ScSheetSaveData* pSheetSaveData;
ScDocShellModificator* pModificator; // #109979#; is used to load XML (created in BeforeXMLLoading and destroyed in AfterXMLLoading)
#if ENABLE_TELEPATHY
ScCollaboration* mpCollaboration;
#endif
SAL_DLLPRIVATE void InitItems();
SAL_DLLPRIVATE void DoEnterHandler();
SAL_DLLPRIVATE void InitOptions(bool bForLoading);
SAL_DLLPRIVATE void ResetDrawObjectShell();
// SUNWS needs a forward declared friend, otherwise types and members
// of the outer class are not accessible.
class PrepareSaveGuard;
friend class ScDocShell::PrepareSaveGuard;
/** Do things that need to be done before saving to our own format and
necessary clean ups in dtor. */
class PrepareSaveGuard
{
public:
explicit PrepareSaveGuard( ScDocShell & rDocShell );
~PrepareSaveGuard();
private:
ScDocShell & mrDocShell;
};
SAL_DLLPRIVATE bool LoadXML( SfxMedium* pMedium, const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& );
SAL_DLLPRIVATE bool SaveXML( SfxMedium* pMedium, const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& );
SAL_DLLPRIVATE SCTAB GetSaveTab();
SAL_DLLPRIVATE bool SaveCurrentChart( SfxMedium& rMedium );
SAL_DLLPRIVATE sal_uLong DBaseImport( const OUString& rFullFileName, rtl_TextEncoding eCharSet,
ScColWidthParam aColWidthParam[MAXCOLCOUNT], ScFlatBoolRowSegments& rRowHeightsRecalc );
SAL_DLLPRIVATE sal_uLong DBaseExport(
const OUString& rFullFileName, rtl_TextEncoding eCharSet, bool& bHasMemo );
SAL_DLLPRIVATE static bool MoveFile( const INetURLObject& rSource, const INetURLObject& rDest );
SAL_DLLPRIVATE static bool KillFile( const INetURLObject& rURL );
SAL_DLLPRIVATE static bool IsDocument( const INetURLObject& rURL );
SAL_DLLPRIVATE void LockPaint_Impl(bool bDoc);
SAL_DLLPRIVATE void UnlockPaint_Impl(bool bDoc);
SAL_DLLPRIVATE void LockDocument_Impl(sal_uInt16 nNew);
SAL_DLLPRIVATE void UnlockDocument_Impl(sal_uInt16 nNew);
SAL_DLLPRIVATE void EnableSharedSettings( bool bEnable );
SAL_DLLPRIVATE ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > LoadSharedDocument();
SAL_DLLPRIVATE void UseSheetSaveEntries();
SAL_DLLPRIVATE ScDocFunc *CreateDocFunc();
protected:
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) SAL_OVERRIDE;
public:
TYPEINFO_OVERRIDE();
SFX_DECL_INTERFACE(SCID_DOC_SHELL)
SFX_DECL_OBJECTFACTORY();
private:
/// SfxInterface initializer.
static void InitInterface_Impl();
public:
ScDocShell( const ScDocShell& rDocShell );
ScDocShell( const sal_uInt64 i_nSfxCreationFlags = SFXMODEL_EMBEDDED_OBJECT );
virtual ~ScDocShell();
using SotObject::GetInterface;
using SfxShell::Activate; // with sal_Bool bMDI
using SfxShell::Deactivate; // with sal_Bool bMDI
#if ENABLE_TELEPATHY
SAL_DLLPRIVATE ScCollaboration* GetCollaboration();
#endif
virtual void Activate();
virtual void Deactivate();
virtual ::svl::IUndoManager*
GetUndoManager() SAL_OVERRIDE;
virtual void FillClass( SvGlobalName * pClassName,
sal_uInt32 * pFormat,
OUString * pAppName,
OUString * pFullTypeName,
OUString * pShortTypeName,
sal_Int32 nFileFormat,
bool bTemplate = false ) const SAL_OVERRIDE;
virtual bool InitNew( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& ) SAL_OVERRIDE;
virtual bool Load( SfxMedium& rMedium ) SAL_OVERRIDE;
virtual bool LoadFrom( SfxMedium& rMedium ) SAL_OVERRIDE;
virtual bool ConvertFrom( SfxMedium &rMedium ) SAL_OVERRIDE;
virtual bool LoadExternal( SfxMedium& rMedium ) SAL_OVERRIDE;
virtual bool Save() SAL_OVERRIDE;
virtual bool SaveAs( SfxMedium& rMedium ) SAL_OVERRIDE;
virtual bool ConvertTo( SfxMedium &rMedium ) SAL_OVERRIDE;
virtual bool PrepareClose( bool bUI = true ) SAL_OVERRIDE;
virtual void PrepareReload() SAL_OVERRIDE;
virtual bool IsInformationLost() SAL_OVERRIDE;
virtual void LoadStyles( SfxObjectShell &rSource ) SAL_OVERRIDE;
virtual bool SaveCompleted( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& ) SAL_OVERRIDE; // SfxInPlaceObject
virtual bool DoSaveCompleted( SfxMedium * pNewStor) SAL_OVERRIDE; // SfxObjectShell
virtual bool QuerySlotExecutable( sal_uInt16 nSlotId ) SAL_OVERRIDE;
virtual void Draw( OutputDevice *, const JobSetup & rSetup,
sal_uInt16 nAspect = ASPECT_CONTENT ) SAL_OVERRIDE;
virtual void SetVisArea( const Rectangle & rVisArea ) SAL_OVERRIDE;
using SfxObjectShell::GetVisArea;
virtual Rectangle GetVisArea( sal_uInt16 nAspect ) const SAL_OVERRIDE;
virtual Printer* GetDocumentPrinter() SAL_OVERRIDE;
virtual void SetModified( bool = true ) SAL_OVERRIDE;
void SetVisAreaOrSize( const Rectangle& rVisArea, bool bModifyStart );
virtual SfxDocumentInfoDialog* CreateDocumentInfoDialog( Window *pParent,
const SfxItemSet &rSet ) SAL_OVERRIDE;
void GetDocStat( ScDocStat& rDocStat );
ScDocument* GetDocument() { return &aDocument; }
ScDocFunc& GetDocFunc() { return *pDocFunc; }
void SetDocFunc( ScDocFunc *pDF ) { pDocFunc = pDF; }
SfxPrinter* GetPrinter( bool bCreateIfNotExist = true );
sal_uInt16 SetPrinter( SfxPrinter* pNewPrinter, sal_uInt16 nDiffFlags = SFX_PRINTER_ALL );
void UpdateFontList();
OUString CreateObjectName( const OUString& rPrefix );
ScDrawLayer* MakeDrawLayer();
void AsciiSave( SvStream& rStream, const ScImportOptions& rOpt );
void GetSbxState( SfxItemSet &rSet );
void GetDrawObjState( SfxItemSet &rSet );
void Execute( SfxRequest& rReq );
void GetState( SfxItemSet &rSet );
void ExecutePageStyle ( SfxViewShell& rCaller, SfxRequest& rReq, SCTAB nCurTab );
void GetStatePageStyle( SfxViewShell& rCaller, SfxItemSet& rSet, SCTAB nCurTab );
void CompareDocument( ScDocument& rOtherDoc );
void MergeDocument( ScDocument& rOtherDoc, bool bShared = false, bool bCheckDuplicates = false, sal_uLong nOffset = 0, ScChangeActionMergeMap* pMergeMap = NULL, bool bInverseMap = false );
bool MergeSharedDocument( ScDocShell* pSharedDocShell );
ScChangeAction* GetChangeAction( const ScAddress& rPos );
void SetChangeComment( ScChangeAction* pAction, const OUString& rComment );
void ExecuteChangeCommentDialog( ScChangeAction* pAction, Window* pParent, bool bPrevNext = true );
/// Protect/unprotect ChangeTrack and return <TRUE/> if
/// protection was successfully changed.
/// If bJustQueryIfProtected==sal_True protection is not
/// changed and <TRUE/> is returned if not protected or
/// password was entered correctly.
bool ExecuteChangeProtectionDialog( Window* _pParent, bool bJustQueryIfProtected = false );
void SetPrintZoom( SCTAB nTab, sal_uInt16 nScale, sal_uInt16 nPages );
bool AdjustPrintZoom( const ScRange& rRange );
void LoadStylesArgs( ScDocShell& rSource, bool bReplace, bool bCellStyles, bool bPageStyles );
void PageStyleModified( const OUString& rStyleName, bool bApi );
void NotifyStyle( const SfxStyleSheetHint& rHint );
void DoAutoStyle( const ScRange& rRange, const OUString& rStyle );
Window* GetActiveDialogParent();
void ErrorMessage( sal_uInt16 nGlobStrId );
bool IsEditable() const;
bool AdjustRowHeight( SCROW nStartRow, SCROW nEndRow, SCTAB nTab );
void UpdateAllRowHeights( const ScMarkData* pTabMark = NULL );
void UpdatePendingRowHeights( SCTAB nUpdateTab, bool bBefore = false );
void RefreshPivotTables( const ScRange& rSource );
void DoConsolidate( const ScConsolidateParam& rParam, bool bRecord = true );
void UseScenario( SCTAB nTab, const OUString& rName, bool bRecord = true );
SCTAB MakeScenario( SCTAB nTab, const OUString& rName, const OUString& rComment,
const Color& rColor, sal_uInt16 nFlags,
ScMarkData& rMark, bool bRecord = true );
void ModifyScenario( SCTAB nTab, const OUString& rName, const OUString& rComment,
const Color& rColor, sal_uInt16 nFlags );
sal_uLong TransferTab( ScDocShell& rSrcDocShell, SCTAB nSrcPos,
SCTAB nDestPos, bool bInsertNew,
bool bNotifyAndPaint );
bool MoveTable( SCTAB nSrcTab, SCTAB nDestTab, bool bCopy, bool bRecord );
void DoRecalc( bool bApi );
void DoHardRecalc( bool bApi );
void UpdateOle( const ScViewData* pViewData, bool bSnapSize = false);
bool IsOle();
void DBAreaDeleted( SCTAB nTab, SCCOL nX1, SCROW nY1, SCCOL nX2, SCROW nY2 );
ScDBData* GetDBData( const ScRange& rMarked, ScGetDBMode eMode, ScGetDBSelection eSel );
ScDBData* GetAnonymousDBData(const ScRange& rRange);
ScDBData* GetOldAutoDBRange(); // has to be deleted by caller!
void CancelAutoDBRange(); // called when dialog is cancelled
virtual void ReconnectDdeLink(SfxObjectShell& rServer) SAL_OVERRIDE;
void UpdateLinks() SAL_OVERRIDE;
bool ReloadTabLinks();
void SetFormulaOptions( const ScFormulaOptions& rOpt, bool bForLoading = false );
void SetCalcConfig( const ScCalcConfig& rConfig );
virtual void CheckConfigOptions() SAL_OVERRIDE;
void PostEditView( ScEditEngineDefaulter* pEditEngine, const ScAddress& rCursorPos );
void PostPaint( SCCOL nStartCol, SCROW nStartRow, SCTAB nStartTab,
SCCOL nEndCol, SCROW nEndRow, SCTAB nEndTab, sal_uInt16 nPart,
sal_uInt16 nExtFlags = 0 );
void PostPaint( const ScRangeList& rRanges, sal_uInt16 nPart, sal_uInt16 nExtFlags = 0 );
void PostPaintCell( SCCOL nCol, SCROW nRow, SCTAB nTab );
void PostPaintCell( const ScAddress& rPos );
void PostPaintGridAll();
void PostPaintExtras();
bool IsPaintLocked() const { return pPaintLockData != NULL; }
void PostDataChanged();
void UpdatePaintExt( sal_uInt16& rExtFlags, SCCOL nStartCol, SCROW nStartRow, SCTAB nStartTab,
SCCOL nEndCol, SCROW nEndRow, SCTAB nEndTab );
void UpdatePaintExt( sal_uInt16& rExtFlags, const ScRange& rRange );
void SetDocumentModified( bool bIsModified = true );
void SetDrawModified( bool bIsModified = true );
void LockPaint();
void UnlockPaint();
sal_uInt16 GetLockCount() const;
void SetLockCount(sal_uInt16 nNew);
void LockDocument();
void UnlockDocument();
DECL_LINK( DialogClosedHdl, sfx2::FileDialogHelper* );
virtual SfxStyleSheetBasePool* GetStyleSheetPool() SAL_OVERRIDE;
void SetInplace( bool bInplace );
bool IsEmpty() const;
void SetEmpty(bool bSet);
bool IsInUndo() const { return bIsInUndo; }
void SetInUndo(bool bSet);
void CalcOutputFactor();
double GetOutputFactor() const;
void GetPageOnFromPageStyleSet( const SfxItemSet* pStyleSet,
SCTAB nCurTab,
bool& rbHeader,
bool& rbFooter );
virtual bool DdeGetData( const OUString& rItem, const OUString& rMimeType,
::com::sun::star::uno::Any & rValue ) SAL_OVERRIDE;
virtual bool DdeSetData( const OUString& rItem, const OUString& rMimeType,
const ::com::sun::star::uno::Any & rValue ) SAL_OVERRIDE;
virtual ::sfx2::SvLinkSource* DdeCreateLinkSource( const OUString& rItem ) SAL_OVERRIDE;
const OUString& GetDdeTextFmt() const { return aDdeTextFmt; }
SfxBindings* GetViewBindings();
ScTabViewShell* GetBestViewShell( bool bOnlyVisible = true );
ScSbxDocHelper* GetDocHelperObject() { return pDocHelper; }
void SetDocumentModifiedPending( bool bVal )
{ bDocumentModifiedPending = bVal; }
bool IsDocumentModifiedPending() const
{ return bDocumentModifiedPending; }
bool IsUpdateEnabled() const
{ return bUpdateEnabled; }
void SetUpdateEnabled(bool bValue)
{ bUpdateEnabled = bValue; }
OutputDevice* GetRefDevice(); // WYSIWYG: Printer, otherwise VirtualDevice...
static ScViewData* GetViewData();
static SCTAB GetCurTab();
static ScDocShell* GetShellByNum( sal_uInt16 nDocNo );
static OUString GetOwnFilterName();
static OUString GetHtmlFilterName();
static OUString GetWebQueryFilterName();
static OUString GetAsciiFilterName();
static OUString GetLotusFilterName();
static OUString GetDBaseFilterName();
static OUString GetDifFilterName();
static bool HasAutomaticTableName( const OUString& rFilter );
DECL_LINK( RefreshDBDataHdl, ScRefreshTimer* );
void BeforeXMLLoading();
void AfterXMLLoading(bool bRet);
virtual sal_uInt16 GetHiddenInformationState( sal_uInt16 nStates ) SAL_OVERRIDE;
const ScOptSolverSave* GetSolverSaveData() const { return pSolverSaveData; } // may be null
void SetSolverSaveData( const ScOptSolverSave& rData );
ScSheetSaveData* GetSheetSaveData();
void ResetKeyBindings( ScOptionsUtil::KeyBindingType eType );
// password protection for Calc (derived from SfxObjectShell)
// see also: FID_CHG_RECORD, SID_CHG_PROTECT
virtual bool IsChangeRecording() const SAL_OVERRIDE;
virtual bool HasChangeRecordProtection() const SAL_OVERRIDE;
virtual void SetChangeRecording( bool bActivate ) SAL_OVERRIDE;
virtual bool SetProtectionPassword( const OUString &rPassword ) SAL_OVERRIDE;
virtual bool GetProtectionHash( /*out*/ ::com::sun::star::uno::Sequence< sal_Int8 > &rPasswordHash ) SAL_OVERRIDE;
void SnapVisArea( Rectangle& rRect ) const;
};
void UpdateAcceptChangesDialog();
class ScDocShell;
typedef tools::SvRef<ScDocShell> ScDocShellRef;
/** Create before modifications of the document and destroy thereafter.
Call SetDocumentModified() at an instance of this class instead of at
ScDocShell.
Remembers in the ctor ScDocument's AutoCalcShellDisabled and IdleDisabled,
switches them off and restores them in the dtor, AutoCalcShellDisabled
also before a ScDocShell::SetDocumentModified() call if necessary.
In the dtor, if ScDocShell's bDocumentModifiedPending is set and
bAutoCalcShellDisabled is not set, then ScDocShell::SetDocumentModified()
is called.
Several instances can be used in nested calls to ScDocFunc or ScDocShell
methods to avoid multiple modified status changes, only the last instance
destroyed calls ScDocShell::SetDocumentModified().
*/
class SC_DLLPUBLIC ScDocShellModificator
{
ScDocShell& rDocShell;
boost::scoped_ptr<ScRefreshTimerProtector> mpProtector;
bool bAutoCalcShellDisabled;
bool bIdleEnabled;
// not implemented
ScDocShellModificator( const ScDocShellModificator& );
ScDocShellModificator& operator=( const ScDocShellModificator& );
public:
ScDocShellModificator( ScDocShell& );
~ScDocShellModificator();
void SetDocumentModified();
};
//#i97876# Spreadsheet data changes are not notified
namespace HelperNotifyChanges
{
inline ScModelObj* getMustPropagateChangesModel(ScDocShell &rDocShell)
{
ScModelObj* pModelObj = ScModelObj::getImplementation(rDocShell.GetModel());
if (pModelObj && pModelObj->HasChangesListeners())
return pModelObj;
return NULL;
}
inline void Notify(ScModelObj &rModelObj, const ScRangeList &rChangeRanges,
const OUString &rType = OUString("cell-change"),
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& rProperties =
::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >())
{
rModelObj.NotifyChanges(rType, rChangeRanges, rProperties);
}
inline void NotifyIfChangesListeners(ScDocShell &rDocShell, const ScRange &rRange,
const OUString &rType = OUString("cell-change"))
{
if (ScModelObj* pModelObj = getMustPropagateChangesModel(rDocShell))
{
ScRangeList aChangeRanges;
aChangeRanges.Append(rRange);
Notify(*pModelObj, aChangeRanges, rType);
}
}
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
