cui/source/dialogs/hltpbase.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 <comphelper/lok.hxx>
  24 #include <osl/file.hxx>
  25 #include <sfx2/app.hxx>
  26 #include <sfx2/event.hxx>
  27 #include <sfx2/frame.hxx>
  28 #include <sfx2/viewfrm.hxx>
  29 #include <sot/formats.hxx>
  30 #include <sfx2/sfxsids.hrc>
  31 #include <svl/macitem.hxx>
  32 #include <ucbhelper/content.hxx>
  33 #include <cuihyperdlg.hxx>
  34 #include <hltpbase.hxx>
  35 #include <macroass.hxx>
  36 #include <svx/svxdlg.hxx>
  37 #include <strings.hrc>
  38 #include <dialmgr.hxx>
  39 #include <bitmaps.hlst>
  40
  41 namespace {
  42
  43 OUString CreateUiNameFromURL( const OUString& aStrURL )
  44 {
  45     OUString          aStrUiURL;
  46     INetURLObject   aURLObj( aStrURL );
  47
  48     switch(aURLObj.GetProtocol())
  49     {
  50         case INetProtocol::File:
  51             osl::FileBase::getSystemPathFromFileURL(aURLObj.GetMainURL(INetURLObject::DecodeMechanism::NONE), aStrUiURL);
  52             break;
  53         case INetProtocol::Ftp :
  54             {
  55                 //remove password from name
  56                 INetURLObject   aTmpURL(aURLObj);
  57                 aTmpURL.SetPass(u"");
  58                 aStrUiURL = aTmpURL.GetMainURL( INetURLObject::DecodeMechanism::Unambiguous );
  59             }
  60             break;
  61         default :
  62             {
  63                 aStrUiURL = aURLObj.GetMainURL(INetURLObject::DecodeMechanism::Unambiguous);
  64             }
  65     }
  66     if(aStrUiURL.isEmpty())
  67         return aStrURL;
  68     return aStrUiURL;
  69 }
  70
  71 }
  72
  73 // ComboBox-Control for URL's with History and Autocompletion
  74 SvxHyperURLBox::SvxHyperURLBox(std::unique_ptr<weld::ComboBox> xControl)
  75     : SvtURLBox(std::move(xControl))
  76     , DropTargetHelper(getWidget()->get_drop_target())
  77 {
  78     SetSmartProtocol(INetProtocol::Http);
  79 }
  80
  81 sal_Int8 SvxHyperURLBox::AcceptDrop( const AcceptDropEvent& /* rEvt */ )
  82 {
  83     return IsDropFormatSupported( SotClipboardFormatId::STRING ) ? DND_ACTION_COPY : DND_ACTION_NONE;
  84 }
  85
  86 sal_Int8 SvxHyperURLBox::ExecuteDrop( const ExecuteDropEvent& rEvt )
  87 {
  88     TransferableDataHelper  aDataHelper( rEvt.maDropEvent.Transferable );
  89     OUString                aString;
  90     sal_Int8                nRet = DND_ACTION_NONE;
  91
  92     if( aDataHelper.GetString( SotClipboardFormatId::STRING, aString ) )
  93     {
  94         set_entry_text(aString);
  95         nRet = DND_ACTION_COPY;
  96     }
  97
  98     return nRet;
  99 }
 100
 101 //# Hyperlink-Dialog: Tabpages-Baseclass                                 #
 102
 103 SvxHyperlinkTabPageBase::SvxHyperlinkTabPageBase(weld::Container* pParent,
 104                                                  SvxHpLinkDlg* pDlg,
 105                                                  const OUString& rUIXMLDescription,
 106                                                  const OUString& rID,
 107                                                  const SfxItemSet* pItemSet)
 108   : IconChoicePage(pParent, rUIXMLDescription, rID, pItemSet)
 109   , mxCbbFrame(xBuilder->weld_combo_box(u"frame"_ustr))
 110   , mxLbForm(xBuilder->weld_combo_box(u"form"_ustr))
 111   , mxEdIndication(xBuilder->weld_entry(u"indication"_ustr))
 112   , mxEdText(xBuilder->weld_entry(u"name"_ustr))
 113   , mxBtScript(xBuilder->weld_button(u"script"_ustr))
 114   , mxFormLabel(xBuilder->weld_label(u"form_label"_ustr))
 115   , mxFrameLabel(xBuilder->weld_label(u"frame_label"_ustr))
 116   , mbIsCloseDisabled( false )
 117   , mpDialog( pDlg )
 118   , mbStdControlsInit( false )
 119   , maTimer("cui SvxHyperlinkTabPageBase maTimer")
 120 {
 121     // create bookmark-window
 122 }
 123
 124 SvxHyperlinkTabPageBase::~SvxHyperlinkTabPageBase()
 125 {
 126     maTimer.Stop();
 127
 128     HideMarkWnd();
 129 }
 130
 131 bool SvxHyperlinkTabPageBase::QueryClose()
 132 {
 133     return !mbIsCloseDisabled;
 134 }
 135
 136 void SvxHyperlinkTabPageBase::InitStdControls ()
 137 {
 138     if ( !mbStdControlsInit )
 139     {
 140         SfxDispatcher* pDispatch = GetDispatcher();
 141         SfxViewFrame* pViewFrame = pDispatch ? pDispatch->GetFrame() : nullptr;
 142         SfxFrame* pFrame = pViewFrame ? &pViewFrame->GetFrame() : nullptr;
 143         if ( pFrame )
 144         {
 145             TargetList aList;
 146             SfxFrame::GetDefaultTargetList(aList);
 147             if( !aList.empty() )
 148             {
 149                 size_t nCount = aList.size();
 150                 size_t i;
 151                 for ( i = 0; i < nCount; i++ )
 152                 {
 153                     mxCbbFrame->append_text( aList.at( i ) );
 154                 }
 155             }
 156         }
 157
 158         mxBtScript->set_from_icon_name(RID_SVXBMP_SCRIPT);
 159
 160         mxBtScript->connect_clicked ( LINK ( this, SvxHyperlinkTabPageBase, ClickScriptHdl_Impl ) );
 161     }
 162
 163     mbStdControlsInit = true;
 164 }
 165
 166 // Move Extra-Window
 167 void SvxHyperlinkTabPageBase::MoveToExtraWnd( Point aNewPos )
 168 {
 169     mxMarkWnd->MoveTo(aNewPos);
 170 }
 171
 172 // Show Extra-Window
 173 void SvxHyperlinkTabPageBase::ShowMarkWnd()
 174 {
 175     if (mxMarkWnd)
 176     {
 177         mxMarkWnd->getDialog()->present();
 178         return;
 179     }
 180
 181     weld::Dialog* pDialog = mpDialog->getDialog();
 182
 183     mxMarkWnd = std::make_shared<SvxHlinkDlgMarkWnd>(pDialog, this);
 184
 185     // Size of dialog-window in screen pixels
 186     Point aDlgPos(pDialog->get_position());
 187     Size aDlgSize(pDialog->get_size());
 188
 189     // Absolute size of the screen
 190     ::tools::Rectangle aScreen(pDialog->get_monitor_workarea());
 191
 192     // Size of Extrawindow
 193     Size aExtraWndSize(mxMarkWnd->getDialog()->get_preferred_size());
 194
 195     // mxMarkWnd is a child of mpDialog, so coordinates for positioning must be relative to mpDialog
 196     if( aDlgPos.X()+(1.05*aDlgSize.Width())+aExtraWndSize.Width() > aScreen.Right() )
 197     {
 198         if( aDlgPos.X() - ( 0.05*aDlgSize.Width() ) - aExtraWndSize.Width() < 0 )
 199         {
 200             // Pos Extrawindow anywhere
 201             MoveToExtraWnd( Point(10,10) );  // very unlikely
 202         }
 203         else
 204         {
 205             // Pos Extrawindow on the left side of Dialog
 206             MoveToExtraWnd( Point(0,0) - Point( tools::Long(0.05*aDlgSize.Width()), 0 ) - Point( aExtraWndSize.Width(), 0 ) );
 207         }
 208     }
 209     else
 210     {
 211         // Pos Extrawindow on the right side of Dialog
 212         MoveToExtraWnd ( Point( tools::Long(1.05*aDlgSize.getWidth()), 0 ) );
 213     }
 214
 215     // Set size of Extra-Window
 216     mxMarkWnd->getDialog()->set_size_request(aExtraWndSize.Width(), aDlgSize.Height());
 217
 218     weld::DialogController::runAsync(mxMarkWnd, [this](sal_Int32 /*nResult*/) { mxMarkWnd.reset(); } );
 219 }
 220
 221 void SvxHyperlinkTabPageBase::HideMarkWnd()
 222 {
 223     if (mxMarkWnd)
 224     {
 225         mxMarkWnd->response(RET_CANCEL);
 226         mxMarkWnd.reset();
 227     }
 228 }
 229
 230 // Fill Dialogfields
 231 void SvxHyperlinkTabPageBase::FillStandardDlgFields ( const SvxHyperlinkItem* pHyperlinkItem )
 232 {
 233     if (!comphelper::LibreOfficeKit::isActive())
 234     {
 235         // Frame
 236         sal_Int32 nPos = mxCbbFrame->find_text(pHyperlinkItem->GetTargetFrame());
 237         if (nPos != -1)
 238             mxCbbFrame->set_active(nPos);
 239
 240         // Form
 241         OUString aStrFormText = CuiResId( RID_CUISTR_HYPERDLG_FROM_TEXT );
 242
 243         OUString aStrFormButton = CuiResId( RID_CUISTR_HYPERDLG_FORM_BUTTON );
 244
 245         if( pHyperlinkItem->GetInsertMode() & HLINK_HTMLMODE )
 246         {
 247             mxLbForm->clear();
 248             mxLbForm->append_text( aStrFormText );
 249             mxLbForm->set_active( 0 );
 250         }
 251         else
 252         {
 253             mxLbForm->clear();
 254             mxLbForm->append_text( aStrFormText );
 255             mxLbForm->append_text( aStrFormButton );
 256             mxLbForm->set_active( pHyperlinkItem->GetInsertMode() == HLINK_BUTTON ? 1 : 0 );
 257         }
 258     }
 259     else
 260     {
 261         mxCbbFrame->hide();
 262         mxLbForm->hide();
 263         mxFormLabel->hide();
 264         mxFrameLabel->hide();
 265     }
 266
 267     // URL
 268     mxEdIndication->set_text( pHyperlinkItem->GetName() );
 269
 270     // Name
 271     mxEdText->set_text( pHyperlinkItem->GetIntName() );
 272
 273     // Script-button
 274     if (!comphelper::LibreOfficeKit::isActive())
 275     {
 276         if ( pHyperlinkItem->GetMacroEvents() == HyperDialogEvent::NONE )
 277             mxBtScript->set_sensitive(false);
 278         else
 279             mxBtScript->set_sensitive(true);
 280     }
 281     else
 282     {
 283         mxBtScript->hide();
 284     }
 285 }
 286
 287 // Any action to do after apply-button is pressed
 288 void SvxHyperlinkTabPageBase::DoApply ()
 289 {
 290     // default-implementation : do nothing
 291 }
 292
 293 // This method would be called from bookmark-window to set new mark-string
 294 void SvxHyperlinkTabPageBase::SetMarkStr ( const OUString& /*aStrMark*/ )
 295 {
 296     // default-implementation : do nothing
 297 }
 298
 299 // Set initial focus
 300 void SvxHyperlinkTabPageBase::SetInitFocus()
 301 {
 302     xContainer->grab_focus();
 303 }
 304
 305 // retrieve dispatcher
 306 SfxDispatcher* SvxHyperlinkTabPageBase::GetDispatcher() const
 307 {
 308     return mpDialog->GetDispatcher();
 309 }
 310
 311 void SvxHyperlinkTabPageBase::DisableClose(bool _bDisable)
 312 {
 313     mbIsCloseDisabled = _bDisable;
 314     if (mbIsCloseDisabled)
 315         maBusy.incBusy(mpDialog->getDialog());
 316     else
 317         maBusy.decBusy();
 318 }
 319
 320 // Click on imagebutton : Script
 321 IMPL_LINK_NOARG(SvxHyperlinkTabPageBase, ClickScriptHdl_Impl, weld::Button&, void)
 322 {
 323     SvxHyperlinkItem *pHyperlinkItem = const_cast<SvxHyperlinkItem*>(
 324                                        GetItemSet().GetItem (SID_HYPERLINK_GETLINK));
 325
 326     if (!pHyperlinkItem || pHyperlinkItem->GetMacroEvents() == HyperDialogEvent::NONE)
 327         return;
 328
 329     // get macros from itemset
 330     const SvxMacroTableDtor* pMacroTbl = pHyperlinkItem->GetMacroTable();
 331     SvxMacroItem aItem ( SID_ATTR_MACROITEM );
 332     if( pMacroTbl )
 333         aItem.SetMacroTable( *pMacroTbl );
 334
 335     // create empty itemset for macro-dlg
 336     auto xItemSet = std::make_unique<SfxItemSetFixed<SID_ATTR_MACROITEM, SID_ATTR_MACROITEM>>( SfxGetpApp()->GetPool() );
 337     xItemSet->Put( aItem );
 338
 339     DisableClose( true );
 340
 341     SfxMacroAssignDlg aDlg(mpDialog->getDialog(), mxDocumentFrame, std::move(xItemSet));
 342
 343     // add events
 344     SfxMacroTabPage *pMacroPage = aDlg.GetTabPage();
 345
 346     if ( pHyperlinkItem->GetMacroEvents() & HyperDialogEvent::MouseOverObject )
 347         pMacroPage->AddEvent( CuiResId(RID_CUISTR_HYPDLG_MACROACT1),
 348                               SvMacroItemId::OnMouseOver );
 349     if ( pHyperlinkItem->GetMacroEvents() & HyperDialogEvent::MouseClickObject )
 350         pMacroPage->AddEvent( CuiResId(RID_CUISTR_HYPDLG_MACROACT2),
 351                               SvMacroItemId::OnClick);
 352     if ( pHyperlinkItem->GetMacroEvents() & HyperDialogEvent::MouseOutObject )
 353         pMacroPage->AddEvent( CuiResId(RID_CUISTR_HYPDLG_MACROACT3),
 354                               SvMacroItemId::OnMouseOut);
 355     // execute dlg
 356     short nRet = aDlg.run();
 357     DisableClose( false );
 358     if ( RET_OK == nRet )
 359     {
 360         const SfxItemSet* pOutSet = aDlg.GetOutputItemSet();
 361         const SfxPoolItem* pItem;
 362         if( SfxItemState::SET == pOutSet->GetItemState( SID_ATTR_MACROITEM, false, &pItem ))
 363         {
 364             pHyperlinkItem->SetMacroTable( static_cast<const SvxMacroItem*>(pItem)->GetMacroTable() );
 365         }
 366     }
 367 }
 368
 369 // Get Macro-Infos
 370 HyperDialogEvent SvxHyperlinkTabPageBase::GetMacroEvents() const
 371 {
 372     const SvxHyperlinkItem *pHyperlinkItem =
 373                                        GetItemSet().GetItem (SID_HYPERLINK_GETLINK);
 374
 375     return pHyperlinkItem ? pHyperlinkItem->GetMacroEvents() : HyperDialogEvent();
 376 }
 377
 378 SvxMacroTableDtor* SvxHyperlinkTabPageBase::GetMacroTable()
 379 {
 380     const SvxHyperlinkItem *pHyperlinkItem =
 381                                        GetItemSet().GetItem (SID_HYPERLINK_GETLINK);
 382
 383     return const_cast<SvxMacroTableDtor*>(pHyperlinkItem->GetMacroTable());
 384 }
 385
 386 // try to detect the current protocol that is used in rStrURL
 387 OUString SvxHyperlinkTabPageBase::GetSchemeFromURL( const OUString& rStrURL )
 388 {
 389     OUString aStrScheme;
 390
 391     INetURLObject aURL( rStrURL );
 392     INetProtocol aProtocol = aURL.GetProtocol();
 393
 394     // our new INetUrlObject now has the ability
 395     // to detect if a Url is valid or not :-(
 396     if ( aProtocol == INetProtocol::NotValid )
 397     {
 398         if ( rStrURL.startsWithIgnoreAsciiCase( INET_HTTP_SCHEME ) )
 399         {
 400             aStrScheme = INET_HTTP_SCHEME;
 401         }
 402         else if ( rStrURL.startsWithIgnoreAsciiCase( INET_HTTPS_SCHEME ) )
 403         {
 404             aStrScheme = INET_HTTPS_SCHEME;
 405         }
 406         else if ( rStrURL.startsWithIgnoreAsciiCase( INET_FTP_SCHEME ) )
 407         {
 408             aStrScheme = INET_FTP_SCHEME;
 409         }
 410         else if ( rStrURL.startsWithIgnoreAsciiCase( INET_MAILTO_SCHEME ) )
 411         {
 412             aStrScheme = INET_MAILTO_SCHEME;
 413         }
 414     }
 415     else
 416         aStrScheme = INetURLObject::GetScheme( aProtocol );
 417     return aStrScheme;
 418 }
 419
 420 void SvxHyperlinkTabPageBase::GetDataFromCommonFields( OUString& aStrName,
 421                                              OUString& aStrIntName, OUString& aStrFrame,
 422                                              SvxLinkInsertMode& eMode )
 423 {
 424     aStrIntName = mxEdText->get_text();
 425     aStrName    = mxEdIndication->get_text();
 426     aStrFrame   = mxCbbFrame->get_active_text();
 427
 428     sal_Int32 nPos = mxLbForm->get_active();
 429     if (nPos == -1)
 430         // This happens when FillStandardDlgFields() hides mpLbForm.
 431         nPos = 0;
 432     eMode = static_cast<SvxLinkInsertMode>(nPos + 1);
 433
 434     // Ask dialog whether the current doc is a HTML-doc
 435     if (mpDialog->IsHTMLDoc())
 436         eMode = static_cast<SvxLinkInsertMode>( sal_uInt16(eMode) | HLINK_HTMLMODE );
 437 }
 438
 439 // reset dialog-fields
 440 void SvxHyperlinkTabPageBase::Reset( const SfxItemSet& rItemSet )
 441 {
 442
 443     // Set dialog-fields from create-itemset
 444     maStrInitURL.clear();
 445
 446     const SvxHyperlinkItem *pHyperlinkItem =
 447                                        rItemSet.GetItem (SID_HYPERLINK_GETLINK);
 448
 449     if ( pHyperlinkItem )
 450     {
 451         // set dialog-fields
 452         FillStandardDlgFields (pHyperlinkItem);
 453
 454         // set all other fields
 455         FillDlgFields(pHyperlinkItem->GetURL());
 456
 457         // Store initial URL
 458         maStrInitURL = pHyperlinkItem->GetURL();
 459     }
 460 }
 461
 462 // Fill output-ItemSet
 463 bool SvxHyperlinkTabPageBase::FillItemSet( SfxItemSet* rOut)
 464 {
 465     OUString aStrURL, aStrName, aStrIntName, aStrFrame;
 466     SvxLinkInsertMode eMode;
 467
 468     GetCurrentItemData ( aStrURL, aStrName, aStrIntName, aStrFrame, eMode);
 469     if ( aStrName.isEmpty() ) //automatically create a visible name if the link is created without name
 470         aStrName = CreateUiNameFromURL(aStrURL);
 471
 472     HyperDialogEvent nEvents = GetMacroEvents();
 473     SvxMacroTableDtor* pTable = GetMacroTable();
 474
 475     SvxHyperlinkItem aItem( SID_HYPERLINK_SETLINK, aStrName, aStrURL, aStrFrame,
 476                             aStrIntName, eMode, nEvents, pTable );
 477     rOut->Put (aItem);
 478
 479     return true;
 480 }
 481
 482 // Activate / Deactivate Tabpage
 483 void SvxHyperlinkTabPageBase::ActivatePage( const SfxItemSet& rItemSet )
 484 {
 485
 486     // Set dialog-fields from input-itemset
 487     const SvxHyperlinkItem *pHyperlinkItem =
 488                                        rItemSet.GetItem (SID_HYPERLINK_GETLINK);
 489
 490     if ( pHyperlinkItem )
 491     {
 492         // standard-fields
 493         FillStandardDlgFields (pHyperlinkItem);
 494     }
 495
 496     // show mark-window if it was open before
 497     if ( ShouldOpenMarkWnd () )
 498         ShowMarkWnd ();
 499 }
 500
 501 DeactivateRC SvxHyperlinkTabPageBase::DeactivatePage( SfxItemSet* _pSet)
 502 {
 503     // hide mark-wnd
 504     SetMarkWndShouldOpen( IsMarkWndVisible () );
 505     HideMarkWnd ();
 506
 507     // retrieve data of dialog
 508     OUString aStrURL, aStrName, aStrIntName, aStrFrame;
 509     SvxLinkInsertMode eMode;
 510
 511     GetCurrentItemData ( aStrURL, aStrName, aStrIntName, aStrFrame, eMode);
 512
 513     HyperDialogEvent nEvents = GetMacroEvents();
 514     SvxMacroTableDtor* pTable = GetMacroTable();
 515
 516     if( _pSet )
 517     {
 518         SvxHyperlinkItem aItem( SID_HYPERLINK_GETLINK, aStrName, aStrURL, aStrFrame,
 519                                 aStrIntName, eMode, nEvents, pTable );
 520         _pSet->Put( aItem );
 521     }
 522
 523     return DeactivateRC::LeavePage;
 524 }
 525
 526 bool SvxHyperlinkTabPageBase::ShouldOpenMarkWnd()
 527 {
 528     return false;
 529 }
 530
 531 void SvxHyperlinkTabPageBase::SetMarkWndShouldOpen(bool)
 532 {
 533 }
 534
 535 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */