Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 507 insertions, 0 deletions

diff --git a/sw/source/uibase/docvw/AnnotationWin.cxx b/sw/source/uibase/docvw/AnnotationWin.cxx
new file mode 100644
index 000000000..da900ec54
--- /dev/null
+++ b/sw/source/uibase/docvw/AnnotationWin.cxx
@@ -0,0 +1,507 @@
+/* -*- 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 .
+ */
+
+#include <AnnotationWin.hxx>
+
+#include "AnnotationMenuButton.hxx"
+#include <PostItMgr.hxx>
+
+#include <strings.hrc>
+
+#include <vcl/edit.hxx>
+#include <vcl/menu.hxx>
+#include <vcl/scrbar.hxx>
+#include <vcl/svapp.hxx>
+
+#include <svl/undo.hxx>
+#include <unotools/localedatawrapper.hxx>
+#include <unotools/syslocale.hxx>
+#include <svl/languageoptions.hxx>
+
+#include <editeng/eeitem.hxx>
+#include <editeng/postitem.hxx>
+#include <editeng/fhgtitem.hxx>
+#include <editeng/langitem.hxx>
+
+#include <editeng/editview.hxx>
+#include <editeng/outliner.hxx>
+#include <editeng/editeng.hxx>
+#include <editeng/editobj.hxx>
+#include <editeng/outlobj.hxx>
+
+#include <comphelper/lok.hxx>
+#include <docufld.hxx>
+#include <txtfld.hxx>
+#include <ndtxt.hxx>
+#include <view.hxx>
+#include <viewopt.hxx>
+#include <wrtsh.hxx>
+#include <docsh.hxx>
+#include <doc.hxx>
+#include <IDocumentUndoRedo.hxx>
+#include <SwUndoField.hxx>
+#include <edtwin.hxx>
+#include "ShadowOverlayObject.hxx"
+#include "AnchorOverlayObject.hxx"
+#include "OverlayRanges.hxx"
+#include "SidebarTxtControl.hxx"
+
+#include <memory>
+
+namespace sw::annotation {
+
+SwAnnotationWin::SwAnnotationWin( SwEditWin& rEditWin,
+                                  SwPostItMgr& aMgr,
+                                  SwSidebarItem& rSidebarItem,
+                                  SwFormatField* aField )
+    : Window(&rEditWin)
+    , maBuilder(nullptr, VclBuilderContainer::getUIRootDir(), "modules/swriter/ui/annotationmenu.ui", "")
+    , mrMgr(aMgr)
+    , mrView(rEditWin.GetView())
+    , mnEventId(nullptr)
+    , mpSidebarTextControl(nullptr)
+    , mpVScrollbar(nullptr)
+    , mpMetadataAuthor(nullptr)
+    , mpMetadataDate(nullptr)
+    , mpMenuButton(nullptr)
+    , mColorAnchor()
+    , mColorDark()
+    , mColorLight()
+    , mChangeColor()
+    , meSidebarPosition(sw::sidebarwindows::SidebarPosition::NONE)
+    , mPosSize()
+    , mAnchorRect()
+    , mPageBorder(0)
+    , mbAnchorRectChanged(false)
+    , mbResolvedStateUpdated(false)
+    , mbMouseOver(false)
+    , mLayoutStatus(SwPostItHelper::INVISIBLE)
+    , mbReadonly(false)
+    , mbIsFollow(false)
+    , mrSidebarItem(rSidebarItem)
+    , mpAnchorFrame(rSidebarItem.maLayoutInfo.mpAnchorFrame)
+    , mpFormatField(aField)
+    , mpField( static_cast<SwPostItField*>(aField->GetField()))
+    , mpButtonPopup(nullptr)
+{
+    mpShadow = sidebarwindows::ShadowOverlayObject::CreateShadowOverlayObject( mrView );
+    if ( mpShadow )
+    {
+        mpShadow->setVisible(false);
+    }
+
+    mrMgr.ConnectSidebarWinToFrame( *(mrSidebarItem.maLayoutInfo.mpAnchorFrame),
+                                  mrSidebarItem.GetFormatField(),
+                                  *this );
+
+    if (SupportsDoubleBuffering())
+        // When double-buffering, allow parents to paint on our area. That's
+        // necessary when parents paint the complete buffer.
+        SetParentClipMode(ParentClipMode::NoClip);
+}
+
+SwAnnotationWin::~SwAnnotationWin()
+{
+    disposeOnce();
+}
+
+void SwAnnotationWin::dispose()
+{
+    mpButtonPopup.clear();
+    maBuilder.disposeBuilder();
+
+    if (IsDisposed())
+        return;
+
+    mrMgr.DisconnectSidebarWinFromFrame( *(mrSidebarItem.maLayoutInfo.mpAnchorFrame),
+                                       *this );
+
+    Disable();
+
+    if ( mpSidebarTextControl )
+    {
+        if ( mpOutlinerView )
+        {
+            mpOutlinerView->SetWindow( nullptr );
+        }
+    }
+    mpSidebarTextControl.disposeAndClear();
+
+    mpOutlinerView.reset();
+    mpOutliner.reset();
+
+    if (mpMetadataAuthor)
+    {
+        mpMetadataAuthor->RemoveEventListener( LINK( this, SwAnnotationWin, WindowEventListener ) );
+    }
+    mpMetadataAuthor.disposeAndClear();
+
+    if (mpMetadataResolved)
+    {
+        mpMetadataResolved->RemoveEventListener( LINK( this, SwAnnotationWin, WindowEventListener ) );
+    }
+    mpMetadataResolved.disposeAndClear();
+
+    if (mpMetadataDate)
+    {
+        mpMetadataDate->RemoveEventListener( LINK( this, SwAnnotationWin, WindowEventListener ) );
+    }
+    mpMetadataDate.disposeAndClear();
+
+    if (mpVScrollbar)
+    {
+        mpVScrollbar->RemoveEventListener( LINK( this, SwAnnotationWin, WindowEventListener ) );
+    }
+    mpVScrollbar.disposeAndClear();
+
+    RemoveEventListener( LINK( this, SwAnnotationWin, WindowEventListener ) );
+
+    mpAnchor.reset();
+    mpShadow.reset();
+
+    mpTextRangeOverlay.reset();
+
+    mpMenuButton.disposeAndClear();
+
+    if (mnEventId)
+        Application::RemoveUserEvent( mnEventId );
+
+    vcl::Window::dispose();
+}
+
+void SwAnnotationWin::SetPostItText()
+{
+    //If the cursor was visible, then make it visible again after
+    //changing text, e.g. fdo#33599
+    vcl::Cursor *pCursor = GetOutlinerView()->GetEditView().GetCursor();
+    bool bCursorVisible = pCursor && pCursor->IsVisible();
+
+    //If the new text is the same as the old text, keep the same insertion
+    //point .e.g. fdo#33599
+    mpField = static_cast<SwPostItField*>(mpFormatField->GetField());
+    OUString sNewText = mpField->GetPar2();
+    bool bTextUnchanged = sNewText == mpOutliner->GetEditEngine().GetText();
+    ESelection aOrigSelection(GetOutlinerView()->GetEditView().GetSelection());
+
+    // get text from SwPostItField and insert into our textview
+    mpOutliner->SetModifyHdl( Link<LinkParamNone*,void>() );
+    mpOutliner->EnableUndo( false );
+    if( mpField->GetTextObject() )
+        mpOutliner->SetText( *mpField->GetTextObject() );
+    else
+    {
+        mpOutliner->Clear();
+        GetOutlinerView()->SetAttribs(DefaultItem());
+        GetOutlinerView()->InsertText(sNewText);
+    }
+
+    mpOutliner->ClearModifyFlag();
+    mpOutliner->GetUndoManager().Clear();
+    mpOutliner->EnableUndo( true );
+    mpOutliner->SetModifyHdl( LINK( this, SwAnnotationWin, ModifyHdl ) );
+    if (bTextUnchanged)
+        GetOutlinerView()->GetEditView().SetSelection(aOrigSelection);
+    if (bCursorVisible)
+        GetOutlinerView()->ShowCursor();
+    Invalidate();
+}
+
+void SwAnnotationWin::SetResolved(bool resolved)
+{
+    bool oldState = IsResolved();
+    static_cast<SwPostItField*>(mpFormatField->GetField())->SetResolved(resolved);
+    const SwViewOption* pVOpt = mrView.GetWrtShellPtr()->GetViewOptions();
+    mrSidebarItem.bShow = !IsResolved() || (pVOpt->IsResolvedPostIts());
+
+    mpTextRangeOverlay.reset();
+
+    if(IsResolved())
+        mpMetadataResolved->Show();
+    else
+        mpMetadataResolved->Hide();
+
+    if(IsResolved() != oldState)
+        mbResolvedStateUpdated = true;
+    UpdateData();
+    Invalidate();
+}
+
+void SwAnnotationWin::ToggleResolved()
+{
+    SetResolved(!IsResolved());
+}
+
+void SwAnnotationWin::ToggleResolvedForThread()
+{
+    GetTopReplyNote()->ToggleResolved();
+    mrMgr.UpdateResolvedStatus(GetTopReplyNote());
+    mrMgr.LayoutPostIts();
+}
+
+bool SwAnnotationWin::IsResolved() const
+{
+    return static_cast<SwPostItField*>(mpFormatField->GetField())->GetResolved();
+}
+
+bool SwAnnotationWin::IsThreadResolved()
+{
+    // Not const because GetTopReplyNote isn't.
+    return GetTopReplyNote()->IsResolved();
+}
+
+void SwAnnotationWin::UpdateData()
+{
+    if ( mpOutliner->IsModified() || mbResolvedStateUpdated )
+    {
+        IDocumentUndoRedo & rUndoRedo(
+            mrView.GetDocShell()->GetDoc()->GetIDocumentUndoRedo());
+        std::unique_ptr<SwField> pOldField;
+        if (rUndoRedo.DoesUndo())
+        {
+            pOldField = mpField->Copy();
+        }
+        mpField->SetPar2(mpOutliner->GetEditEngine().GetText());
+        mpField->SetTextObject(mpOutliner->CreateParaObject());
+        if (rUndoRedo.DoesUndo())
+        {
+            SwTextField *const pTextField = mpFormatField->GetTextField();
+            SwPosition aPosition( pTextField->GetTextNode() );
+            aPosition.nContent = pTextField->GetStart();
+            rUndoRedo.AppendUndo(
+                std::make_unique<SwUndoFieldFromDoc>(aPosition, *pOldField, *mpField, nullptr, true));
+        }
+        // so we get a new layout of notes (anchor position is still the same and we would otherwise not get one)
+        mrMgr.SetLayout();
+        // #i98686# if we have several views, all notes should update their text
+        if(mbResolvedStateUpdated)
+            mpFormatField->Broadcast(SwFormatFieldHint( nullptr, SwFormatFieldHintWhich::RESOLVED));
+        else
+            mpFormatField->Broadcast(SwFormatFieldHint( nullptr, SwFormatFieldHintWhich::CHANGED));
+        mrView.GetDocShell()->SetModified();
+    }
+    mpOutliner->ClearModifyFlag();
+    mpOutliner->GetUndoManager().Clear();
+    mbResolvedStateUpdated = false;
+}
+
+void SwAnnotationWin::Delete()
+{
+    if (mrView.GetWrtShellPtr()->GotoField(*mpFormatField))
+    {
+        if ( mrMgr.GetActiveSidebarWin() == this)
+        {
+            mrMgr.SetActiveSidebarWin(nullptr);
+            // if the note is empty, the previous line will send a delete event, but we are already there
+            if (mnEventId)
+            {
+                Application::RemoveUserEvent( mnEventId );
+                mnEventId = nullptr;
+            }
+        }
+        // we delete the field directly, the Mgr cleans up the PostIt by listening
+        GrabFocusToDocument();
+        mrView.GetWrtShellPtr()->ClearMark();
+        mrView.GetWrtShellPtr()->DelRight();
+    }
+}
+
+void SwAnnotationWin::GotoPos()
+{
+    mrView.GetDocShell()->GetWrtShell()->GotoField(*mpFormatField);
+}
+
+sal_uInt32 SwAnnotationWin::MoveCaret()
+{
+    // if this is an answer, do not skip over all following ones, but insert directly behind the current one
+    // but when just leaving a note, skip all following ones as well to continue typing
+    return mrMgr.IsAnswer()
+           ? 1
+           : 1 + CountFollowing();
+}
+
+// returns a non-zero postit parent id, if exists, otherwise 0 for root comments
+sal_uInt32 SwAnnotationWin::CalcParent()
+{
+    SwTextField* pTextField = mpFormatField->GetTextField();
+    SwPosition aPosition( pTextField->GetTextNode() );
+    aPosition.nContent = pTextField->GetStart();
+    SwTextAttr * const pTextAttr =
+        pTextField->GetTextNode().GetTextAttrForCharAt(
+            aPosition.nContent.GetIndex() - 1,
+            RES_TXTATR_ANNOTATION );
+    const SwField* pField = pTextAttr ? pTextAttr->GetFormatField().GetField() : nullptr;
+    sal_uInt32 nParentId = 0;
+    if (pField && pField->Which() == SwFieldIds::Postit)
+    {
+        const SwPostItField* pPostItField = static_cast<const SwPostItField*>(pField);
+        nParentId = pPostItField->GetPostItId();
+    }
+    return nParentId;
+}
+
+// counts how many SwPostItField we have right after the current one
+sal_uInt32 SwAnnotationWin::CountFollowing()
+{
+    sal_uInt32 aCount = 1;  // we start with 1, so we have to subtract one at the end again
+    SwTextField* pTextField = mpFormatField->GetTextField();
+    SwPosition aPosition( pTextField->GetTextNode() );
+    aPosition.nContent = pTextField->GetStart();
+
+    SwTextAttr * pTextAttr = pTextField->GetTextNode().GetTextAttrForCharAt(
+                                        aPosition.nContent.GetIndex() + 1,
+                                        RES_TXTATR_ANNOTATION );
+    SwField* pField = pTextAttr
+                    ? const_cast<SwField*>(pTextAttr->GetFormatField().GetField())
+                    : nullptr;
+    while ( pField && ( pField->Which()== SwFieldIds::Postit ) )
+    {
+        aCount++;
+        pTextAttr = pTextField->GetTextNode().GetTextAttrForCharAt(
+                                        aPosition.nContent.GetIndex() + aCount,
+                                        RES_TXTATR_ANNOTATION );
+        pField = pTextAttr
+               ? const_cast<SwField*>(pTextAttr->GetFormatField().GetField())
+               : nullptr;
+    }
+    return aCount - 1;
+}
+
+VclPtr<MenuButton> SwAnnotationWin::CreateMenuButton()
+{
+    mpButtonPopup = maBuilder.get_menu("menu");
+    sal_uInt16 nByAuthorId = mpButtonPopup->GetItemId("deleteby");
+    OUString aText = mpButtonPopup->GetItemText(nByAuthorId);
+    SwRewriter aRewriter;
+    aRewriter.AddRule(UndoArg1,GetAuthor());
+    aText = aRewriter.Apply(aText);
+    mpButtonPopup->SetItemText(nByAuthorId, aText);
+    VclPtrInstance<AnnotationMenuButton> pMenuButton( *this );
+    pMenuButton->SetPopupMenu( mpButtonPopup );
+    pMenuButton->Show();
+    return pMenuButton;
+}
+
+void SwAnnotationWin::InitAnswer(OutlinerParaObject const * pText)
+{
+    // If tiled annotations is off in lok case, skip adding additional reply text.
+    if (comphelper::LibreOfficeKit::isActive() && !comphelper::LibreOfficeKit::isTiledAnnotations())
+        return;
+
+    //collect our old meta data
+    SwAnnotationWin* pWin = mrMgr.GetNextPostIt(KEY_PAGEUP, this);
+    const SvtSysLocale aSysLocale;
+    const LocaleDataWrapper& rLocalData = aSysLocale.GetLocaleData();
+    SwRewriter aRewriter;
+    aRewriter.AddRule(UndoArg1, pWin->GetAuthor());
+    const OUString aText = aRewriter.Apply(SwResId(STR_REPLY))
+            + " (" + rLocalData.getDate( pWin->GetDate())
+            + ", " + rLocalData.getTime( pWin->GetTime(), false)
+            + "): \"";
+    GetOutlinerView()->InsertText(aText);
+
+    // insert old, selected text or "..."
+    // TODO: iterate over all paragraphs, not only first one to find out if it is empty
+    if (!pText->GetTextObject().GetText(0).isEmpty())
+        GetOutlinerView()->GetEditView().InsertText(pText->GetTextObject());
+    else
+        GetOutlinerView()->InsertText("...");
+    GetOutlinerView()->InsertText("\"\n");
+
+    GetOutlinerView()->SetSelection(ESelection(0,0,EE_PARA_ALL,EE_TEXTPOS_ALL));
+    SfxItemSet aAnswerSet( mrView.GetDocShell()->GetPool() );
+    aAnswerSet.Put(SvxFontHeightItem(200,80,EE_CHAR_FONTHEIGHT));
+    aAnswerSet.Put(SvxPostureItem(ITALIC_NORMAL,EE_CHAR_ITALIC));
+    GetOutlinerView()->SetAttribs(aAnswerSet);
+    GetOutlinerView()->SetSelection(ESelection(EE_PARA_MAX_COUNT,EE_TEXTPOS_MAX_COUNT,EE_PARA_MAX_COUNT,EE_TEXTPOS_MAX_COUNT));
+
+    //remove all attributes and reset our standard ones
+    GetOutlinerView()->GetEditView().RemoveAttribsKeepLanguages(true);
+    GetOutlinerView()->SetAttribs(DefaultItem());
+    // lets insert an undo step so the initial text can be easily deleted
+    // but do not use UpdateData() directly, would set modified state again and reentrance into Mgr
+    mpOutliner->SetModifyHdl( Link<LinkParamNone*,void>() );
+    IDocumentUndoRedo & rUndoRedo(
+        mrView.GetDocShell()->GetDoc()->GetIDocumentUndoRedo());
+    std::unique_ptr<SwField> pOldField;
+    if (rUndoRedo.DoesUndo())
+    {
+        pOldField = mpField->Copy();
+    }
+    mpField->SetPar2(mpOutliner->GetEditEngine().GetText());
+    mpField->SetTextObject(mpOutliner->CreateParaObject());
+    if (rUndoRedo.DoesUndo())
+    {
+        SwTextField *const pTextField = mpFormatField->GetTextField();
+        SwPosition aPosition( pTextField->GetTextNode() );
+        aPosition.nContent = pTextField->GetStart();
+        rUndoRedo.AppendUndo(
+            std::make_unique<SwUndoFieldFromDoc>(aPosition, *pOldField, *mpField, nullptr, true));
+    }
+    mpOutliner->SetModifyHdl( LINK( this, SwAnnotationWin, ModifyHdl ) );
+    mpOutliner->ClearModifyFlag();
+    mpOutliner->GetUndoManager().Clear();
+}
+
+void SwAnnotationWin::UpdateText(const OUString& aText)
+{
+    mpOutliner->Clear();
+    GetOutlinerView()->InsertText(aText);
+    UpdateData();
+}
+
+SvxLanguageItem SwAnnotationWin::GetLanguage() const
+{
+    // set initial language for outliner
+    SvtScriptType nScriptType = SvtLanguageOptions::GetScriptTypeOfLanguage( mpField->GetLanguage() );
+    sal_uInt16 nLangWhichId = 0;
+    switch (nScriptType)
+    {
+        case SvtScriptType::LATIN :    nLangWhichId = EE_CHAR_LANGUAGE ; break;
+        case SvtScriptType::ASIAN :    nLangWhichId = EE_CHAR_LANGUAGE_CJK; break;
+        case SvtScriptType::COMPLEX :  nLangWhichId = EE_CHAR_LANGUAGE_CTL; break;
+        default: OSL_FAIL("GetLanguage: wrong script type");
+    }
+    return SvxLanguageItem(mpField->GetLanguage(),nLangWhichId);
+}
+
+bool SwAnnotationWin::IsProtected() const
+{
+    return mbReadonly ||
+           GetLayoutStatus() == SwPostItHelper::DELETED ||
+           ( mpFormatField && mpFormatField->IsProtect() );
+}
+
+OUString SwAnnotationWin::GetAuthor() const
+{
+    return mpField->GetPar1();
+}
+
+Date SwAnnotationWin::GetDate() const
+{
+    return mpField->GetDate();
+}
+
+tools::Time SwAnnotationWin::GetTime() const
+{
+    return mpField->GetTime();
+}
+
+} // end of namespace sw::annotation
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */