cui/source/dialogs/iconcdlg.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 <sfx2/app.hxx>
  21
  22 #include <iconcdlg.hxx>
  23 #include <cuihyperdlg.hxx>
  24
  25 #include <sal/log.hxx>
  26 #include <unotools/viewoptions.hxx>
  27 #include <svtools/apearcfg.hxx>
  28 #include <vcl/mnemonic.hxx>
  29 #include <vcl/i18nhelp.hxx>
  30 #include <vcl/settings.hxx>
  31 #include <vcl/builderfactory.hxx>
  32
  33 /**********************************************************************
  34 |
  35 | Ctor / Dtor
  36 |
  37 \**********************************************************************/
  38
  39 IconChoicePage::IconChoicePage( vcl::Window *pParent, const OString& rID,
  40                                 const OUString& rUIXMLDescription,
  41                                 const SfxItemSet* pItemSet )
  42 :   TabPage                   ( pParent, rID, rUIXMLDescription ),
  43     pSet                      ( pItemSet ),
  44     bHasExchangeSupport       ( false )
  45 {
  46     SetStyle ( GetStyle()  | WB_DIALOGCONTROL | WB_HIDE );
  47 }
  48
  49
  50 IconChoicePage::~IconChoicePage()
  51 {
  52     disposeOnce();
  53 }
  54
  55 /**********************************************************************
  56 |
  57 | Activate / Deactivate
  58 |
  59 \**********************************************************************/
  60
  61 void IconChoicePage::ActivatePage( const SfxItemSet& )
  62 {
  63 }
  64
  65
  66 DeactivateRC IconChoicePage::DeactivatePage( SfxItemSet* )
  67 {
  68     return DeactivateRC::LeavePage;
  69 }
  70
  71 bool IconChoicePage::QueryClose()
  72 {
  73     return true;
  74 }
  75
  76 /**********************************************************************
  77 |
  78 | window-methods
  79 |
  80 \**********************************************************************/
  81
  82 void IconChoicePage::ImplInitSettings()
  83 {
  84     vcl::Window* pParent = GetParent();
  85     if ( pParent->IsChildTransparentModeEnabled() && !IsControlBackground() )
  86     {
  87         EnableChildTransparentMode();
  88         SetParentClipMode( ParentClipMode::NoClip );
  89         SetPaintTransparent( true );
  90         SetBackground();
  91     }
  92     else
  93     {
  94         EnableChildTransparentMode( false );
  95         SetParentClipMode();
  96         SetPaintTransparent( false );
  97
  98         if ( IsControlBackground() )
  99             SetBackground( GetControlBackground() );
 100         else
 101             SetBackground( pParent->GetBackground() );
 102     }
 103 }
 104
 105
 106 void IconChoicePage::StateChanged( StateChangedType nType )
 107 {
 108     Window::StateChanged( nType );
 109
 110     if ( nType == StateChangedType::ControlBackground )
 111     {
 112         ImplInitSettings();
 113         Invalidate();
 114     }
 115 }
 116
 117
 118 void IconChoicePage::DataChanged( const DataChangedEvent& rDCEvt )
 119 {
 120     Window::DataChanged( rDCEvt );
 121
 122     if ( (rDCEvt.GetType() == DataChangedEventType::SETTINGS) &&
 123          (rDCEvt.GetFlags() & AllSettingsFlags::STYLE) )
 124     {
 125         ImplInitSettings();
 126         Invalidate();
 127     }
 128 }
 129
 130
 131 // Class IconChoiceDialog
 132
 133
 134 /**********************************************************************
 135 |
 136 | Ctor / Dtor
 137 |
 138 \**********************************************************************/
 139
 140 VCL_BUILDER_FACTORY_ARGS(SvtIconChoiceCtrl,
 141                          WB_3DLOOK | WB_ICON | WB_BORDER |
 142                          WB_NOCOLUMNHEADER | WB_HIGHLIGHTFRAME |
 143                          WB_NODRAGSELECTION | WB_TABSTOP);
 144
 145 IconChoiceDialog::IconChoiceDialog ( vcl::Window* pParent, const OUString& rID,
 146                                      const OUString& rUIXMLDescription )
 147 :   SfxModalDialog         ( pParent, rID, rUIXMLDescription ),
 148     mnCurrentPageId ( HyperLinkPageType::NONE ),
 149
 150     pSet            ( nullptr ),
 151     pExampleSet     ( nullptr )
 152 {
 153     get(m_pOKBtn, "ok");
 154     get(m_pApplyBtn, "apply");
 155     get(m_pCancelBtn, "cancel");
 156     get(m_pHelpBtn, "help");
 157     get(m_pResetBtn, "reset");
 158     get(m_pIconCtrl, "icon_control");
 159     get(m_pTabContainer, "tab");
 160
 161     SetCtrlStyle();
 162     m_pIconCtrl->SetClickHdl ( LINK ( this, IconChoiceDialog , ChosePageHdl_Impl ) );
 163     m_pIconCtrl->Show();
 164     m_pIconCtrl->SetChoiceWithCursor();
 165     m_pIconCtrl->SetSelectionMode( SelectionMode::Single );
 166
 167     // ItemSet
 168     if ( pSet )
 169     {
 170         pExampleSet = new SfxItemSet( *pSet );
 171         pOutSet.reset(new SfxItemSet( *pSet->GetPool(), pSet->GetRanges() ));
 172     }
 173
 174     // Buttons
 175     m_pOKBtn->SetClickHdl   ( LINK( this, IconChoiceDialog, OkHdl ) );
 176     m_pApplyBtn->SetClickHdl   ( LINK( this, IconChoiceDialog, ApplyHdl ) );
 177     m_pResetBtn->SetClickHdl( LINK( this, IconChoiceDialog, ResetHdl ) );
 178     m_pOKBtn->Show();
 179     m_pApplyBtn->Show();
 180     m_pCancelBtn->Show();
 181     m_pHelpBtn->Show();
 182     m_pResetBtn->Show();
 183 }
 184
 185 IconChoiceDialog ::~IconChoiceDialog ()
 186 {
 187     disposeOnce();
 188 }
 189
 190 void IconChoiceDialog::dispose()
 191 {
 192     // save configuration at INI-Manager
 193     // and remove pages
 194     //SvtViewOptions aTabDlgOpt( EViewType::TabDialog, rId );
 195     //aTabDlgOpt.SetWindowState(OStringToOUString(GetWindowState((WindowStateMask::X | WindowStateMask::Y | WindowStateMask::State | WindowStateMask::Minimized)), RTL_TEXTENCODING_ASCII_US));
 196     //aTabDlgOpt.SetPageID( mnCurrentPageId );
 197
 198     for (std::unique_ptr<IconChoicePageData> & pData : maPageList)
 199     {
 200         if ( pData->pPage )
 201             pData->pPage.disposeAndClear();
 202     }
 203     maPageList.clear();
 204
 205     pRanges.reset();
 206     pOutSet.reset();
 207
 208     m_pIconCtrl.clear();
 209     m_pOKBtn.clear();
 210     m_pApplyBtn.clear();
 211     m_pCancelBtn.clear();
 212     m_pHelpBtn.clear();
 213     m_pResetBtn.clear();
 214     m_pTabContainer.clear();
 215     SfxModalDialog::dispose();
 216 }
 217
 218 /**********************************************************************
 219 |
 220 | add new page
 221 |
 222 \**********************************************************************/
 223
 224 SvxIconChoiceCtrlEntry* IconChoiceDialog::AddTabPage(
 225     HyperLinkPageType nId,
 226     const OUString&   rIconText,
 227     const Image&    rChoiceIcon,
 228     CreatePage      pCreateFunc /* != 0 */
 229 )
 230 {
 231     maPageList.emplace_back( new IconChoicePageData ( nId, pCreateFunc ) );
 232
 233     SvxIconChoiceCtrlEntry* pEntry = m_pIconCtrl->InsertEntry( rIconText, rChoiceIcon );
 234     pEntry->SetUserData ( reinterpret_cast<void*>(nId) );
 235     return pEntry;
 236 }
 237
 238 void IconChoiceDialog::SetCtrlStyle()
 239 {
 240     WinBits const aWinBits = WB_3DLOOK | WB_ICON | WB_BORDER | WB_NOCOLUMNHEADER | WB_HIGHLIGHTFRAME | WB_NODRAGSELECTION | WB_TABSTOP | WB_CLIPCHILDREN | WB_ALIGN_LEFT | WB_NOHSCROLL;
 241     m_pIconCtrl->SetStyle(aWinBits);
 242     m_pIconCtrl->ArrangeIcons();
 243 }
 244
 245 /**********************************************************************
 246 |
 247 | Show / Hide page or button
 248 |
 249 \**********************************************************************/
 250
 251 void IconChoiceDialog::ShowPageImpl ( IconChoicePageData const * pData )
 252 {
 253     if ( pData->pPage )
 254         pData->pPage->Show();
 255 }
 256
 257
 258 void IconChoiceDialog::HidePageImpl ( IconChoicePageData const * pData )
 259 {
 260     if ( pData->pPage )
 261         pData->pPage->Hide();
 262 }
 263
 264 void IconChoiceDialog::ShowPage(HyperLinkPageType nId)
 265 {
 266     HyperLinkPageType nOldPageId = GetCurPageId();
 267     bool bInvalidate = nOldPageId != nId;
 268     if (bInvalidate)
 269     {
 270         IconChoicePageData* pOldData = GetPageData(nOldPageId);
 271         if (pOldData && pOldData->pPage)
 272         {
 273             DeActivatePageImpl();
 274             HidePageImpl(pOldData);
 275         }
 276
 277         Invalidate();
 278     }
 279     SetCurPageId(nId);
 280     ActivatePageImpl();
 281     IconChoicePageData* pNewData = GetPageData(nId);
 282     if (pNewData && pNewData->pPage)
 283         ShowPageImpl(pNewData);
 284 }
 285
 286 /**********************************************************************
 287 |
 288 | select a page
 289 |
 290 \**********************************************************************/
 291 IMPL_LINK_NOARG(IconChoiceDialog , ChosePageHdl_Impl, SvtIconChoiceCtrl*, void)
 292 {
 293     SvxIconChoiceCtrlEntry *pEntry = m_pIconCtrl->GetSelectedEntry();
 294     if ( !pEntry )
 295         pEntry = m_pIconCtrl->GetCursor( );
 296
 297     HyperLinkPageType nId = static_cast<HyperLinkPageType>(reinterpret_cast<sal_uIntPtr>(pEntry->GetUserData()));
 298
 299     if( nId != mnCurrentPageId )
 300     {
 301         ShowPage(nId);
 302     }
 303 }
 304
 305 /**********************************************************************
 306 |
 307 | Button-handler
 308 |
 309 \**********************************************************************/
 310
 311 IMPL_LINK_NOARG(IconChoiceDialog, OkHdl, Button*, void)
 312 {
 313     if ( OK_Impl() )
 314     {
 315         Ok();
 316         Close();
 317     }
 318 }
 319
 320
 321 IMPL_LINK_NOARG(IconChoiceDialog, ApplyHdl, Button*, void)
 322 {
 323     if ( OK_Impl() )
 324     {
 325         Ok();
 326         Close();
 327     }
 328 }
 329
 330 IMPL_LINK_NOARG(IconChoiceDialog, ResetHdl, Button*, void)
 331 {
 332     ResetPageImpl ();
 333
 334     IconChoicePageData* pData = GetPageData ( mnCurrentPageId );
 335     DBG_ASSERT( pData, "ID not known" );
 336
 337     pData->pPage->Reset( *pSet );
 338 }
 339
 340
 341 IMPL_LINK_NOARG(IconChoiceDialog, CancelHdl, Button*, void)
 342 {
 343     Close();
 344 }
 345
 346 /**********************************************************************
 347 |
 348 | call page
 349 |
 350 \**********************************************************************/
 351
 352 void IconChoiceDialog::ActivatePageImpl ()
 353 {
 354     DBG_ASSERT( !maPageList.empty(), "no Pages registered" );
 355     IconChoicePageData* pData = GetPageData ( mnCurrentPageId );
 356     DBG_ASSERT( pData, "ID not known" );
 357     if ( pData )
 358     {
 359         if ( !pData->pPage )
 360         {
 361             pData->pPage = (pData->fnCreatePage)( m_pTabContainer, this, pSet );
 362             pData->pPage->Reset( *pSet );
 363             PageCreated( mnCurrentPageId, *pData->pPage );
 364         }
 365         else if ( pData->bRefresh )
 366         {
 367             pData->pPage->Reset( *pSet );
 368         }
 369
 370         pData->bRefresh = false;
 371
 372         if ( pExampleSet )
 373             pData->pPage->ActivatePage( *pExampleSet );
 374         SetHelpId( pData->pPage->GetHelpId() );
 375     }
 376
 377     m_pResetBtn->Show();
 378 }
 379
 380
 381 void IconChoiceDialog::DeActivatePageImpl ()
 382 {
 383     IconChoicePageData *pData = GetPageData ( mnCurrentPageId );
 384
 385     DeactivateRC nRet = DeactivateRC::LeavePage;
 386
 387     if ( pData )
 388     {
 389         IconChoicePage * pPage = pData->pPage;
 390
 391         if ( !pExampleSet && pPage->HasExchangeSupport() && pSet )
 392             pExampleSet = new SfxItemSet( *pSet->GetPool(), pSet->GetRanges() );
 393
 394         if ( pSet )
 395         {
 396             SfxItemSet aTmp( *pSet->GetPool(), pSet->GetRanges() );
 397
 398             if ( pPage->HasExchangeSupport() )
 399                 nRet = pPage->DeactivatePage( &aTmp );
 400
 401             if ( ( DeactivateRC::LeavePage & nRet ) &&
 402                  aTmp.Count() )
 403             {
 404                 if (pExampleSet)
 405                     pExampleSet->Put(aTmp);
 406                 pOutSet->Put( aTmp );
 407             }
 408         }
 409         else
 410         {
 411             if ( pPage->HasExchangeSupport() ) //!!!
 412             {
 413                 if ( !pExampleSet )
 414                 {
 415                     SfxItemPool* pPool = pPage->GetItemSet().GetPool();
 416                     pExampleSet =
 417                         new SfxItemSet( *pPool, GetInputRanges( *pPool ) );
 418                 }
 419                 nRet = pPage->DeactivatePage( pExampleSet );
 420             }
 421             else
 422                 nRet = pPage->DeactivatePage( nullptr );
 423         }
 424
 425         if ( nRet & DeactivateRC::RefreshSet )
 426         {
 427             // TODO refresh input set
 428             // flag all pages to be newly initialized
 429             for (auto & pObj : maPageList)
 430             {
 431                 if ( pObj->pPage.get() != pPage )
 432                     pObj->bRefresh = true;
 433                 else
 434                     pObj->bRefresh = false;
 435             }
 436         }
 437     }
 438 }
 439
 440
 441 void IconChoiceDialog::ResetPageImpl ()
 442 {
 443     IconChoicePageData *pData = GetPageData ( mnCurrentPageId );
 444
 445     DBG_ASSERT( pData, "ID not known" );
 446
 447     pData->pPage->Reset( *pSet );
 448 }
 449
 450 /**********************************************************************
 451 |
 452 | handling itemsets
 453 |
 454 \**********************************************************************/
 455
 456 const sal_uInt16* IconChoiceDialog::GetInputRanges( const SfxItemPool& )
 457 {
 458     if ( pSet )
 459     {
 460         SAL_WARN( "cui.dialogs", "Set does already exist!" );
 461         return pSet->GetRanges();
 462     }
 463
 464     if ( pRanges )
 465         return pRanges.get();
 466
 467     pRanges.reset(new sal_uInt16[1]);
 468     pRanges[0] = 0;
 469
 470     return pRanges.get();
 471 }
 472
 473
 474 void IconChoiceDialog::SetInputSet( const SfxItemSet* pInSet )
 475 {
 476     bool bSet = ( pSet != nullptr );
 477
 478     pSet = pInSet;
 479
 480     if ( !bSet && !pExampleSet && !pOutSet )
 481     {
 482         pExampleSet = new SfxItemSet( *pSet );
 483         pOutSet.reset(new SfxItemSet( *pSet->GetPool(), pSet->GetRanges() ));
 484     }
 485 }
 486
 487
 488 void IconChoiceDialog::PageCreated( HyperLinkPageType /*nId*/, IconChoicePage& /*rPage*/ )
 489 {
 490     // not interested in
 491 }
 492
 493
 494 /**********************************************************************
 495 |
 496 | start dialog
 497 |
 498 \**********************************************************************/
 499
 500 short IconChoiceDialog::Execute()
 501 {
 502     if ( maPageList.empty() )
 503         return RET_CANCEL;
 504
 505     Start_Impl();
 506
 507     return Dialog::Execute();
 508 }
 509
 510
 511 void IconChoiceDialog::Start()
 512 {
 513     m_pCancelBtn->SetClickHdl( LINK( this, IconChoiceDialog, CancelHdl ) );
 514
 515     Start_Impl();
 516 }
 517
 518
 519 bool IconChoiceDialog::QueryClose()
 520 {
 521     bool bRet = true;
 522     for (auto & pData : maPageList)
 523     {
 524         if ( pData->pPage && !pData->pPage->QueryClose() )
 525         {
 526             bRet = false;
 527             break;
 528         }
 529     }
 530     return bRet;
 531 }
 532
 533 void IconChoiceDialog::Start_Impl()
 534 {
 535     FocusOnIcon( mnCurrentPageId );
 536     ActivatePageImpl();
 537 }
 538
 539 /**********************************************************************
 540 |
 541 | tool-methods
 542 |
 543 \**********************************************************************/
 544
 545 IconChoicePageData* IconChoiceDialog::GetPageData ( HyperLinkPageType nId )
 546 {
 547     IconChoicePageData *pRet = nullptr;
 548     for (auto & pData : maPageList)
 549     {
 550         if ( pData->nId == nId )
 551         {
 552             pRet = pData.get();
 553             break;
 554         }
 555     }
 556     return pRet;
 557 }
 558
 559 /**********************************************************************
 560 |
 561 | OK-Status
 562 |
 563 \**********************************************************************/
 564
 565 bool IconChoiceDialog::OK_Impl()
 566 {
 567     IconChoicePage* pPage = GetPageData ( mnCurrentPageId )->pPage;
 568
 569     bool bEnd = !pPage;
 570     if ( pPage )
 571     {
 572         DeactivateRC nRet = DeactivateRC::LeavePage;
 573         if ( pSet )
 574         {
 575             SfxItemSet aTmp( *pSet->GetPool(), pSet->GetRanges() );
 576
 577             if ( pPage->HasExchangeSupport() )
 578                 nRet = pPage->DeactivatePage( &aTmp );
 579
 580             if ( ( DeactivateRC::LeavePage & nRet )
 581                  && aTmp.Count() )
 582             {
 583                 pExampleSet->Put( aTmp );
 584                 pOutSet->Put( aTmp );
 585             }
 586         }
 587         else
 588             nRet = pPage->DeactivatePage( nullptr );
 589         bEnd = nRet != DeactivateRC::KeepPage;
 590     }
 591
 592     return bEnd;
 593 }
 594
 595
 596 void IconChoiceDialog::Ok()
 597 {
 598     if ( !pOutSet )
 599     {
 600         if ( !pExampleSet && pSet )
 601             pOutSet = pSet->Clone( false ); // without items
 602         else if ( pExampleSet )
 603             pOutSet.reset(new SfxItemSet( *pExampleSet ));
 604     }
 605
 606     for ( size_t i = 0, nCount = maPageList.size(); i < nCount; ++i )
 607     {
 608         IconChoicePageData* pData = GetPageData ( maPageList[i]->nId );
 609
 610         IconChoicePage* pPage = pData->pPage;
 611
 612         if ( pPage )
 613         {
 614             if ( pSet && !pPage->HasExchangeSupport() )
 615             {
 616                 SfxItemSet aTmp( *pSet->GetPool(), pSet->GetRanges() );
 617
 618                 if ( pPage->FillItemSet( &aTmp ) )
 619                 {
 620                     if (pExampleSet)
 621                         pExampleSet->Put(aTmp);
 622                     pOutSet->Put( aTmp );
 623                 }
 624             }
 625         }
 626     }
 627 }
 628
 629 void IconChoiceDialog::FocusOnIcon( HyperLinkPageType nId )
 630 {
 631     // set focus to icon for the current visible page
 632     for ( sal_Int32 i=0; i<m_pIconCtrl->GetEntryCount(); i++)
 633     {
 634         SvxIconChoiceCtrlEntry* pEntry = m_pIconCtrl->GetEntry ( i );
 635         HyperLinkPageType nUserData = static_cast<HyperLinkPageType>(reinterpret_cast<sal_uIntPtr>(pEntry->GetUserData()));
 636
 637         if ( nUserData == nId )
 638         {
 639             m_pIconCtrl->SetCursor( pEntry );
 640             break;
 641         }
 642     }
 643 }
 644
 645
 646 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */