sc/source/ui/undo/areasave.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: areasave.cxx,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_sc.hxx"
  33
  34 // -----------------------------------------------------------------------
  35
  36
  37
  38 // INCLUDE ---------------------------------------------------------------
  39
  40 #include <svx/linkmgr.hxx>
  41 #include <tools/debug.hxx>
  42
  43 #include "areasave.hxx"
  44 #include "arealink.hxx"
  45 #include "document.hxx"
  46
  47 // -----------------------------------------------------------------------
  48
  49 ScAreaLinkSaver::ScAreaLinkSaver( const ScAreaLink& rSource ) :
  50     aFileName   ( rSource.GetFile() ),
  51     aFilterName ( rSource.GetFilter() ),
  52     aOptions    ( rSource.GetOptions() ),
  53     aSourceArea ( rSource.GetSource() ),
  54     aDestArea   ( rSource.GetDestArea() ),
  55     nRefresh    ( rSource.GetRefreshDelay() )       // seconds
  56 {
  57 }
  58
  59 ScAreaLinkSaver::ScAreaLinkSaver( const ScAreaLinkSaver& rCopy ) :
  60     ScDataObject(),
  61     aFileName   ( rCopy.aFileName ),
  62     aFilterName ( rCopy.aFilterName ),
  63     aOptions    ( rCopy.aOptions ),
  64     aSourceArea ( rCopy.aSourceArea ),
  65     aDestArea   ( rCopy.aDestArea ),
  66     nRefresh    ( rCopy.nRefresh )
  67 {
  68 }
  69
  70 ScAreaLinkSaver::~ScAreaLinkSaver()
  71 {
  72 }
  73
  74 ScDataObject*   ScAreaLinkSaver::Clone() const
  75 {
  76     return new ScAreaLinkSaver( *this );
  77 }
  78
  79 BOOL ScAreaLinkSaver::IsEqualSource( const ScAreaLink& rCompare ) const
  80 {
  81     return ( aFileName   == rCompare.GetFile() &&
  82              aFilterName == rCompare.GetFilter() &&
  83              aOptions    == rCompare.GetOptions() &&
  84              aSourceArea == rCompare.GetSource() &&
  85              nRefresh    == rCompare.GetRefreshDelay() );
  86 }
  87
  88 BOOL ScAreaLinkSaver::IsEqual( const ScAreaLink& rCompare ) const
  89 {
  90     return ( IsEqualSource( rCompare ) &&
  91              aDestArea == rCompare.GetDestArea() );
  92 }
  93
  94 void ScAreaLinkSaver::WriteToLink( ScAreaLink& rLink ) const
  95 {
  96     rLink.SetDestArea( aDestArea );
  97 }
  98
  99 void ScAreaLinkSaver::InsertNewLink( ScDocument* pDoc ) const
 100 {
 101     // (see ScUndoRemoveAreaLink::Undo)
 102
 103     SvxLinkManager* pLinkManager = pDoc->GetLinkManager();
 104     SfxObjectShell* pObjSh = pDoc->GetDocumentShell();
 105
 106     if ( pLinkManager && pObjSh )
 107     {
 108         ScAreaLink* pLink = new ScAreaLink( pObjSh, aFileName, aFilterName, aOptions,
 109                                             aSourceArea, aDestArea.aStart, nRefresh );
 110         pLink->SetInCreate( TRUE );
 111         pLink->SetDestArea( aDestArea );
 112         pLinkManager->InsertFileLink( *pLink, OBJECT_CLIENT_FILE, aFileName, &aFilterName, &aSourceArea );
 113         pLink->Update();
 114         pLink->SetInCreate( FALSE );
 115     }
 116 }
 117
 118 // -----------------------------------------------------------------------
 119
 120 ScAreaLinkSaveCollection::ScAreaLinkSaveCollection()
 121 {
 122 }
 123
 124 ScAreaLinkSaveCollection::ScAreaLinkSaveCollection( const ScAreaLinkSaveCollection& rCopy ) :
 125     ScCollection( rCopy )
 126 {
 127 }
 128
 129 ScAreaLinkSaveCollection::~ScAreaLinkSaveCollection()
 130 {
 131 }
 132
 133 ScDataObject*   ScAreaLinkSaveCollection::Clone() const
 134 {
 135     return new ScAreaLinkSaveCollection( *this );
 136 }
 137
 138 BOOL ScAreaLinkSaveCollection::IsEqual( const ScDocument* pDoc ) const
 139 {
 140     // IsEqual can be checked in sequence.
 141     // Neither ref-update nor removing links will change the order.
 142
 143     SvxLinkManager* pLinkManager = const_cast<ScDocument*>(pDoc)->GetLinkManager();
 144     if (pLinkManager)
 145     {
 146         USHORT nPos = 0;
 147         const ::sfx2::SvBaseLinks& rLinks = pLinkManager->GetLinks();
 148         USHORT nLinkCount = rLinks.Count();
 149         for (USHORT i=0; i<nLinkCount; i++)
 150         {
 151             ::sfx2::SvBaseLink* pBase = *rLinks[i];
 152             if (pBase->ISA(ScAreaLink))
 153             {
 154                 if ( nPos >= GetCount() || !(*this)[nPos]->IsEqual( *(ScAreaLink*)pBase ) )
 155                     return FALSE;
 156
 157                 ++nPos;
 158             }
 159         }
 160         if ( nPos < GetCount() )
 161             return FALSE;           // fewer links in the document than in the save collection
 162     }
 163
 164     return TRUE;
 165 }
 166
 167 ScAreaLink* lcl_FindLink( const ::sfx2::SvBaseLinks& rLinks, const ScAreaLinkSaver& rSaver )
 168 {
 169     USHORT nLinkCount = rLinks.Count();
 170     for (USHORT i=0; i<nLinkCount; i++)
 171     {
 172         ::sfx2::SvBaseLink* pBase = *rLinks[i];
 173         if ( pBase->ISA(ScAreaLink) &&
 174              rSaver.IsEqualSource( *static_cast<ScAreaLink*>(pBase) ) )
 175         {
 176             return static_cast<ScAreaLink*>(pBase);     // found
 177         }
 178     }
 179     return NULL;    // not found
 180 }
 181
 182 void ScAreaLinkSaveCollection::Restore( ScDocument* pDoc ) const
 183 {
 184     // The save collection may contain additional entries that are not in the document.
 185     // They must be inserted again.
 186     // Entries from the save collection must be searched via source data, as the order
 187     // of links changes if deleted entries are re-added to the link manager (always at the end).
 188
 189     SvxLinkManager* pLinkManager = pDoc->GetLinkManager();
 190     if (pLinkManager)
 191     {
 192         const ::sfx2::SvBaseLinks& rLinks = pLinkManager->GetLinks();
 193         USHORT nSaveCount = GetCount();
 194         for (USHORT nPos=0; nPos<nSaveCount; nPos++)
 195         {
 196             ScAreaLinkSaver* pSaver = (*this)[nPos];
 197             ScAreaLink* pLink = lcl_FindLink( rLinks, *pSaver );
 198             if ( pLink )
 199                 pSaver->WriteToLink( *pLink );          // restore output position
 200             else
 201                 pSaver->InsertNewLink( pDoc );          // re-insert deleted link
 202         }
 203     }
 204 }
 205
 206 // static
 207 ScAreaLinkSaveCollection* ScAreaLinkSaveCollection::CreateFromDoc( const ScDocument* pDoc )
 208 {
 209     ScAreaLinkSaveCollection* pColl = NULL;
 210
 211     SvxLinkManager* pLinkManager = const_cast<ScDocument*>(pDoc)->GetLinkManager();
 212     if (pLinkManager)
 213     {
 214         const ::sfx2::SvBaseLinks& rLinks = pLinkManager->GetLinks();
 215         USHORT nLinkCount = rLinks.Count();
 216         for (USHORT i=0; i<nLinkCount; i++)
 217         {
 218             ::sfx2::SvBaseLink* pBase = *rLinks[i];
 219             if (pBase->ISA(ScAreaLink))
 220             {
 221                 if (!pColl)
 222                     pColl = new ScAreaLinkSaveCollection;
 223
 224                 ScAreaLinkSaver* pSaver = new ScAreaLinkSaver( *(ScAreaLink*)pBase );
 225                 if (!pColl->Insert(pSaver))
 226                     delete pSaver;
 227             }
 228         }
 229     }
 230
 231     return pColl;
 232 }
 233