sc/source/ui/view/gridwin5.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 <editeng/flditem.hxx>
  21
  22 #include <svx/fmpage.hxx>
  23 #include <svx/svdobj.hxx>
  24 #include <svx/svdpagv.hxx>
  25 #include <svx/ImageMapInfo.hxx>
  26 #include <vcl/imapobj.hxx>
  27 #include <vcl/help.hxx>
  28 #include <tools/urlobj.hxx>
  29 #include <sfx2/sfxhelp.hxx>
  30
  31 #include <AccessibleDocument.hxx>
  32 #include <com/sun/star/accessibility/XAccessible.hpp>
  33
  34 #include <gridwin.hxx>
  35 #include <viewdata.hxx>
  36 #include <drawview.hxx>
  37 #include <drwlayer.hxx>
  38 #include <document.hxx>
  39 #include <notemark.hxx>
  40 #include <chgtrack.hxx>
  41 #include <chgviset.hxx>
  42 #include <dbfunc.hxx>
  43 #include <postit.hxx>
  44 #include <global.hxx>
  45
  46 bool ScGridWindow::ShowNoteMarker( SCCOL nPosX, SCROW nPosY, bool bKeyboard )
  47 {
  48     bool bDone = false;
  49
  50     ScDocument& rDoc = mrViewData.GetDocument();
  51     SCTAB       nTab = mrViewData.GetTabNo();
  52     ScAddress   aCellPos( nPosX, nPosY, nTab );
  53
  54     OUString aTrackText;
  55     bool bLeftEdge = false;
  56
  57     // change tracking
  58
  59     ScChangeTrack* pTrack = rDoc.GetChangeTrack();
  60     ScChangeViewSettings* pSettings = rDoc.GetChangeViewSettings();
  61     if ( pTrack && pTrack->GetFirst() && pSettings && pSettings->ShowChanges())
  62     {
  63         const ScChangeAction* pFound = nullptr;
  64         const ScChangeAction* pFoundContent = nullptr;
  65         const ScChangeAction* pFoundMove = nullptr;
  66         const ScChangeAction* pAction = pTrack->GetFirst();
  67         while (pAction)
  68         {
  69             if ( pAction->IsVisible() &&
  70                  ScViewUtil::IsActionShown( *pAction, *pSettings, rDoc ) )
  71             {
  72                 ScChangeActionType eType = pAction->GetType();
  73                 const ScBigRange& rBig = pAction->GetBigRange();
  74                 if ( rBig.aStart.Tab() == nTab )
  75                 {
  76                     ScRange aRange = rBig.MakeRange( rDoc );
  77
  78                     if ( eType == SC_CAT_DELETE_ROWS )
  79                         aRange.aEnd.SetRow( aRange.aStart.Row() );
  80                     else if ( eType == SC_CAT_DELETE_COLS )
  81                         aRange.aEnd.SetCol( aRange.aStart.Col() );
  82
  83                     if ( aRange.Contains( aCellPos ) )
  84                     {
  85                         pFound = pAction;       // the last one wins
  86                         switch ( eType )
  87                         {
  88                             case SC_CAT_CONTENT :
  89                                 pFoundContent = pAction;
  90                             break;
  91                             case SC_CAT_MOVE :
  92                                 pFoundMove = pAction;
  93                             break;
  94                             default:
  95                             {
  96                                 // added to avoid warnings
  97                             }
  98                         }
  99                     }
 100                 }
 101                 if ( eType == SC_CAT_MOVE )
 102                 {
 103                     ScRange aRange =
 104                         static_cast<const ScChangeActionMove*>(pAction)->
 105                         GetFromRange().MakeRange( rDoc );
 106                     if ( aRange.Contains( aCellPos ) )
 107                     {
 108                         pFound = pAction;
 109                     }
 110                 }
 111             }
 112             pAction = pAction->GetNext();
 113         }
 114
 115         if ( pFound )
 116         {
 117             if ( pFoundContent && pFound->GetType() != SC_CAT_CONTENT )
 118                 pFound = pFoundContent;     // content wins
 119             if ( pFoundMove && pFound->GetType() != SC_CAT_MOVE &&
 120                     pFoundMove->GetActionNumber() >
 121                     pFound->GetActionNumber() )
 122                 pFound = pFoundMove;        // move wins
 123
 124             // for deleted columns: Arrow on the left side of the cell
 125             if ( pFound->GetType() == SC_CAT_DELETE_COLS )
 126                 bLeftEdge = true;
 127
 128             DateTime aDT = pFound->GetDateTime();
 129             aTrackText  = pFound->GetUser()
 130                         + ", "
 131                         + ScGlobal::getLocaleData().getDate(aDT)
 132                         + " "
 133                         + ScGlobal::getLocaleData().getTime(aDT)
 134                         + ":\n";
 135             OUString aComStr=pFound->GetComment();
 136             if(!aComStr.isEmpty())
 137             {
 138                 aTrackText += aComStr + "\n( ";
 139             }
 140             OUString aTmp = pFound->GetDescription(rDoc);
 141             aTrackText += aTmp;
 142             if(!aComStr.isEmpty())
 143             {
 144                 aTrackText += ")";
 145             }
 146         }
 147     }
 148
 149     // Note, only if it is not already displayed on the Drawing Layer:
 150     const ScPostIt* pNote = rDoc.GetNote( aCellPos );
 151     if ( (!aTrackText.isEmpty()) || (pNote && !pNote->IsCaptionShown()) )
 152     {
 153         bool bNew = true;
 154         bool bFast = false;
 155         if (mpNoteMarker) // A note already shown
 156         {
 157             if (mpNoteMarker->GetDocPos() == aCellPos)
 158                 bNew = false; // then stop
 159             else
 160                 bFast = true; // otherwise, at once
 161
 162             //  marker which was shown for ctrl-F1 isn't removed by mouse events
 163             if (mpNoteMarker->IsByKeyboard() && !bKeyboard)
 164                 bNew = false;
 165         }
 166         if (bNew)
 167         {
 168             if (bKeyboard)
 169                 bFast = true; // keyboard also shows the marker immediately
 170
 171             mpNoteMarker.reset();
 172
 173             bool bHSplit = mrViewData.GetHSplitMode() != SC_SPLIT_NONE;
 174             bool bVSplit = mrViewData.GetVSplitMode() != SC_SPLIT_NONE;
 175
 176             vcl::Window* pLeft = mrViewData.GetView()->GetWindowByPos( bVSplit ? SC_SPLIT_TOPLEFT : SC_SPLIT_BOTTOMLEFT );
 177             vcl::Window* pRight = bHSplit ? mrViewData.GetView()->GetWindowByPos( bVSplit ? SC_SPLIT_TOPRIGHT : SC_SPLIT_BOTTOMRIGHT ) : nullptr;
 178             vcl::Window* pBottom = bVSplit ? mrViewData.GetView()->GetWindowByPos( SC_SPLIT_BOTTOMLEFT ) : nullptr;
 179             vcl::Window* pDiagonal = (bHSplit && bVSplit) ? mrViewData.GetView()->GetWindowByPos( SC_SPLIT_BOTTOMRIGHT ) : nullptr;
 180             assert(pLeft && "ScGridWindow::ShowNoteMarker - missing top-left grid window");
 181
 182             /*  If caption is shown from right or bottom windows, adjust
 183                 mapmode to include size of top-left window. */
 184             MapMode aMapMode = GetDrawMapMode( true );
 185             Size aLeftSize = pLeft->PixelToLogic( pLeft->GetOutputSizePixel(), aMapMode );
 186             Point aOrigin = aMapMode.GetOrigin();
 187             if( (this == pRight) || (this == pDiagonal) )
 188                 aOrigin.AdjustX(aLeftSize.Width() );
 189             if( (this == pBottom) || (this == pDiagonal) )
 190                 aOrigin.AdjustY(aLeftSize.Height() );
 191             aMapMode.SetOrigin( aOrigin );
 192
 193             mpNoteMarker.reset(new ScNoteMarker(pLeft, pRight, pBottom, pDiagonal,
 194                                                 &rDoc, aCellPos, aTrackText,
 195                                                 aMapMode, bLeftEdge, bFast, bKeyboard));
 196         }
 197
 198         bDone = true;       // something is shown (old or new)
 199     }
 200
 201     return bDone;
 202 }
 203
 204 void ScGridWindow::RequestHelp(const HelpEvent& rHEvt)
 205 {
 206     bool bDone = false;
 207     OUString aFormulaText;
 208     tools::Rectangle aFormulaPixRect;
 209     bool bHelpEnabled = bool(rHEvt.GetMode() & ( HelpEventMode::BALLOON | HelpEventMode::QUICK ));
 210     SdrView* pDrView = mrViewData.GetScDrawView();
 211     bool bDrawTextEdit = false;
 212     if (pDrView)
 213         bDrawTextEdit = pDrView->IsTextEdit();
 214     //  notes or change tracking
 215     if ( bHelpEnabled && !bDrawTextEdit )
 216     {
 217         Point       aPosPixel = ScreenToOutputPixel( rHEvt.GetMousePosPixel() );
 218         SCCOL nPosX;
 219         SCROW nPosY;
 220         ScDocument& rDoc = mrViewData.GetDocument();
 221         SCTAB       nTab = mrViewData.GetTabNo();
 222         const ScViewOptions& rOpts = mrViewData.GetOptions();
 223         mrViewData.GetPosFromPixel( aPosPixel.X(), aPosPixel.Y(), eWhich, nPosX, nPosY );
 224
 225         if ( ShowNoteMarker( nPosX, nPosY, false ) )
 226         {
 227             Window::RequestHelp( rHEvt );   // turn off old Tip/Balloon
 228             bDone = true;
 229         }
 230
 231         if ( rOpts.GetOption( VOPT_FORMULAS_MARKS ) )
 232         {
 233             aFormulaText = rDoc.GetFormula( nPosX, nPosY, nTab );
 234             if ( !aFormulaText.isEmpty() ) {
 235                 const ScPatternAttr* pPattern = rDoc.GetPattern( nPosX, nPosY, nTab );
 236                 aFormulaPixRect = mrViewData.GetEditArea( eWhich, nPosX, nPosY, this, pPattern, true );
 237             }
 238         }
 239     }
 240
 241     if (!bDone && mpNoteMarker)
 242     {
 243         if (mpNoteMarker->IsByKeyboard())
 244         {
 245             //  marker which was shown for ctrl-F1 isn't removed by mouse events
 246         }
 247         else
 248         {
 249             mpNoteMarker.reset();
 250         }
 251     }
 252
 253     if ( !aFormulaText.isEmpty() )
 254     {
 255         tools::Rectangle aScreenRect(OutputToScreenPixel(aFormulaPixRect.TopLeft()),
 256                                      OutputToScreenPixel(aFormulaPixRect.BottomRight()));
 257         if ( rHEvt.GetMode() & HelpEventMode::BALLOON )
 258             Help::ShowBalloon(this, rHEvt.GetMousePosPixel(), aScreenRect, aFormulaText);
 259         else if ( rHEvt.GetMode() & HelpEventMode::QUICK )
 260             Help::ShowQuickHelp(this, aScreenRect, aFormulaText);
 261         bDone = true;
 262     }
 263
 264     //  Image-Map / Text-URL
 265
 266     if ( bHelpEnabled && !bDone && !nButtonDown )       // only without pressed button
 267     {
 268         OUString aHelpText;
 269         tools::Rectangle aPixRect;
 270         Point aPosPixel = ScreenToOutputPixel( rHEvt.GetMousePosPixel() );
 271
 272         if ( pDrView )                                      // URL / Image-Map
 273         {
 274             SdrViewEvent aVEvt;
 275             MouseEvent aMEvt( aPosPixel, 1, MouseEventModifiers::NONE, MOUSE_LEFT );
 276             SdrHitKind eHit = pDrView->PickAnything( aMEvt, SdrMouseEventKind::BUTTONDOWN, aVEvt );
 277
 278             if ( eHit != SdrHitKind::NONE && aVEvt.mpObj != nullptr )
 279             {
 280                 // URL for IMapObject below Pointer is help text
 281                 if (SvxIMapInfo::GetIMapInfo(aVEvt.mpObj))
 282                 {
 283                     Point aLogicPos = PixelToLogic( aPosPixel );
 284                     IMapObject* pIMapObj = SvxIMapInfo::GetHitIMapObject(
 285                                                     aVEvt.mpObj, aLogicPos, GetOutDev() );
 286
 287                     if ( pIMapObj )
 288                     {
 289                         // For image maps show the description, if available
 290                         aHelpText = pIMapObj->GetAltText();
 291                         if (aHelpText.isEmpty())
 292                             aHelpText = SfxHelp::GetURLHelpText(pIMapObj->GetURL());
 293                         aPixRect = LogicToPixel(aVEvt.mpObj->GetLogicRect());
 294                     }
 295                 }
 296                 // URL in shape text or at shape itself (URL in text overrides object URL)
 297                 if ( aHelpText.isEmpty() )
 298                 {
 299                     if( aVEvt.meEvent == SdrEventKind::ExecuteUrl )
 300                     {
 301                         if (aVEvt.mpURLField && !aVEvt.mpURLField->GetURL().startsWith("#"))
 302                         {
 303                             aHelpText = SfxHelp::GetURLHelpText(aVEvt.mpURLField->GetURL());
 304                             aPixRect = LogicToPixel(aVEvt.mpObj->GetLogicRect());
 305                         }
 306                     }
 307                     else
 308                     {
 309                         SdrPageView* pPV = nullptr;
 310                         Point aMDPos = PixelToLogic( aPosPixel );
 311                         SdrObject* pObj = pDrView->PickObj(aMDPos, pDrView->getHitTolLog(), pPV, SdrSearchOptions::ALSOONMASTER);
 312                         if (pObj)
 313                         {
 314                             if ( pObj->IsGroupObject() )
 315                             {
 316                                     SdrObject* pHit = pDrView->PickObj(aMDPos, pDrView->getHitTolLog(), pPV, SdrSearchOptions::DEEP);
 317                                     if (pHit)
 318                                         pObj = pHit;
 319                             }
 320                             // Fragments pointing into the current document need no tooltip
 321                             // describing the ctrl-click functionality.
 322                             if ( !pObj->getHyperlink().isEmpty() && !pObj->getHyperlink().startsWith("#") )
 323                             {
 324                                 aPixRect = LogicToPixel(aVEvt.mpObj->GetLogicRect());
 325                                 aHelpText = SfxHelp::GetURLHelpText(pObj->getHyperlink());
 326                             }
 327                         }
 328                     }
 329                 }
 330             }
 331         }
 332
 333         if ( aHelpText.isEmpty() )                                 // Text-URL
 334         {
 335             OUString aUrl;
 336             if ( GetEditUrl( aPosPixel, nullptr, &aUrl ) )
 337             {
 338                 aHelpText = SfxHelp::GetURLHelpText(
 339                     INetURLObject::decode(aUrl, INetURLObject::DecodeMechanism::Unambiguous));
 340
 341                 ScDocument& rDoc = mrViewData.GetDocument();
 342                 SCCOL nPosX;
 343                 SCROW nPosY;
 344                 SCTAB       nTab = mrViewData.GetTabNo();
 345                 mrViewData.GetPosFromPixel( aPosPixel.X(), aPosPixel.Y(), eWhich, nPosX, nPosY );
 346                 const ScPatternAttr* pPattern = rDoc.GetPattern( nPosX, nPosY, nTab );
 347
 348                 // bForceToTop = sal_False, use the cell's real position
 349                 aPixRect = mrViewData.GetEditArea( eWhich, nPosX, nPosY, this, pPattern, false );
 350             }
 351         }
 352
 353         if ( !aHelpText.isEmpty() )
 354         {
 355             tools::Rectangle aScreenRect(OutputToScreenPixel(aPixRect.TopLeft()),
 356                                          OutputToScreenPixel(aPixRect.BottomRight()));
 357
 358             if ( rHEvt.GetMode() & HelpEventMode::BALLOON )
 359                 Help::ShowBalloon(this,rHEvt.GetMousePosPixel(), aScreenRect, aHelpText);
 360             else if ( rHEvt.GetMode() & HelpEventMode::QUICK )
 361                 Help::ShowQuickHelp(this,aScreenRect, aHelpText);
 362
 363             bDone = true;
 364         }
 365     }
 366
 367     // basic controls
 368
 369     if ( pDrView && bHelpEnabled && !bDone )
 370     {
 371         SdrPageView* pPV = pDrView->GetSdrPageView();
 372         OSL_ENSURE( pPV, "SdrPageView* is NULL" );
 373         if (pPV)
 374             bDone = FmFormPage::RequestHelp( this, pDrView, rHEvt );
 375     }
 376
 377     // If QuickHelp for AutoFill is shown, do not allow it to be removed
 378
 379     if ( nMouseStatus == SC_GM_TABDOWN && mrViewData.GetRefType() == SC_REFTYPE_FILL &&
 380             Help::IsQuickHelpEnabled() )
 381         bDone = true;
 382
 383     if (!bDone)
 384         Window::RequestHelp( rHEvt );
 385 }
 386
 387 bool ScGridWindow::IsMyModel(const SdrEditView* pSdrView)
 388 {
 389     return pSdrView &&
 390             &pSdrView->GetModel() == mrViewData.GetDocument().GetDrawLayer();
 391 }
 392
 393 void ScGridWindow::HideNoteMarker()
 394 {
 395     mpNoteMarker.reset();
 396 }
 397
 398 css::uno::Reference< css::accessibility::XAccessible >
 399     ScGridWindow::CreateAccessible()
 400 {
 401     css::uno::Reference< css::accessibility::XAccessible > xAcc= GetAccessible(false);
 402     if (xAcc.is())
 403     {
 404         return xAcc;
 405     }
 406
 407     rtl::Reference<ScAccessibleDocument> pAccessibleDocument =
 408         new ScAccessibleDocument(GetAccessibleParentWindow()->GetAccessible(),
 409             mrViewData.GetViewShell(), eWhich);
 410     pAccessibleDocument->PreInit();
 411
 412     xAcc = pAccessibleDocument;
 413     SetAccessible(xAcc);
 414
 415     pAccessibleDocument->Init();
 416
 417     return xAcc;
 418 }
 419
 420 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */