/* -*- 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 SC_DOCSHELL_HXX #define SC_DOCSHELL_HXX #include #include #include #include #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 #include #include #include 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 SC_DLLPRIVATE void InitItems(); SC_DLLPRIVATE void DoEnterHandler(); SC_DLLPRIVATE void InitOptions(bool bForLoading); SC_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; }; SC_DLLPRIVATE sal_Bool LoadXML( SfxMedium* pMedium, const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& ); SC_DLLPRIVATE sal_Bool SaveXML( SfxMedium* pMedium, const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& ); SC_DLLPRIVATE SCTAB GetSaveTab(); SC_DLLPRIVATE bool SaveCurrentChart( SfxMedium& rMedium ); SC_DLLPRIVATE sal_uLong DBaseImport( const OUString& rFullFileName, rtl_TextEncoding eCharSet, ScColWidthParam aColWidthParam[MAXCOLCOUNT], ScFlatBoolRowSegments& rRowHeightsRecalc ); SC_DLLPRIVATE sal_uLong DBaseExport( const OUString& rFullFileName, rtl_TextEncoding eCharSet, bool& bHasMemo ); SC_DLLPRIVATE static bool MoveFile( const INetURLObject& rSource, const INetURLObject& rDest ); SC_DLLPRIVATE static bool KillFile( const INetURLObject& rURL ); SC_DLLPRIVATE static bool IsDocument( const INetURLObject& rURL ); SC_DLLPRIVATE void LockPaint_Impl(sal_Bool bDoc); SC_DLLPRIVATE void UnlockPaint_Impl(sal_Bool bDoc); SC_DLLPRIVATE void LockDocument_Impl(sal_uInt16 nNew); SC_DLLPRIVATE void UnlockDocument_Impl(sal_uInt16 nNew); SC_DLLPRIVATE void EnableSharedSettings( bool bEnable ); SC_DLLPRIVATE ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > LoadSharedDocument(); SC_DLLPRIVATE void UseSheetSaveEntries(); SC_DLLPRIVATE ScDocFunc *CreateDocFunc(); protected: virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ); public: TYPEINFO(); SFX_DECL_INTERFACE(SCID_DOC_SHELL) SFX_DECL_OBJECTFACTORY(); ScDocShell( const ScDocShell& rDocShell ); ScDocShell( const sal_uInt64 i_nSfxCreationFlags = SFXMODEL_EMBEDDED_OBJECT ); ~ScDocShell(); using SotObject::GetInterface; using SfxShell::Activate; // with sal_Bool bMDI using SfxShell::Deactivate; // with sal_Bool bMDI #if ENABLE_TELEPATHY SC_DLLPRIVATE ScCollaboration* GetCollaboration(); #endif virtual void Activate(); virtual void Deactivate(); virtual ::svl::IUndoManager* GetUndoManager(); virtual void FillClass( SvGlobalName * pClassName, sal_uInt32 * pFormat, OUString * pAppName, OUString * pFullTypeName, OUString * pShortTypeName, sal_Int32 nFileFormat, sal_Bool bTemplate = false ) const; virtual sal_Bool InitNew( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& ); virtual sal_Bool Load( SfxMedium& rMedium ); virtual sal_Bool LoadFrom( SfxMedium& rMedium ); virtual sal_Bool ConvertFrom( SfxMedium &rMedium ); virtual bool LoadExternal( SfxMedium& rMedium ); virtual sal_Bool Save(); virtual sal_Bool SaveAs( SfxMedium& rMedium ); virtual sal_Bool ConvertTo( SfxMedium &rMedium ); virtual sal_uInt16 PrepareClose( sal_Bool bUI = sal_True, sal_Bool bForBrowsing = false ); virtual void PrepareReload(); virtual sal_Bool IsInformationLost(); virtual void LoadStyles( SfxObjectShell &rSource ); virtual sal_Bool SaveCompleted( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& ); // SfxInPlaceObject virtual sal_Bool DoSaveCompleted( SfxMedium * pNewStor); // SfxObjectShell virtual sal_Bool QuerySlotExecutable( sal_uInt16 nSlotId ); virtual void Draw( OutputDevice *, const JobSetup & rSetup, sal_uInt16 nAspect = ASPECT_CONTENT ); virtual void SetVisArea( const Rectangle & rVisArea ); using SfxObjectShell::GetVisArea; virtual Rectangle GetVisArea( sal_uInt16 nAspect ) const; virtual Printer* GetDocumentPrinter(); virtual void SetModified( sal_Bool = sal_True ); void SetVisAreaOrSize( const Rectangle& rVisArea, sal_Bool bModifyStart ); virtual SfxDocumentInfoDialog* CreateDocumentInfoDialog( Window *pParent, const SfxItemSet &rSet ); void GetDocStat( ScDocStat& rDocStat ); ScDocument* GetDocument() { return &aDocument; } ScDocFunc& GetDocFunc() { return *pDocFunc; } void SetDocFunc( ScDocFunc *pDF ) { pDocFunc = pDF; } SfxPrinter* GetPrinter( sal_Bool bCreateIfNotExist = sal_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,sal_Bool bPrevNext=sal_True ); /// Protect/unprotect ChangeTrack and return if /// protection was successfully changed. /// If bJustQueryIfProtected==sal_True protection is not /// changed and is returned if not protected or /// password was entered correctly. bool ExecuteChangeProtectionDialog( Window* _pParent, sal_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, sal_Bool bApi ); void NotifyStyle( const SfxStyleSheetHint& rHint ); void DoAutoStyle( const ScRange& rRange, const OUString& rStyle ); Window* GetActiveDialogParent(); void ErrorMessage( sal_uInt16 nGlobStrId ); sal_Bool IsEditable() const; sal_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, sal_Bool bRecord = sal_True ); void UseScenario( SCTAB nTab, const OUString& rName, sal_Bool bRecord = sal_True ); SCTAB MakeScenario( SCTAB nTab, const OUString& rName, const OUString& rComment, const Color& rColor, sal_uInt16 nFlags, ScMarkData& rMark, sal_Bool bRecord = sal_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, sal_Bool bInsertNew, sal_Bool bNotifyAndPaint ); sal_Bool MoveTable( SCTAB nSrcTab, SCTAB nDestTab, sal_Bool bCopy, sal_Bool bRecord ); void DoRecalc( bool bApi ); void DoHardRecalc( bool bApi ); void UpdateOle( const ScViewData* pViewData, sal_Bool bSnapSize = false); sal_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); void UpdateLinks(); sal_Bool ReloadTabLinks(); void SetFormulaOptions(const ScFormulaOptions& rOpt ); virtual void CheckConfigOptions(); 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( sal_Bool bIsModified = sal_True ); void SetDrawModified( sal_Bool bIsModified = sal_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(); 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 long DdeGetData( const OUString& rItem, const OUString& rMimeType, ::com::sun::star::uno::Any & rValue ); virtual long DdeSetData( const OUString& rItem, const OUString& rMimeType, const ::com::sun::star::uno::Any & rValue ); virtual ::sfx2::SvLinkSource* DdeCreateLinkSource( const OUString& rItem ); const OUString& GetDdeTextFmt() const { return aDdeTextFmt; } SfxBindings* GetViewBindings(); ScTabViewShell* GetBestViewShell( sal_Bool bOnlyVisible = sal_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 sal_Bool HasAutomaticTableName( const OUString& rFilter ); DECL_LINK( RefreshDBDataHdl, ScRefreshTimer* ); void BeforeXMLLoading(); void AfterXMLLoading(sal_Bool bRet); virtual sal_uInt16 GetHiddenInformationState( sal_uInt16 nStates ); const ScOptSolverSave* GetSolverSaveData() const { return pSolverSaveData; } // may be null void SetSolverSaveData( const ScOptSolverSave& rData ); ScSheetSaveData* GetSheetSaveData(); void setDocAccTitle( const OUString& rTitle ) { aDocument.setDocAccTitle( rTitle ); } const OUString getDocAccTitle() const { return aDocument.getDocAccTitle(); } void setDocReadOnly(bool b) { aDocument.setDocReadOnly(b); } bool getDocReadOnly() const { return aDocument.getDocReadOnly(); } void ResetKeyBindings( ScOptionsUtil::KeyBindingType eType ); // password protection for Calc (derived from SfxObjectShell) // see also: FID_CHG_RECORD, SID_CHG_PROTECT virtual bool IsChangeRecording() const; virtual bool HasChangeRecordProtection() const; virtual void SetChangeRecording( bool bActivate ); virtual bool SetProtectionPassword( const OUString &rPassword ); virtual bool GetProtectionHash( /*out*/ ::com::sun::star::uno::Sequence< sal_Int8 > &rPasswordHash ); void SnapVisArea( Rectangle& rRect ) const; }; void UpdateAcceptChangesDialog(); SV_DECL_REF(ScDocShell) SV_IMPL_REF(ScDocShell) /** 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 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: */