cui/source/dialogs/hlmarkwn.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 <dialmgr.hxx>
  21 #include <sfx2/docfile.hxx>
  22 #include <unotools/viewoptions.hxx>
  23 #include <vcl/svapp.hxx>
  24 #include <vcl/settings.hxx>
  25 #include <vcl/wrkwin.hxx>
  26 #include <vcl/builderfactory.hxx>
  27
  28 // UNO-Stuff
  29 #include <comphelper/processfactory.hxx>
  30 #include <comphelper/sequence.hxx>
  31 #include <com/sun/star/awt/XBitmap.hpp>
  32 #include <com/sun/star/frame/Desktop.hpp>
  33 #include <com/sun/star/frame/XComponentLoader.hpp>
  34 #include <com/sun/star/beans/PropertyValue.hpp>
  35 #include <com/sun/star/document/XLinkTargetSupplier.hpp>
  36 #include <com/sun/star/beans/XPropertySet.hpp>
  37
  38 #include <toolkit/helper/vclunohelper.hxx>
  39 #include "svtools/treelistentry.hxx"
  40
  41 #include <cuires.hrc>
  42 #include "hlmarkwn.hxx"
  43 #include "hltpbase.hxx"
  44
  45 using namespace ::com::sun::star;
  46
  47 /*************************************************************************
  48 |*
  49 |* Userdata-struct for tree-entries
  50 |*
  51 |************************************************************************/
  52
  53 struct TargetData
  54 {
  55     OUString aUStrLinkname;
  56     bool     bIsTarget;
  57
  58     TargetData (const OUString& aUStrLName, bool bTarget)
  59         : bIsTarget(bTarget)
  60     {
  61         if (bIsTarget)
  62             aUStrLinkname = aUStrLName;
  63     }
  64 };
  65
  66 //#                                                                      #
  67 //# Tree-Window                                                          #
  68 //#                                                                      #
  69 SvxHlmarkTreeLBox::SvxHlmarkTreeLBox(vcl::Window* pParent, WinBits nStyle)
  70     : SvTreeListBox(pParent, nStyle)
  71     , mpParentWnd(NULL)
  72 {
  73     SetNodeDefaultImages();
  74 }
  75
  76 SvxHlmarkTreeLBox::~SvxHlmarkTreeLBox()
  77 {
  78     disposeOnce();
  79 }
  80
  81 void SvxHlmarkTreeLBox::dispose()
  82 {
  83     mpParentWnd.clear();
  84     SvTreeListBox::dispose();
  85 }
  86
  87 VCL_BUILDER_DECL_FACTORY(SvxHlmarkTreeLBox)
  88 {
  89     WinBits nWinStyle = WB_TABSTOP;
  90     OString sBorder = VclBuilder::extractCustomProperty(rMap);
  91     if (!sBorder.isEmpty())
  92         nWinStyle |= WB_BORDER;
  93     rRet = VclPtr<SvxHlmarkTreeLBox>::Create(pParent, nWinStyle);
  94 }
  95
  96 Size SvxHlmarkTreeLBox::GetOptimalSize() const
  97 {
  98     return LogicToPixel(Size(103, 162), MAP_APPFONT);
  99 }
 100
 101 void SvxHlmarkTreeLBox::Paint(vcl::RenderContext& rRenderContext, const Rectangle& rRect)
 102 {
 103     if (!mpParentWnd || mpParentWnd->mnError == LERR_NOERROR)
 104     {
 105         SvTreeListBox::Paint(rRenderContext, rRect);
 106     }
 107     else
 108     {
 109         Erase(rRenderContext);
 110
 111         Rectangle aDrawRect(Point( 0, 0 ), GetSizePixel());
 112
 113         OUString aStrMessage;
 114
 115         switch (mpParentWnd->mnError)
 116         {
 117         case LERR_NOENTRIES :
 118             aStrMessage = CUI_RESSTR( RID_SVXSTR_HYPDLG_ERR_LERR_NOENTRIES );
 119             break;
 120         case LERR_DOCNOTOPEN :
 121             aStrMessage = CUI_RESSTR( RID_SVXSTR_HYPDLG_ERR_LERR_DOCNOTOPEN );
 122             break;
 123         }
 124
 125         rRenderContext.DrawText(aDrawRect, aStrMessage, DrawTextFlags::Left | DrawTextFlags::MultiLine | DrawTextFlags::WordBreak);
 126     }
 127 }
 128
 129
 130 //#                                                                      #
 131 //# Window-Class                                                         #
 132 //#                                                                      #
 133
 134
 135 /*************************************************************************
 136 |*
 137 |* Constructor / Destructor
 138 |*
 139 |************************************************************************/
 140 SvxHlinkDlgMarkWnd::SvxHlinkDlgMarkWnd( SvxHyperlinkTabPageBase *pParent )
 141     : ModalDialog(pParent, "HyperlinkMark", "cui/ui/hyperlinkmarkdialog.ui")
 142     , mbUserMoved(false)
 143     , mpParent(pParent)
 144     , mnError(LERR_NOERROR)
 145 {
 146     get(mpBtApply, "apply");
 147     get(mpBtClose, "close");
 148     get(mpLbTree, "TreeListBox");
 149     mpLbTree->SetParentWnd(this);
 150
 151     mpBtApply->SetClickHdl          ( LINK ( this, SvxHlinkDlgMarkWnd, ClickApplyHdl_Impl ) );
 152     mpBtClose->SetClickHdl       ( LINK ( this, SvxHlinkDlgMarkWnd, ClickCloseHdl_Impl ) );
 153     mpLbTree->SetDoubleClickHdl  ( LINK ( this, SvxHlinkDlgMarkWnd, ClickApplyHdl_Impl ) );
 154
 155     // add lines to the Tree-ListBox
 156     mpLbTree->SetStyle( mpLbTree->GetStyle() | WB_TABSTOP | WB_BORDER | WB_HASLINES |
 157                             WB_HASBUTTONS |  //WB_HASLINESATROOT |
 158                             WB_HSCROLL | WB_HASBUTTONSATROOT );
 159 }
 160
 161 SvxHlinkDlgMarkWnd::~SvxHlinkDlgMarkWnd()
 162 {
 163     disposeOnce();
 164 }
 165
 166 void SvxHlinkDlgMarkWnd::dispose()
 167 {
 168     ClearTree();
 169     mpBtApply.clear();
 170     mpBtClose.clear();
 171     mpLbTree.clear();
 172     mpParent.clear();
 173     ModalDialog::dispose();
 174 }
 175
 176 /*************************************************************************
 177 |*
 178 |* Set an errorstatus
 179 |*
 180 |************************************************************************/
 181 sal_uInt16 SvxHlinkDlgMarkWnd::SetError( sal_uInt16 nError)
 182 {
 183     sal_uInt16 nOldError = mnError;
 184     mnError = nError;
 185
 186     if( mnError != LERR_NOERROR )
 187         ClearTree();
 188
 189     mpLbTree->Invalidate();
 190
 191     return nOldError;
 192 }
 193
 194 /*************************************************************************
 195 |*
 196 |* Move window
 197 |*
 198 |************************************************************************/
 199
 200 bool SvxHlinkDlgMarkWnd::MoveTo ( Point aNewPos )
 201 {
 202     if ( !mbUserMoved )
 203     {
 204         bool bOldStatus = mbUserMoved;
 205         SetPosPixel ( aNewPos );
 206         mbUserMoved = bOldStatus;
 207     }
 208
 209     return mbUserMoved;
 210 }
 211
 212 void SvxHlinkDlgMarkWnd::Move ()
 213 {
 214     Window::Move();
 215
 216     if ( IsReallyVisible() )
 217         mbUserMoved = true;
 218 }
 219
 220 bool SvxHlinkDlgMarkWnd::ConnectToDialog( bool bDoit )
 221 {
 222     bool bOldStatus = mbUserMoved;
 223
 224     mbUserMoved = !bDoit;
 225
 226     return bOldStatus;
 227 }
 228
 229 namespace
 230 {
 231     void SelectPath(SvTreeListEntry *pEntry, SvxHlmarkTreeLBox &rLbTree,
 232         std::deque<OUString> &rLastSelectedPath)
 233     {
 234         OUString sTitle(rLastSelectedPath.front());
 235         rLastSelectedPath.pop_front();
 236         if (sTitle.isEmpty())
 237             return;
 238         while (pEntry)
 239         {
 240             if (sTitle == rLbTree.GetEntryText(pEntry))
 241             {
 242                 rLbTree.Select(pEntry);
 243                 rLbTree.MakeVisible(pEntry);
 244                 if (!rLastSelectedPath.empty())
 245                 {
 246                     rLbTree.Expand(pEntry);
 247                     SelectPath(rLbTree.FirstChild(pEntry), rLbTree, rLastSelectedPath);
 248                 }
 249                 break;
 250             }
 251             pEntry = SvTreeListBox::NextSibling(pEntry);
 252         }
 253     }
 254 }
 255
 256 #define TG_SETTING_MANAGER  "TargetInDocument"
 257 #define TG_SETTING_LASTMARK "LastSelectedMark"
 258 #define TG_SETTING_LASTPATH "LastSelectedPath"
 259
 260 void SvxHlinkDlgMarkWnd::RestoreLastSelection()
 261 {
 262     bool bSelectedEntry = false;
 263
 264     OUString sLastSelectedMark;
 265     std::deque<OUString> aLastSelectedPath;
 266     SvtViewOptions aViewSettings( E_DIALOG, TG_SETTING_MANAGER );
 267     if (aViewSettings.Exists())
 268     {
 269         //Maybe we might want to have some sort of mru list and keep a mapping
 270         //per document, rather than the current reuse of "the last thing
 271         //selected, regardless of the document"
 272         aViewSettings.GetUserItem(TG_SETTING_LASTMARK) >>= sLastSelectedMark;
 273         uno::Sequence<OUString> aTmp;
 274         aViewSettings.GetUserItem(TG_SETTING_LASTPATH) >>= aTmp;
 275         aLastSelectedPath = comphelper::sequenceToContainer< std::deque<OUString> >(aTmp);
 276     }
 277     //fallback to previous entry selected the last
 278     //time we executed this dialog. First see if
 279     //the exact mark exists and re-use that
 280     if (!sLastSelectedMark.isEmpty())
 281         bSelectedEntry = SelectEntry(sLastSelectedMark);
 282     //Otherwise just select the closest path available
 283     //now to what was available at dialog close time
 284     if (!bSelectedEntry && !aLastSelectedPath.empty())
 285     {
 286         std::deque<OUString> aTmpSelectedPath(aLastSelectedPath);
 287         SelectPath(mpLbTree->First(), *mpLbTree, aTmpSelectedPath);
 288     }
 289 }
 290
 291 /*************************************************************************
 292 |*
 293 |* Interface to refresh tree
 294 |*
 295 |************************************************************************/
 296
 297 void SvxHlinkDlgMarkWnd::RefreshTree (const OUString& aStrURL)
 298 {
 299     OUString aUStrURL;
 300
 301     EnterWait();
 302
 303     ClearTree();
 304
 305     sal_Int32 nPos = aStrURL.indexOf('#');
 306
 307     if (nPos != 0)
 308         aUStrURL = aStrURL;
 309
 310     if (!RefreshFromDoc(aUStrURL))
 311         mpLbTree->Invalidate();
 312
 313     bool bSelectedEntry = false;
 314
 315     if ( nPos != -1 )
 316     {
 317         OUString aStrMark = aStrURL.copy(nPos+1);
 318         bSelectedEntry = SelectEntry(aStrMark);
 319     }
 320
 321     if (!bSelectedEntry)
 322         RestoreLastSelection();
 323
 324     LeaveWait();
 325
 326     maStrLastURL = aStrURL;
 327 }
 328
 329 /*************************************************************************
 330 |*
 331 |* get links from document
 332 |*
 333 |************************************************************************/
 334
 335 bool SvxHlinkDlgMarkWnd::RefreshFromDoc(const OUString& aURL)
 336 {
 337     mnError = LERR_NOERROR;
 338
 339     uno::Reference< frame::XDesktop2 > xDesktop = frame::Desktop::create( ::comphelper::getProcessComponentContext() );
 340     uno::Reference< lang::XComponent > xComp;
 341
 342     if( !aURL.isEmpty() )
 343     {
 344         // load from url
 345         uno::Reference< frame::XComponentLoader > xLoader( xDesktop, uno::UNO_QUERY );
 346         if( xLoader.is() )
 347         {
 348             try
 349             {
 350                 uno::Sequence< beans::PropertyValue > aArg(1);
 351                 aArg.getArray()[0].Name = "Hidden";
 352                 aArg.getArray()[0].Value <<= true;
 353                 xComp = xLoader->loadComponentFromURL( aURL, OUString( "_blank" ), 0, aArg );
 354             }
 355             catch( const io::IOException& )
 356             {
 357
 358             }
 359             catch( const lang::IllegalArgumentException& )
 360             {
 361
 362             }
 363         }
 364     }
 365     else
 366     {
 367         // the component with user focus ( current document )
 368         xComp = xDesktop->getCurrentComponent();
 369     }
 370
 371     if( xComp.is() )
 372     {
 373         uno::Reference< document::XLinkTargetSupplier > xLTS( xComp, uno::UNO_QUERY );
 374
 375         if( xLTS.is() )
 376         {
 377             if( FillTree( xLTS->getLinks() ) == 0 )
 378                 mnError = LERR_NOENTRIES;
 379         }
 380         else
 381             mnError = LERR_DOCNOTOPEN;
 382
 383         if ( !aURL.isEmpty() )
 384             xComp->dispose();
 385     }
 386     else
 387     {
 388         if( !aURL.isEmpty() )
 389             mnError=LERR_DOCNOTOPEN;
 390     }
 391     return (mnError==0);
 392 }
 393 /*************************************************************************
 394 |*
 395 |* Fill Tree-Control
 396 |*
 397 |************************************************************************/
 398
 399 int SvxHlinkDlgMarkWnd::FillTree( uno::Reference< container::XNameAccess > xLinks, SvTreeListEntry* pParentEntry )
 400 {
 401     int nEntries=0;
 402     const uno::Sequence< OUString > aNames( xLinks->getElementNames() );
 403     const sal_uLong nLinks = aNames.getLength();
 404     const OUString* pNames = aNames.getConstArray();
 405
 406     Color aMaskColor( COL_LIGHTMAGENTA );
 407     const OUString aProp_LinkDisplayName( "LinkDisplayName" );
 408     const OUString aProp_LinkTarget( "com.sun.star.document.LinkTarget" );
 409     const OUString aProp_LinkDisplayBitmap( "LinkDisplayBitmap" );
 410     for( sal_uLong i = 0; i < nLinks; i++ )
 411     {
 412         uno::Any aAny;
 413         OUString aLink( *pNames++ );
 414
 415         bool bError = false;
 416         try
 417         {
 418             aAny = xLinks->getByName( aLink );
 419         }
 420         catch(const uno::Exception&)
 421         {
 422             // if the name of the target was invalid (like empty headings)
 423             // no object can be provided
 424             bError = true;
 425         }
 426         if(bError)
 427             continue;
 428
 429         uno::Reference< beans::XPropertySet > xTarget;
 430
 431         if( aAny >>= xTarget )
 432         {
 433             try
 434             {
 435                 // get name to display
 436                 aAny = xTarget->getPropertyValue( aProp_LinkDisplayName );
 437                 OUString aDisplayName;
 438                 aAny >>= aDisplayName;
 439                 OUString aStrDisplayname ( aDisplayName );
 440
 441                 // is it a target ?
 442                 uno::Reference< lang::XServiceInfo > xSI( xTarget, uno::UNO_QUERY );
 443                 bool bIsTarget = xSI->supportsService( aProp_LinkTarget );
 444
 445                 // create userdata
 446                 TargetData *pData = new TargetData ( aLink, bIsTarget );
 447
 448                 SvTreeListEntry* pEntry;
 449
 450                 try
 451                 {
 452                     // get bitmap for the tree-entry
 453                     uno::Reference< awt::XBitmap > aXBitmap( xTarget->getPropertyValue( aProp_LinkDisplayBitmap ), uno::UNO_QUERY );
 454                     if( aXBitmap.is() )
 455                     {
 456                         Image aBmp( VCLUnoHelper::GetBitmap( aXBitmap ).GetBitmap(), aMaskColor );
 457                         // insert Displayname into treelist with bitmaps
 458                         pEntry = mpLbTree->InsertEntry ( aStrDisplayname,
 459                                                         aBmp, aBmp,
 460                                                         pParentEntry,
 461                                                         false, TREELIST_APPEND,
 462                                                         (void*)pData );
 463                         nEntries++;
 464                     }
 465                     else
 466                     {
 467                         // insert Displayname into treelist without bitmaps
 468                         pEntry = mpLbTree->InsertEntry ( aStrDisplayname,
 469                                                         pParentEntry,
 470                                                         false, TREELIST_APPEND,
 471                                                         (void*)pData );
 472                         nEntries++;
 473                     }
 474                 }
 475                 catch(const com::sun::star::uno::Exception&)
 476                 {
 477                     // insert Displayname into treelist without bitmaps
 478                     pEntry = mpLbTree->InsertEntry ( aStrDisplayname,
 479                                                     pParentEntry,
 480                                                     false, TREELIST_APPEND,
 481                                                     (void*)pData );
 482                     nEntries++;
 483                 }
 484
 485                 uno::Reference< document::XLinkTargetSupplier > xLTS( xTarget, uno::UNO_QUERY );
 486                 if( xLTS.is() )
 487                     nEntries += FillTree( xLTS->getLinks(), pEntry );
 488             }
 489             catch(const com::sun::star::uno::Exception&)
 490             {
 491             }
 492         }
 493     }
 494
 495     return nEntries;
 496 }
 497
 498 /*************************************************************************
 499 |*
 500 |* Clear Tree
 501 |*
 502 |************************************************************************/
 503
 504 void SvxHlinkDlgMarkWnd::ClearTree()
 505 {
 506     SvTreeListEntry* pEntry = mpLbTree->First();
 507
 508     while ( pEntry )
 509     {
 510         TargetData* pUserData = static_cast<TargetData *>(pEntry->GetUserData());
 511         delete pUserData;
 512
 513         pEntry = mpLbTree->Next( pEntry );
 514     }
 515
 516     mpLbTree->Clear();
 517 }
 518
 519 /*************************************************************************
 520 |*
 521 |* Find Entry for String
 522 |*
 523 |************************************************************************/
 524
 525 SvTreeListEntry* SvxHlinkDlgMarkWnd::FindEntry (const OUString& aStrName)
 526 {
 527     bool bFound=false;
 528     SvTreeListEntry* pEntry = mpLbTree->First();
 529
 530     while ( pEntry && !bFound )
 531     {
 532         TargetData* pUserData = static_cast<TargetData *>(pEntry->GetUserData ());
 533         if (aStrName == pUserData->aUStrLinkname)
 534             bFound = true;
 535         else
 536             pEntry = mpLbTree->Next( pEntry );
 537     }
 538
 539     return pEntry;
 540 }
 541
 542 /*************************************************************************
 543 |*
 544 |* Select Entry
 545 |*
 546 |************************************************************************/
 547
 548 bool SvxHlinkDlgMarkWnd::SelectEntry(const OUString& aStrMark)
 549 {
 550     SvTreeListEntry* pEntry = FindEntry(aStrMark);
 551     if (!pEntry)
 552         return false;
 553     mpLbTree->Select(pEntry);
 554     mpLbTree->MakeVisible (pEntry);
 555     return true;
 556 }
 557
 558 /*************************************************************************
 559 |*
 560 |* Click on Apply-Button / Doubleclick on item in tree
 561 |*
 562 |************************************************************************/
 563
 564 IMPL_LINK_NOARG(SvxHlinkDlgMarkWnd, ClickApplyHdl_Impl)
 565 {
 566     SvTreeListEntry* pEntry = mpLbTree->GetCurEntry();
 567
 568     if ( pEntry )
 569     {
 570         TargetData *pData = static_cast<TargetData *>(pEntry->GetUserData());
 571
 572         if ( pData->bIsTarget )
 573         {
 574             mpParent->SetMarkStr(pData->aUStrLinkname);
 575         }
 576     }
 577
 578     return 0L;
 579 }
 580
 581 /*************************************************************************
 582 |*
 583 |* Click on Close-Button
 584 |*
 585 |************************************************************************/
 586
 587 IMPL_LINK_NOARG(SvxHlinkDlgMarkWnd, ClickCloseHdl_Impl)
 588 {
 589     SvTreeListEntry* pEntry = mpLbTree->GetCurEntry();
 590     if ( pEntry )
 591     {
 592         TargetData* pUserData = static_cast<TargetData *>(pEntry->GetUserData());
 593         OUString sLastSelectedMark = pUserData->aUStrLinkname;
 594
 595         std::deque<OUString> aLastSelectedPath;
 596         if (pEntry)
 597         {
 598             //If the bottommost entry is expanded but nothing
 599             //underneath it is selected leave a dummy entry
 600             if (mpLbTree->IsExpanded(pEntry))
 601                 aLastSelectedPath.push_front(OUString());
 602             while (pEntry)
 603             {
 604                 aLastSelectedPath.push_front(mpLbTree->GetEntryText(pEntry));
 605                 pEntry = mpLbTree->GetParent(pEntry);
 606             }
 607         }
 608
 609         uno::Sequence< beans::NamedValue > aSettings(2);
 610         aSettings[0].Name = TG_SETTING_LASTMARK;
 611         aSettings[0].Value <<= sLastSelectedMark;
 612         aSettings[1].Name = TG_SETTING_LASTPATH;
 613         aSettings[1].Value <<= comphelper::containerToSequence<OUString>(aLastSelectedPath);
 614
 615         // write
 616         SvtViewOptions aViewSettings( E_DIALOG, TG_SETTING_MANAGER );
 617         aViewSettings.SetUserData( aSettings );
 618     }
 619
 620     Close();
 621
 622     return 0L;
 623 }
 624
 625 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */