sc/source/ui/unoobj/editsrc.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <memory>
  21 #include <sal/config.h>
  22
  23 #include <utility>
  24
  25 #include <editsrc.hxx>
  26
  27 #include <scitems.hxx>
  28 #include <editeng/eeitem.hxx>
  29 #include <editeng/unofored.hxx>
  30 #include <vcl/svapp.hxx>
  31 #include <svx/svdpage.hxx>
  32 #include <svx/svditer.hxx>
  33 #include <svx/svdocapt.hxx>
  34 #include <editeng/outlobj.hxx>
  35 #include <editeng/editobj.hxx>
  36 #include <editeng/outliner.hxx>
  37 #include <textuno.hxx>
  38 #include <editutil.hxx>
  39 #include <docsh.hxx>
  40 #include <docfunc.hxx>
  41 #include <hints.hxx>
  42 #include <patattr.hxx>
  43 #include <drwlayer.hxx>
  44 #include <userdat.hxx>
  45 #include <postit.hxx>
  46 #include <AccessibleText.hxx>
  47
  48 ScHeaderFooterEditSource::ScHeaderFooterEditSource(ScHeaderFooterTextData& rData) :
  49     mrTextData(rData) {}
  50
  51 ScHeaderFooterEditSource::~ScHeaderFooterEditSource() {}
  52
  53 ScEditEngineDefaulter* ScHeaderFooterEditSource::GetEditEngine()
  54 {
  55     return mrTextData.GetEditEngine();
  56 }
  57
  58 std::unique_ptr<SvxEditSource> ScHeaderFooterEditSource::Clone() const
  59 {
  60     return std::unique_ptr<SvxEditSource>(new ScHeaderFooterEditSource(mrTextData));
  61 }
  62
  63 SvxTextForwarder* ScHeaderFooterEditSource::GetTextForwarder()
  64 {
  65     return mrTextData.GetTextForwarder();
  66 }
  67
  68 void ScHeaderFooterEditSource::UpdateData()
  69 {
  70     mrTextData.UpdateData();
  71 }
  72
  73 ScCellEditSource::ScCellEditSource(ScDocShell* pDocSh, const ScAddress& rP) :
  74     pCellTextData(new ScCellTextData(pDocSh, rP)) {}
  75
  76 ScCellEditSource::~ScCellEditSource()
  77 {
  78 }
  79
  80 std::unique_ptr<SvxEditSource> ScCellEditSource::Clone() const
  81 {
  82     return std::unique_ptr<SvxEditSource>(new ScCellEditSource(pCellTextData->GetDocShell(), pCellTextData->GetCellPos()));
  83 }
  84
  85 SvxTextForwarder* ScCellEditSource::GetTextForwarder()
  86 {
  87     return pCellTextData->GetTextForwarder();
  88 }
  89
  90 void ScCellEditSource::UpdateData()
  91 {
  92     pCellTextData->UpdateData();
  93 }
  94
  95 void ScCellEditSource::SetDoUpdateData(bool bValue)
  96 {
  97     pCellTextData->SetDoUpdate(bValue);
  98 }
  99
 100 bool ScCellEditSource::IsDirty() const
 101 {
 102     return pCellTextData->IsDirty();
 103 }
 104
 105 ScEditEngineDefaulter* ScCellEditSource::GetEditEngine()
 106 {
 107     return pCellTextData->GetEditEngine();
 108 }
 109
 110 ScAnnotationEditSource::ScAnnotationEditSource(ScDocShell* pDocSh, const ScAddress& rP) :
 111     pDocShell( pDocSh ),
 112     aCellPos( rP ),
 113     bDataValid( false )
 114 {
 115     if (pDocShell)
 116         pDocShell->GetDocument().AddUnoObject(*this);
 117 }
 118
 119 ScAnnotationEditSource::~ScAnnotationEditSource()
 120 {
 121     SolarMutexGuard aGuard;     //  needed for EditEngine dtor
 122
 123     if (pDocShell)
 124         pDocShell->GetDocument().RemoveUnoObject(*this);
 125
 126     pForwarder.reset();
 127     pEditEngine.reset();
 128 }
 129
 130 std::unique_ptr<SvxEditSource> ScAnnotationEditSource::Clone() const
 131 {
 132     return std::unique_ptr<SvxEditSource>(new ScAnnotationEditSource( pDocShell, aCellPos ));
 133 }
 134
 135 SdrObject* ScAnnotationEditSource::GetCaptionObj()
 136 {
 137     ScPostIt* pNote = pDocShell->GetDocument().GetNote(aCellPos);
 138     return pNote ? pNote->GetOrCreateCaption( aCellPos ) : nullptr;
 139 }
 140
 141 SvxTextForwarder* ScAnnotationEditSource::GetTextForwarder()
 142 {
 143     if (!pEditEngine)
 144     {
 145         // notes don't have fields
 146         if ( pDocShell )
 147         {
 148             pEditEngine.reset( new ScNoteEditEngine( pDocShell->GetDocument().GetNoteEngine() ) );
 149         }
 150         else
 151         {
 152             SfxItemPool* pEnginePool = EditEngine::CreatePool();
 153             pEnginePool->FreezeIdRanges();
 154             pEditEngine.reset( new ScEditEngineDefaulter( pEnginePool, true ) );
 155         }
 156         pForwarder.reset( new SvxEditEngineForwarder(*pEditEngine) );
 157     }
 158
 159     if (bDataValid)
 160         return pForwarder.get();
 161
 162     if ( pDocShell )
 163         if ( ScPostIt* pNote = pDocShell->GetDocument().GetNote(aCellPos) )
 164             if ( const EditTextObject* pEditObj = pNote->GetEditTextObject() )
 165                 pEditEngine->SetText( *pEditObj );      // incl. breaks (line, etc.)
 166
 167     bDataValid = true;
 168     return pForwarder.get();
 169 }
 170
 171 void ScAnnotationEditSource::UpdateData()
 172 {
 173     if ( pDocShell && pEditEngine )
 174     {
 175         ScDocShellModificator aModificator( *pDocShell );
 176
 177         if( SdrObject* pObj = GetCaptionObj() )
 178         {
 179             std::unique_ptr<EditTextObject> pEditObj = pEditEngine->CreateTextObject();
 180             std::unique_ptr<OutlinerParaObject> pOPO( new OutlinerParaObject( *pEditObj ) );
 181             pEditObj.reset();
 182             pOPO->SetOutlinerMode( OutlinerMode::TextObject );
 183             pObj->NbcSetOutlinerParaObject( std::move(pOPO) );
 184             pObj->ActionChanged();
 185         }
 186
 187         //! Undo !!!
 188
 189         aModificator.SetDocumentModified();
 190
 191         // SetDocumentModified will reset bDataValid
 192     }
 193 }
 194
 195 void ScAnnotationEditSource::Notify( SfxBroadcaster&, const SfxHint& rHint )
 196 {
 197     if ( dynamic_cast<const ScUpdateRefHint*>(&rHint) )
 198     {
 199         //! reference update
 200     }
 201     else
 202     {
 203         const SfxHintId nId = rHint.GetId();
 204         if ( nId == SfxHintId::Dying )
 205         {
 206             pDocShell = nullptr;
 207
 208             pForwarder.reset();
 209             pEditEngine.reset();     // EditEngine uses document's pool
 210         }
 211         else if ( nId == SfxHintId::DataChanged )
 212             bDataValid = false;                     // text must be retrieved again
 213     }
 214 }
 215
 216 ScSimpleEditSource::ScSimpleEditSource( SvxTextForwarder* pForw ) :
 217     pForwarder( pForw )
 218 {
 219     //  The same forwarder (and EditEngine) is shared by all children of the same Text object.
 220     //  Text range and cursor keep a reference to their parent text, so the text object is
 221     //  always alive and the forwarder is valid as long as there are children.
 222 }
 223
 224 ScSimpleEditSource::~ScSimpleEditSource()
 225 {
 226 }
 227
 228 std::unique_ptr<SvxEditSource> ScSimpleEditSource::Clone() const
 229 {
 230     return std::unique_ptr<SvxEditSource>(new ScSimpleEditSource( pForwarder ));
 231 }
 232
 233 SvxTextForwarder* ScSimpleEditSource::GetTextForwarder()
 234 {
 235     return pForwarder;
 236 }
 237
 238 void ScSimpleEditSource::UpdateData()
 239 {
 240     //  nothing
 241 }
 242
 243 ScAccessibilityEditSource::ScAccessibilityEditSource( ::std::unique_ptr < ScAccessibleTextData > && pAccessibleCellTextData )
 244     : mpAccessibleTextData(std::move(pAccessibleCellTextData))
 245 {
 246 }
 247
 248 ScAccessibilityEditSource::~ScAccessibilityEditSource()
 249 {
 250 }
 251
 252 std::unique_ptr<SvxEditSource> ScAccessibilityEditSource::Clone() const
 253 {
 254     return std::unique_ptr<SvxEditSource>(new ScAccessibilityEditSource(::std::unique_ptr < ScAccessibleTextData > (mpAccessibleTextData->Clone())));
 255 }
 256
 257 SvxTextForwarder* ScAccessibilityEditSource::GetTextForwarder()
 258 {
 259     return mpAccessibleTextData->GetTextForwarder();
 260 }
 261
 262 SvxViewForwarder* ScAccessibilityEditSource::GetViewForwarder()
 263 {
 264     return mpAccessibleTextData->GetViewForwarder();
 265 }
 266
 267 SvxEditViewForwarder* ScAccessibilityEditSource::GetEditViewForwarder( bool bCreate )
 268 {
 269     return mpAccessibleTextData->GetEditViewForwarder(bCreate);
 270 }
 271
 272 void ScAccessibilityEditSource::UpdateData()
 273 {
 274     mpAccessibleTextData->UpdateData();
 275 }
 276
 277 SfxBroadcaster& ScAccessibilityEditSource::GetBroadcaster() const
 278 {
 279     return mpAccessibleTextData->GetBroadcaster();
 280 }
 281
 282 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */