sw/source/uibase/docvw/SidebarTxtControl.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 <config_wasm_strip.h>
  21
  22 #include "SidebarTxtControl.hxx"
  23
  24 #include <docsh.hxx>
  25 #include <doc.hxx>
  26
  27 #include <PostItMgr.hxx>
  28
  29 #include <cmdid.h>
  30 #include <strings.hrc>
  31
  32 #include <unotools/securityoptions.hxx>
  33 #include <officecfg/Office/Common.hxx>
  34
  35 #include <sfx2/viewfrm.hxx>
  36 #include <sfx2/bindings.hxx>
  37 #include <sfx2/dispatch.hxx>
  38 #include <sfx2/sfxhelp.hxx>
  39
  40 #include <vcl/commandevent.hxx>
  41 #include <vcl/event.hxx>
  42 #include <vcl/ptrstyle.hxx>
  43 #include <vcl/svapp.hxx>
  44 #include <vcl/weld.hxx>
  45 #include <vcl/gradient.hxx>
  46 #include <vcl/settings.hxx>
  47
  48 #include <editeng/outliner.hxx>
  49 #include <editeng/editeng.hxx>
  50 #include <editeng/editview.hxx>
  51 #include <editeng/flditem.hxx>
  52
  53 #include <uitool.hxx>
  54 #include <view.hxx>
  55 #include <wrtsh.hxx>
  56 #include <AnnotationWin.hxx>
  57 #include <IDocumentDeviceAccess.hxx>
  58 #include <redline.hxx>
  59 #include <memory>
  60
  61 namespace sw::sidebarwindows {
  62
  63 SidebarTextControl::SidebarTextControl(sw::annotation::SwAnnotationWin& rSidebarWin,
  64                                        SwView& rDocView,
  65                                        SwPostItMgr& rPostItMgr)
  66     : mrSidebarWin(rSidebarWin)
  67     , mrDocView(rDocView)
  68     , mrPostItMgr(rPostItMgr)
  69     , mbMouseDownGainingFocus(false)
  70 {
  71 }
  72
  73 EditView* SidebarTextControl::GetEditView() const
  74 {
  75     OutlinerView* pOutlinerView = mrSidebarWin.GetOutlinerView();
  76     if (!pOutlinerView)
  77         return nullptr;
  78     return &pOutlinerView->GetEditView();
  79 }
  80
  81 EditEngine* SidebarTextControl::GetEditEngine() const
  82 {
  83     OutlinerView* pOutlinerView = mrSidebarWin.GetOutlinerView();
  84     if (!pOutlinerView)
  85         return nullptr;
  86     return pOutlinerView->GetEditView().GetEditEngine();
  87 }
  88
  89 void SidebarTextControl::SetDrawingArea(weld::DrawingArea* pDrawingArea)
  90 {
  91     Size aSize(0, 0);
  92     pDrawingArea->set_size_request(aSize.Width(), aSize.Height());
  93
  94     SetOutputSizePixel(aSize);
  95
  96     weld::CustomWidgetController::SetDrawingArea(pDrawingArea);
  97
  98     EnableRTL(false);
  99
 100     const StyleSettings& rStyleSettings = Application::GetSettings().GetStyleSettings();
 101     Color aBgColor = rStyleSettings.GetWindowColor();
 102
 103     OutputDevice& rDevice = pDrawingArea->get_ref_device();
 104
 105     rDevice.SetMapMode(MapMode(MapUnit::MapTwip));
 106     rDevice.SetBackground(aBgColor);
 107
 108     Size aOutputSize(rDevice.PixelToLogic(aSize));
 109
 110     EditView* pEditView = GetEditView();
 111     pEditView->setEditViewCallbacks(this);
 112
 113     EditEngine* pEditEngine = GetEditEngine();
 114     // For tdf#143443 note we want an 'infinite' height initially (which is the
 115     // editengines default). For tdf#144686 it is helpful if the initial width
 116     // is the "SidebarWidth" so the calculated text height is always meaningful
 117     // for layout in the sidebar.
 118     Size aPaperSize(mrPostItMgr.GetSidebarWidth(), pEditEngine->GetPaperSize().Height());
 119     pEditEngine->SetPaperSize(aPaperSize);
 120     pEditEngine->SetRefDevice(mrDocView.GetWrtShell().getIDocumentDeviceAccess().getReferenceDevice(false));
 121
 122     pEditView->SetOutputArea(tools::Rectangle(Point(0, 0), aOutputSize));
 123     pEditView->SetBackgroundColor(aBgColor);
 124
 125     pDrawingArea->set_cursor(PointerStyle::Text);
 126
 127 #if !ENABLE_WASM_STRIP_ACCESSIBILITY
 128     InitAccessible();
 129 #endif
 130 }
 131
 132 void SidebarTextControl::SetCursorLogicPosition(const Point& rPosition, bool bPoint, bool bClearMark)
 133 {
 134     Point aMousePos = EditViewOutputDevice().PixelToLogic(rPosition);
 135     m_xEditView->SetCursorLogicPosition(aMousePos, bPoint, bClearMark);
 136 }
 137
 138 void SidebarTextControl::GetFocus()
 139 {
 140     WeldEditView::GetFocus();
 141     if ( !mrSidebarWin.IsMouseOver() )
 142         Invalidate();
 143     mrSidebarWin.SetActiveSidebarWin();
 144 }
 145
 146 void SidebarTextControl::LoseFocus()
 147 {
 148     // write the visible text back into the SwField
 149     mrSidebarWin.UpdateData();
 150
 151     WeldEditView::LoseFocus();
 152     if ( !mrSidebarWin.IsMouseOver() )
 153     {
 154         Invalidate();
 155     }
 156     // set false for autoscroll to typing location
 157     mrSidebarWin.LockView(false);
 158 }
 159
 160 OUString SidebarTextControl::RequestHelp(tools::Rectangle& rHelpRect)
 161 {
 162     if (EditView* pEditView = GetEditView())
 163     {
 164         Point aPos = rHelpRect.TopLeft();
 165
 166         const OutputDevice& rOutDev = pEditView->GetOutputDevice();
 167         Point aLogicClick = rOutDev.PixelToLogic(aPos);
 168         const SvxFieldItem* pItem = pEditView->GetField(aLogicClick);
 169         if (pItem)
 170         {
 171             const SvxFieldData* pField = pItem->GetField();
 172             const SvxURLField* pURL = dynamic_cast<const SvxURLField*>( pField  );
 173             if (pURL)
 174             {
 175                 rHelpRect = tools::Rectangle(aPos, Size(50, 10));
 176                 return SfxHelp::GetURLHelpText(pURL->GetURL());
 177             }
 178         }
 179     }
 180
 181     TranslateId pResId;
 182     switch( mrSidebarWin.GetLayoutStatus() )
 183     {
 184         case SwPostItHelper::INSERTED:  pResId = STR_REDLINE_INSERT; break;
 185         case SwPostItHelper::DELETED:   pResId = STR_REDLINE_DELETE; break;
 186         default: break;
 187     }
 188
 189     SwContentAtPos aContentAtPos( IsAttrAtPos::Redline );
 190     if ( pResId &&
 191          mrDocView.GetWrtShell().GetContentAtPos( mrSidebarWin.GetAnchorPos(), aContentAtPos ) )
 192     {
 193         OUString sText = SwResId(pResId) + ": " +
 194                         aContentAtPos.aFnd.pRedl->GetAuthorString() + " - " +
 195                         GetAppLangDateTimeString( aContentAtPos.aFnd.pRedl->GetTimeStamp() );
 196         return sText;
 197     }
 198
 199     return OUString();
 200 }
 201
 202 void SidebarTextControl::EditViewScrollStateChange()
 203 {
 204     mrSidebarWin.SetScrollbar();
 205 }
 206
 207 void SidebarTextControl::DrawForPage(OutputDevice* pDev, const Point& rPt)
 208 {
 209     //Take the control's height, but overwrite the scrollbar area if there was one
 210     OutputDevice& rDevice = GetDrawingArea()->get_ref_device();
 211     Size aSize(rDevice.PixelToLogic(GetOutputSizePixel()));
 212
 213     if (OutlinerView* pOutlinerView = mrSidebarWin.GetOutlinerView())
 214     {
 215         pOutlinerView->GetOutliner()->Draw(*pDev, tools::Rectangle(rPt, aSize));
 216     }
 217
 218     if ( mrSidebarWin.GetLayoutStatus()!=SwPostItHelper::DELETED )
 219         return;
 220
 221     pDev->Push(vcl::PushFlags::LINECOLOR);
 222
 223     pDev->SetLineColor(mrSidebarWin.GetChangeColor());
 224     Point aBottomRight(rPt);
 225     aBottomRight.Move(aSize);
 226     pDev->DrawLine(rPt,  aBottomRight);
 227
 228     Point aTopRight(rPt);
 229     aTopRight.Move(Size(aSize.Width(), 0));
 230
 231     Point aBottomLeft(rPt);
 232     aBottomLeft.Move(Size(0, aSize.Height()));
 233
 234     pDev->DrawLine(aTopRight, aBottomLeft);
 235
 236     pDev->Pop();
 237 }
 238
 239 void SidebarTextControl::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect)
 240 {
 241     Size aSize = GetOutputSizePixel();
 242     Point aPos;
 243
 244     if (!rRenderContext.GetSettings().GetStyleSettings().GetHighContrastMode())
 245     {
 246         if (mrSidebarWin.IsMouseOverSidebarWin() || HasFocus())
 247         {
 248             rRenderContext.DrawGradient(tools::Rectangle(aPos, rRenderContext.PixelToLogic(aSize)),
 249                                         Gradient(css::awt::GradientStyle_LINEAR, mrSidebarWin.ColorDark(), mrSidebarWin.ColorDark()));
 250         }
 251         else
 252         {
 253             rRenderContext.DrawGradient(tools::Rectangle(aPos, rRenderContext.PixelToLogic(aSize)),
 254                            Gradient(css::awt::GradientStyle_LINEAR, mrSidebarWin.ColorLight(), mrSidebarWin.ColorDark()));
 255         }
 256     }
 257
 258     DoPaint(rRenderContext, rRect);
 259
 260     if (mrSidebarWin.GetLayoutStatus() != SwPostItHelper::DELETED)
 261         return;
 262
 263     const AntialiasingFlags nFormerAntialiasing( rRenderContext.GetAntialiasing() );
 264     const bool bIsAntiAliasing = officecfg::Office::Common::Drawinglayer::AntiAliasing::get();
 265     if ( bIsAntiAliasing )
 266         rRenderContext.SetAntialiasing(AntialiasingFlags::Enable);
 267     rRenderContext.SetLineColor(mrSidebarWin.GetChangeColor());
 268     rRenderContext.DrawLine(rRenderContext.PixelToLogic(aPos),
 269                             rRenderContext.PixelToLogic(aPos + Point(aSize.Width(),
 270                                                                      aSize.Height() * 0.95)));
 271     rRenderContext.DrawLine(rRenderContext.PixelToLogic(aPos + Point(aSize.Width(),
 272                                                                      0)),
 273                             rRenderContext.PixelToLogic(aPos + Point(0,
 274                                                                      aSize.Height() * 0.95)));
 275     if ( bIsAntiAliasing )
 276         rRenderContext.SetAntialiasing(nFormerAntialiasing);
 277 }
 278
 279 void SidebarTextControl::MakeVisible()
 280 {
 281     //let's make sure we see our note
 282     mrPostItMgr.MakeVisible(&mrSidebarWin);
 283 }
 284
 285 bool SidebarTextControl::KeyInput( const KeyEvent& rKeyEvt )
 286 {
 287     if (getenv("SW_DEBUG") && rKeyEvt.GetKeyCode().GetCode() == KEY_F12)
 288     {
 289         if (rKeyEvt.GetKeyCode().IsShift())
 290         {
 291             mrDocView.GetDocShell()->GetDoc()->dumpAsXml();
 292             return true;
 293         }
 294     }
 295
 296     bool bDone = false;
 297
 298     const vcl::KeyCode& rKeyCode = rKeyEvt.GetKeyCode();
 299     sal_uInt16 nKey = rKeyCode.GetCode();
 300     if ( ( rKeyCode.IsMod1() && rKeyCode.IsMod2() ) &&
 301          ( (nKey == KEY_PAGEUP) || (nKey == KEY_PAGEDOWN) ) )
 302     {
 303         mrSidebarWin.SwitchToPostIt(nKey);
 304         bDone = true;
 305     }
 306     else if ( nKey == KEY_ESCAPE ||
 307               ( rKeyCode.IsMod1() &&
 308                 ( nKey == KEY_PAGEUP ||
 309                   nKey == KEY_PAGEDOWN ) ) )
 310     {
 311         mrSidebarWin.SwitchToFieldPos();
 312         bDone = true;
 313     }
 314     else if ( rKeyCode.GetFullCode() == KEY_INSERT )
 315     {
 316         mrSidebarWin.ToggleInsMode();
 317         bDone = true;
 318     }
 319     else
 320     {
 321         MakeVisible();
 322
 323         tools::Long aOldHeight = mrSidebarWin.GetPostItTextHeight();
 324
 325         /// HACK: need to switch off processing of Undo/Redo in Outliner
 326         if ( !( (nKey == KEY_Z || nKey == KEY_Y) && rKeyCode.IsMod1()) )
 327         {
 328             bool bIsProtected = mrSidebarWin.IsReadOnlyOrProtected();
 329             if ( !bIsProtected || !EditEngine::DoesKeyChangeText(rKeyEvt) )
 330             {
 331                 EditView* pEditView = GetEditView();
 332                 bDone = pEditView && pEditView->PostKeyEvent(rKeyEvt);
 333             }
 334             else
 335                 mrDocView.GetWrtShell().InfoReadOnlyDialog(false);
 336         }
 337         if (bDone)
 338             mrSidebarWin.ResizeIfNecessary( aOldHeight, mrSidebarWin.GetPostItTextHeight() );
 339         else
 340         {
 341             // write back data first when showing navigator
 342             if ( nKey==KEY_F5 )
 343                 mrSidebarWin.UpdateData();
 344             bDone = mrDocView.KeyInput(rKeyEvt);
 345         }
 346     }
 347
 348     mrDocView.GetViewFrame().GetBindings().InvalidateAll(false);
 349
 350     return bDone;
 351 }
 352
 353 bool SidebarTextControl::MouseButtonDown(const MouseEvent& rMEvt)
 354 {
 355     if (EditView* pEditView = GetEditView())
 356     {
 357         bool bExecuteMod = SvtSecurityOptions::IsOptionSet( SvtSecurityOptions::EOption::CtrlClickHyperlink);
 358
 359         if ( !bExecuteMod || (rMEvt.GetModifier() == KEY_MOD1))
 360         {
 361             const OutputDevice& rOutDev = pEditView->GetOutputDevice();
 362             Point aLogicClick = rOutDev.PixelToLogic(rMEvt.GetPosPixel());
 363             if (const SvxFieldItem* pItem = pEditView->GetField(aLogicClick))
 364             {
 365                 const SvxFieldData* pField = pItem->GetField();
 366                 const SvxURLField* pURL = dynamic_cast<const SvxURLField*>( pField  );
 367                 if ( pURL )
 368                 {
 369                     pEditView->MouseButtonDown( rMEvt );
 370                     SwWrtShell &rSh = mrDocView.GetWrtShell();
 371                     const OUString& sURL( pURL->GetURL() );
 372                     const OUString& sTarget( pURL->GetTargetFrame() );
 373                     ::LoadURL(rSh, sURL, LoadUrlFlags::NONE, sTarget);
 374                     return true;
 375                 }
 376             }
 377         }
 378     }
 379
 380     mbMouseDownGainingFocus = !HasFocus();
 381     GrabFocus();
 382
 383     bool bRet = WeldEditView::MouseButtonDown(rMEvt);
 384
 385     mrDocView.GetViewFrame().GetBindings().InvalidateAll(false);
 386
 387     return bRet;
 388 }
 389
 390 bool SidebarTextControl::MouseButtonUp(const MouseEvent& rMEvt)
 391 {
 392     bool bRet = WeldEditView::MouseButtonUp(rMEvt);
 393
 394     if (mbMouseDownGainingFocus)
 395     {
 396         MakeVisible();
 397         mbMouseDownGainingFocus = false;
 398     }
 399
 400     return bRet;
 401 }
 402
 403 bool SidebarTextControl::MouseMove(const MouseEvent& rMEvt)
 404 {
 405     if (rMEvt.IsEnterWindow())
 406         GetDrawingArea()->set_cursor(PointerStyle::Text);
 407     return WeldEditView::MouseMove(rMEvt);
 408 }
 409
 410 IMPL_LINK( SidebarTextControl, OnlineSpellCallback, SpellCallbackInfo&, rInfo, void )
 411 {
 412     if ( rInfo.nCommand == SpellCallbackCommand::STARTSPELLDLG )
 413     {
 414         mrDocView.GetViewFrame().GetDispatcher()->Execute( FN_SPELL_GRAMMAR_DIALOG, SfxCallMode::ASYNCHRON);
 415     }
 416 }
 417
 418 bool SidebarTextControl::Command( const CommandEvent& rCEvt )
 419 {
 420     EditView* pEditView = GetEditView();
 421
 422     if ( rCEvt.GetCommand() == CommandEventId::ContextMenu )
 423     {
 424         if (IsMouseCaptured())
 425             ReleaseMouse();
 426         if ( !mrSidebarWin.IsReadOnlyOrProtected() &&
 427              pEditView &&
 428              pEditView->IsWrongSpelledWordAtPos( rCEvt.GetMousePosPixel(), true ))
 429         {
 430             Link<SpellCallbackInfo&,void> aLink = LINK(this, SidebarTextControl, OnlineSpellCallback);
 431             pEditView->ExecuteSpellPopup(rCEvt.GetMousePosPixel(), aLink);
 432         }
 433         else
 434         {
 435             Point aPos;
 436             if (rCEvt.IsMouseEvent())
 437                 aPos = rCEvt.GetMousePosPixel();
 438             else
 439             {
 440                 const Size aSize = GetOutputSizePixel();
 441                 aPos = Point( aSize.getWidth()/2, aSize.getHeight()/2 );
 442             }
 443             SfxDispatcher::ExecutePopup(&mrSidebarWin, &aPos);
 444         }
 445         return true;
 446     }
 447     else if (rCEvt.GetCommand() == CommandEventId::Wheel)
 448     {
 449         // if no scrollbar, or extra keys held scroll the document and consume
 450         // this event, otherwise don't consume and let the event get to the
 451         // surrounding scrolled window
 452         if (!mrSidebarWin.IsScrollbarVisible())
 453         {
 454             mrDocView.HandleWheelCommands(rCEvt);
 455             return true;
 456         }
 457         else
 458         {
 459             const CommandWheelData* pData = rCEvt.GetWheelData();
 460             if (pData->IsShift() || pData->IsMod1() || pData->IsMod2())
 461             {
 462                 mrDocView.HandleWheelCommands(rCEvt);
 463                 return true;
 464             }
 465         }
 466     }
 467
 468     return WeldEditView::Command(rCEvt);
 469 }
 470
 471 } // end of namespace sw::sidebarwindows
 472
 473 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */