cui/source/customize/SvxToolbarConfigPage.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 <sal/config.h>
  21 #include <sal/log.hxx>
  22
  23 #include <vcl/commandinfoprovider.hxx>
  24 #include <vcl/event.hxx>
  25 #include <vcl/weld.hxx>
  26 #include <vcl/svapp.hxx>
  27
  28 #include <sfx2/sfxsids.hrc>
  29 #include <svl/stritem.hxx>
  30 #include <tools/diagnose_ex.h>
  31
  32 #include <algorithm>
  33 #include <helpids.h>
  34 #include <strings.hrc>
  35
  36 #include <cfg.hxx>
  37 #include <SvxToolbarConfigPage.hxx>
  38 #include <SvxConfigPageHelper.hxx>
  39 #include <dialmgr.hxx>
  40
  41 #include <comphelper/processfactory.hxx>
  42 #include <com/sun/star/ui/ImageType.hpp>
  43
  44 #include <dlgname.hxx>
  45
  46 SvxToolbarConfigPage::SvxToolbarConfigPage(weld::Container* pPage, weld::DialogController* pController, const SfxItemSet& rSet)
  47     : SvxConfigPage(pPage, pController, rSet)
  48 {
  49     m_xGearBtn = m_xBuilder->weld_menu_button("toolbargearbtn");
  50     m_xGearBtn->show();
  51     m_xContainer->set_help_id(HID_SVX_CONFIG_TOOLBAR);
  52
  53     m_xContentsListBox.reset(new SvxToolbarEntriesListBox(m_xBuilder->weld_tree_view("toolcontents"), this));
  54     m_xDropTargetHelper.reset(new SvxConfigPageFunctionDropTarget(*this, m_xContentsListBox->get_widget()));
  55
  56     std::vector<int> aWidths;
  57     weld::TreeView& rTreeView = m_xContentsListBox->get_widget();
  58     Size aSize(m_xFunctions->get_size_request());
  59     rTreeView.set_size_request(aSize.Width(), aSize.Height());
  60
  61     int nExpectedSize = 16;
  62
  63     int nStandardImageColWidth = rTreeView.get_checkbox_column_width();
  64     int nMargin = nStandardImageColWidth - nExpectedSize;
  65     if (nMargin < 16)
  66         nMargin = 16;
  67
  68     if (SvxConfigPageHelper::GetImageType() & css::ui::ImageType::SIZE_LARGE)
  69         nExpectedSize = 24;
  70     else if (SvxConfigPageHelper::GetImageType() & css::ui::ImageType::SIZE_32)
  71         nExpectedSize = 32;
  72
  73     int nImageColWidth = nExpectedSize + nMargin;
  74
  75     aWidths.push_back(nStandardImageColWidth);
  76     aWidths.push_back(nImageColWidth);
  77     rTreeView.set_column_fixed_widths(aWidths);
  78
  79     rTreeView.set_hexpand(true);
  80     rTreeView.set_vexpand(true);
  81     rTreeView.set_help_id( HID_SVX_CONFIG_TOOLBAR_CONTENTS );
  82     rTreeView.show();
  83
  84     rTreeView.connect_changed(
  85         LINK( this, SvxToolbarConfigPage, SelectToolbarEntry ) );
  86
  87     m_xTopLevelListBox->set_help_id ( HID_SVX_TOPLEVELLISTBOX );
  88     m_xSaveInListBox->set_help_id( HID_SVX_SAVE_IN );
  89     m_xMoveUpButton->set_help_id( HID_SVX_UP_TOOLBAR_ITEM );
  90     m_xMoveDownButton->set_help_id( HID_SVX_DOWN_TOOLBAR_ITEM );
  91     m_xDescriptionField->set_help_id ( HID_SVX_DESCFIELD );
  92
  93     m_xCommandCategoryListBox->connect_changed(
  94         LINK( this, SvxToolbarConfigPage, SelectCategory ) );
  95
  96     m_xGearBtn->connect_selected(
  97         LINK( this, SvxToolbarConfigPage, GearHdl ) );
  98
  99     m_xMoveUpButton->connect_clicked( LINK( this, SvxToolbarConfigPage, MoveHdl) );
 100     m_xMoveDownButton->connect_clicked( LINK( this, SvxToolbarConfigPage, MoveHdl) );
 101     // Always enable Up and Down buttons
 102     // added for issue i53677 by shizhoubo
 103     m_xMoveDownButton->set_sensitive(true);
 104     m_xMoveUpButton->set_sensitive(true);
 105
 106     m_xAddCommandButton->connect_clicked( LINK( this, SvxToolbarConfigPage, AddCommandHdl ) );
 107     m_xRemoveCommandButton->connect_clicked( LINK( this, SvxToolbarConfigPage, RemoveCommandHdl ) );
 108
 109     m_xInsertBtn->connect_selected(
 110         LINK( this, SvxToolbarConfigPage, InsertHdl ) );
 111     m_xModifyBtn->connect_selected(
 112         LINK( this, SvxToolbarConfigPage, ModifyItemHdl ) );
 113     m_xResetBtn->connect_clicked(
 114         LINK( this, SvxToolbarConfigPage, ResetToolbarHdl ) );
 115
 116     // "Insert Submenu" is irrelevant to the toolbars
 117     m_xInsertBtn->remove_item("insertsubmenu");
 118
 119     // Gear menu's "Move" action is irrelevant to the toolbars
 120     m_xGearBtn->set_item_sensitive("toolbar_gear_move", false);
 121
 122     // default toolbar to select is standardbar unless a different one
 123     // has been passed in
 124     m_aURLToSelect = ITEM_TOOLBAR_URL;
 125     m_aURLToSelect += "standardbar";
 126
 127     const SfxPoolItem* pItem =
 128         rSet.GetItem( rSet.GetPool()->GetWhich( SID_CONFIG ) );
 129
 130     if ( pItem )
 131     {
 132         OUString text = static_cast<const SfxStringItem*>(pItem)->GetValue();
 133         if (text.startsWith( ITEM_TOOLBAR_URL ))
 134         {
 135             m_aURLToSelect = text.copy( 0 );
 136         }
 137     }
 138 }
 139
 140 void SvxToolbarConfigPage::ListModified()
 141 {
 142     // regenerate with the current ordering within the list
 143     SvxEntries* pEntries = GetTopLevelSelection()->GetEntries();
 144     pEntries->clear();
 145
 146     for (int i = 0; i < m_xContentsListBox->n_children(); ++i)
 147         pEntries->push_back(reinterpret_cast<SvxConfigEntry*>(m_xContentsListBox->get_id(i).toInt64()));
 148
 149     GetSaveInData()->SetModified();
 150     GetTopLevelSelection()->SetModified();
 151
 152     SvxConfigEntry* pToolbar = GetTopLevelSelection();
 153     if ( pToolbar )
 154         static_cast<ToolbarSaveInData*>(GetSaveInData())->ApplyToolbar( pToolbar );
 155 }
 156
 157 SvxToolbarConfigPage::~SvxToolbarConfigPage()
 158 {
 159     for (int i = 0, nCount = m_xSaveInListBox->get_count(); i < nCount; ++i)
 160     {
 161         ToolbarSaveInData* pData =
 162             reinterpret_cast<ToolbarSaveInData*>(m_xSaveInListBox->get_id(i).toInt64());
 163         delete pData;
 164     }
 165     m_xSaveInListBox->clear();
 166 }
 167
 168 void SvxToolbarConfigPage::DeleteSelectedTopLevel()
 169 {
 170     const sal_Int32 nSelectionPos = m_xTopLevelListBox->get_active();
 171     ToolbarSaveInData* pSaveInData = static_cast<ToolbarSaveInData*>( GetSaveInData() );
 172     pSaveInData->RemoveToolbar( GetTopLevelSelection() );
 173
 174     int nCount = m_xTopLevelListBox->get_count();
 175     if (nCount > 1)
 176     {
 177         // select next entry after the one being deleted
 178         // selection position is indexed from 0 so need to
 179         // subtract one from the entry count
 180         if (nSelectionPos != nCount - 1)
 181         {
 182             m_xTopLevelListBox->set_active(nSelectionPos + 1);
 183         }
 184         else
 185         {
 186             m_xTopLevelListBox->set_active(nSelectionPos - 1);
 187         }
 188         SelectElement();
 189
 190         // and now remove the entry
 191         m_xTopLevelListBox->remove(nSelectionPos);
 192     }
 193     else
 194     {
 195         ReloadTopLevelListBox();
 196     }
 197 }
 198
 199 void SvxToolbarConfigPage::DeleteSelectedContent()
 200 {
 201     int nActEntry = m_xContentsListBox->get_selected_index();
 202
 203     if (nActEntry != -1)
 204     {
 205         // get currently selected entry
 206         SvxConfigEntry* pEntry =
 207             reinterpret_cast<SvxConfigEntry*>(m_xContentsListBox->get_id(nActEntry).toInt64());
 208
 209         SvxConfigEntry* pToolbar = GetTopLevelSelection();
 210
 211         // remove entry from the list for this toolbar
 212         SvxConfigPageHelper::RemoveEntry( pToolbar->GetEntries(), pEntry );
 213
 214         // remove toolbar entry from UI
 215         m_xContentsListBox->remove(nActEntry);
 216
 217         // delete data for toolbar entry
 218         delete pEntry;
 219
 220         static_cast<ToolbarSaveInData*>(GetSaveInData())->ApplyToolbar( pToolbar );
 221         UpdateButtonStates();
 222
 223         // if this is the last entry in the toolbar and it is a user
 224         // defined toolbar pop up a dialog asking the user if they
 225         // want to delete the toolbar
 226         if ( m_xContentsListBox->n_children() == 0 &&
 227              GetTopLevelSelection()->IsDeletable() )
 228         {
 229             std::unique_ptr<weld::MessageDialog> xQueryBox(Application::CreateMessageDialog(GetFrameWeld(),
 230                                                            VclMessageType::Question, VclButtonsType::YesNo,
 231                                                            CuiResId(RID_SXVSTR_CONFIRM_DELETE_TOOLBAR)));
 232             if (xQueryBox->run() == RET_YES)
 233             {
 234                 DeleteSelectedTopLevel();
 235             }
 236         }
 237     }
 238 }
 239
 240 IMPL_LINK( SvxToolbarConfigPage, MoveHdl, weld::Button&, rButton, void )
 241 {
 242     MoveEntry(&rButton == m_xMoveUpButton.get());
 243 }
 244
 245 void SvxToolbarConfigPage::MoveEntry( bool bMoveUp )
 246 {
 247     SvxConfigPage::MoveEntry( bMoveUp );
 248
 249     // Apply change to currently selected toolbar
 250     SvxConfigEntry* pToolbar = GetTopLevelSelection();
 251     if ( pToolbar )
 252         static_cast<ToolbarSaveInData*>(GetSaveInData())->ApplyToolbar( pToolbar );
 253     else
 254     {
 255         SAL_WARN( "cui.customize", "SvxToolbarConfigPage::MoveEntry(): no entry" );
 256         UpdateButtonStates();
 257     }
 258 }
 259
 260 void SvxToolbarConfigPage::Init()
 261 {
 262     // ensure that the UI is cleared before populating it
 263     m_xTopLevelListBox->clear();
 264     m_xContentsListBox->clear();
 265
 266     ReloadTopLevelListBox();
 267
 268     sal_Int32 nPos = 0;
 269     if ( !m_aURLToSelect.isEmpty() )
 270     {
 271         for (sal_Int32 i = 0, nCount = m_xTopLevelListBox->get_count(); i < nCount; ++i)
 272         {
 273             SvxConfigEntry* pData =
 274                 reinterpret_cast<SvxConfigEntry*>(m_xTopLevelListBox->get_id(i).toInt64());
 275
 276             if ( pData->GetCommand().equals( m_aURLToSelect ) )
 277             {
 278                 nPos = i;
 279                 break;
 280             }
 281         }
 282
 283         // in future select the default toolbar: Standard
 284         m_aURLToSelect = ITEM_TOOLBAR_URL;
 285         m_aURLToSelect += "standardbar";
 286     }
 287
 288     m_xTopLevelListBox->set_active(nPos);
 289     SelectElement();
 290
 291     m_xCommandCategoryListBox->Init(
 292         comphelper::getProcessComponentContext(),
 293         m_xFrame, m_aModuleId);
 294     m_xCommandCategoryListBox->categorySelected(m_xFunctions.get(), OUString(), GetSaveInData());
 295 }
 296
 297 SaveInData* SvxToolbarConfigPage::CreateSaveInData(
 298     const css::uno::Reference< css::ui::XUIConfigurationManager >& xCfgMgr,
 299     const css::uno::Reference< css::ui::XUIConfigurationManager >& xParentCfgMgr,
 300     const OUString& aModuleId,
 301     bool bDocConfig )
 302 {
 303     return static_cast< SaveInData* >(
 304         new ToolbarSaveInData( xCfgMgr, xParentCfgMgr, aModuleId, bDocConfig ));
 305 }
 306
 307 IMPL_LINK_NOARG(SvxToolbarConfigPage, SelectToolbarEntry, weld::TreeView&, void)
 308 {
 309     UpdateButtonStates();
 310 }
 311
 312 IMPL_LINK( SvxToolbarConfigPage, GearHdl, const OString&, rIdent, void )
 313 {
 314     SvxConfigEntry* pCurrentToolbar = GetTopLevelSelection();
 315
 316     if (rIdent == "toolbar_gear_add")
 317     {
 318         OUString prefix = CuiResId( RID_SVXSTR_NEW_TOOLBAR );
 319
 320         OUString aNewName =
 321             SvxConfigPageHelper::generateCustomName( prefix, GetSaveInData()->GetEntries() );
 322
 323         OUString aNewURL =
 324             SvxConfigPageHelper::generateCustomURL( GetSaveInData()->GetEntries() );
 325
 326         SvxNewToolbarDialog aNameDialog(GetFrameWeld(), aNewName);
 327
 328         // Reflect the actual m_xSaveInListBox into the new toolbar dialog
 329         for (int i = 0, nCount = m_xSaveInListBox->get_count(); i < nCount; ++i)
 330             aNameDialog.m_xSaveInListBox->append_text(m_xSaveInListBox->get_text(i));
 331
 332         aNameDialog.m_xSaveInListBox->set_active(m_xSaveInListBox->get_active());
 333
 334         if (aNameDialog.run() == RET_OK)
 335         {
 336             aNewName = aNameDialog.GetName();
 337
 338             // Where to save the new toolbar? (i.e. Modulewise or documentwise)
 339             int nInsertPos = aNameDialog.m_xSaveInListBox->get_active();
 340
 341             ToolbarSaveInData* pData =
 342                 reinterpret_cast<ToolbarSaveInData*>(
 343                     m_xSaveInListBox->get_id(nInsertPos).toInt64() );
 344
 345             if ( GetSaveInData() != pData )
 346             {
 347                 m_xSaveInListBox->set_active(nInsertPos);
 348                 SelectSaveInLocation(*m_xSaveInListBox);
 349             }
 350
 351             SvxConfigEntry* pToolbar =
 352                 new SvxConfigEntry( aNewName, aNewURL, true, false );
 353
 354             pToolbar->SetUserDefined();
 355             pToolbar->SetMain();
 356
 357             pData->CreateToolbar( pToolbar );
 358
 359             OUString sId(OUString::number(reinterpret_cast<sal_Int64>(pToolbar)));
 360             m_xTopLevelListBox->append(sId, pToolbar->GetName());
 361             m_xTopLevelListBox->set_active_id(sId);
 362             SelectElement();
 363
 364             pData->SetModified();
 365         }
 366     }
 367     else if (rIdent == "toolbar_gear_delete")
 368     {
 369         if ( pCurrentToolbar && pCurrentToolbar->IsDeletable() )
 370         {
 371             DeleteSelectedTopLevel();
 372             UpdateButtonStates();
 373         }
 374     }
 375     else if (rIdent == "toolbar_gear_rename")
 376     {
 377         sal_Int32 nSelectionPos = m_xTopLevelListBox->get_active();
 378         SvxConfigEntry* pToolbar =
 379             reinterpret_cast<SvxConfigEntry*>(m_xTopLevelListBox->get_id(nSelectionPos).toInt64());
 380         ToolbarSaveInData* pSaveInData = static_cast<ToolbarSaveInData*>( GetSaveInData() );
 381
 382         //Rename the toolbar
 383         OUString sCurrentName( SvxConfigPageHelper::stripHotKey( pToolbar->GetName() ) );
 384         OUString sDesc = CuiResId( RID_SVXSTR_LABEL_NEW_NAME );
 385
 386         SvxNameDialog aNameDialog(GetFrameWeld(), sCurrentName, sDesc);
 387         aNameDialog.set_help_id(HID_SVX_CONFIG_RENAME_TOOLBAR);
 388         aNameDialog.set_title(CuiResId(RID_SVXSTR_RENAME_TOOLBAR));
 389
 390         if ( aNameDialog.run() == RET_OK )
 391         {
 392             OUString sNewName = aNameDialog.GetName();
 393
 394             if (sCurrentName == sNewName)
 395                 return;
 396
 397             pToolbar->SetName( sNewName );
 398             pSaveInData->ApplyToolbar( pToolbar );
 399
 400             // have to use remove and insert to change the name
 401             m_xTopLevelListBox->remove(nSelectionPos);
 402             OUString sId(OUString::number(reinterpret_cast<sal_Int64>(pToolbar)));
 403             m_xTopLevelListBox->insert(nSelectionPos, sNewName, &sId, nullptr, nullptr);
 404             m_xTopLevelListBox->set_active_id(sId);
 405         }
 406     }
 407     else if (rIdent == "toolbar_gear_iconOnly" || rIdent == "toolbar_gear_textOnly" || rIdent == "toolbar_gear_iconAndText")
 408     {
 409         ToolbarSaveInData* pSaveInData = static_cast<ToolbarSaveInData*>( GetSaveInData() );
 410
 411         if (pCurrentToolbar == nullptr || pSaveInData == nullptr)
 412         {
 413             SAL_WARN("cui.customize", "NULL toolbar or savein data");
 414             return;
 415         }
 416
 417         sal_Int32 nStyle = 0;
 418         if (rIdent == "toolbar_gear_iconOnly")
 419             nStyle = 0;
 420         else if (rIdent == "toolbar_gear_textOnly")
 421             nStyle = 1;
 422         else if (rIdent == "toolbar_gear_iconAndText")
 423             nStyle = 2;
 424
 425         pCurrentToolbar->SetStyle( nStyle );
 426         pSaveInData->SetSystemStyle( m_xFrame, pCurrentToolbar->GetCommand(), nStyle );
 427
 428         SelectElement();
 429     }
 430     else
 431     {
 432         //This block should never be reached
 433         SAL_WARN("cui.customize", "Unknown gear menu option: " << rIdent);
 434         return;
 435     }
 436 }
 437
 438 IMPL_LINK_NOARG( SvxToolbarConfigPage, SelectCategory, weld::ComboBox&, void )
 439 {
 440     OUString aSearchTerm(m_xSearchEdit->get_text());
 441
 442     m_xCommandCategoryListBox->categorySelected(m_xFunctions.get(), aSearchTerm, GetSaveInData());
 443 }
 444
 445 IMPL_LINK_NOARG( SvxToolbarConfigPage, AddCommandHdl, weld::Button&, void )
 446 {
 447     AddFunction();
 448 }
 449
 450 IMPL_LINK_NOARG( SvxToolbarConfigPage, RemoveCommandHdl, weld::Button&, void )
 451 {
 452     DeleteSelectedContent();
 453 }
 454
 455 IMPL_LINK(SvxToolbarConfigPage, InsertHdl, const OString&, rIdent, void)
 456 {
 457     if (rIdent == "insertseparator")
 458     {
 459         // Get the currently selected toolbar
 460         SvxConfigEntry* pToolbar = GetTopLevelSelection();
 461
 462         SvxConfigEntry* pNewEntryData = new SvxConfigEntry;
 463         pNewEntryData->SetUserDefined();
 464
 465         int nPos = AppendEntry(pNewEntryData, -1);
 466         InsertEntryIntoUI(pNewEntryData, m_xContentsListBox->get_widget(), nPos, 1);
 467
 468         static_cast<ToolbarSaveInData*>( GetSaveInData())->ApplyToolbar( pToolbar );
 469
 470         UpdateButtonStates();
 471     }
 472     else
 473     {
 474         //This block should never be reached
 475         SAL_WARN("cui.customize", "Unknown insert option: " << rIdent);
 476         return;
 477     }
 478 }
 479
 480 IMPL_LINK(SvxToolbarConfigPage, ModifyItemHdl, const OString&, rIdent, void)
 481 {
 482     bool bNeedsApply = false;
 483
 484     // get currently selected toolbar
 485     SvxConfigEntry* pToolbar = GetTopLevelSelection();
 486
 487     if (rIdent.isEmpty() || pToolbar == nullptr)
 488     {
 489         SAL_WARN("cui.customize", "No toolbar selected, or empty rIdent!");
 490         return;
 491     }
 492
 493     if (rIdent == "renameItem")
 494     {
 495         int nActEntry = m_xContentsListBox->get_selected_index();
 496         SvxConfigEntry* pEntry =
 497             reinterpret_cast<SvxConfigEntry*>(m_xContentsListBox->get_id(nActEntry).toInt64());
 498
 499         OUString aNewName( SvxConfigPageHelper::stripHotKey( pEntry->GetName() ) );
 500         OUString aDesc = CuiResId( RID_SVXSTR_LABEL_NEW_NAME );
 501
 502         SvxNameDialog aNameDialog(GetFrameWeld(), aNewName, aDesc);
 503         aNameDialog.set_help_id(HID_SVX_CONFIG_RENAME_TOOLBAR_ITEM);
 504         aNameDialog.set_title(CuiResId(RID_SVXSTR_RENAME_TOOLBAR));
 505
 506         if (aNameDialog.run() == RET_OK)
 507         {
 508             aNewName = aNameDialog.GetName();
 509
 510             if( aNewName.isEmpty() )    // tdf#80758 - Accelerator character ("~") is passed as
 511                 pEntry->SetName( "~" ); // the button name in case of empty values.
 512             else
 513                 pEntry->SetName( aNewName );
 514
 515             m_xContentsListBox->set_text(nActEntry, aNewName, 2);
 516             bNeedsApply = true;
 517         }
 518     }
 519     else if (rIdent == "changeIcon")
 520     {
 521         int nActEntry = m_xContentsListBox->get_selected_index();
 522         SvxConfigEntry* pEntry =
 523             reinterpret_cast<SvxConfigEntry*>(m_xContentsListBox->get_id(nActEntry).toInt64());
 524
 525         SvxIconSelectorDialog aIconDialog(GetFrameWeld(),
 526                 GetSaveInData()->GetImageManager(),
 527                 GetSaveInData()->GetParentImageManager());
 528
 529         if (aIconDialog.run() == RET_OK)
 530         {
 531             css::uno::Reference< css::graphic::XGraphic > newgraphic =
 532                 aIconDialog.GetSelectedIcon();
 533
 534             if ( newgraphic.is() )
 535             {
 536                 css::uno::Sequence< css::uno::Reference< css::graphic::XGraphic > >
 537                     aGraphicSeq( 1 );
 538
 539                 css::uno::Sequence<OUString> aURLSeq { pEntry->GetCommand() };
 540
 541                 if ( !pEntry->GetBackupGraphic().is() )
 542                 {
 543                     css::uno::Reference< css::graphic::XGraphic > backup =
 544                         SvxConfigPageHelper::GetGraphic(GetSaveInData()->GetImageManager(),
 545                                                         aURLSeq[0]);
 546
 547                     if ( backup.is() )
 548                     {
 549                         pEntry->SetBackupGraphic(backup);
 550                     }
 551                 }
 552
 553                 aGraphicSeq[ 0 ] = newgraphic;
 554                 try
 555                 {
 556                     GetSaveInData()->GetImageManager()->replaceImages(
 557                         SvxConfigPageHelper::GetImageType(), aURLSeq, aGraphicSeq );
 558
 559                     m_xContentsListBox->remove(nActEntry);
 560
 561                     OUString sId(OUString::number(reinterpret_cast<sal_Int64>(pEntry)));
 562                     m_xContentsListBox->insert(nActEntry, sId);
 563                     m_xContentsListBox->set_toggle(nActEntry, pEntry->IsVisible() ? TRISTATE_TRUE : TRISTATE_FALSE, 0);
 564                     InsertEntryIntoUI(pEntry, m_xContentsListBox->get_widget(), nActEntry, 1);
 565
 566                     m_xContentsListBox->select(nActEntry);
 567                     m_xContentsListBox->scroll_to_row(nActEntry);
 568
 569                     GetSaveInData()->PersistChanges(
 570                         GetSaveInData()->GetImageManager() );
 571                 }
 572                 catch ( const css::uno::Exception&)
 573                 {
 574                     TOOLS_WARN_EXCEPTION("cui.customize", "Error replacing image");
 575                 }
 576             }
 577         }
 578     }
 579     else if (rIdent == "resetIcon")
 580     {
 581         int nActEntry = m_xContentsListBox->get_selected_index();
 582         SvxConfigEntry* pEntry =
 583             reinterpret_cast<SvxConfigEntry*>(m_xContentsListBox->get_id(nActEntry).toInt64());
 584
 585         css::uno::Reference< css::graphic::XGraphic > backup =
 586             pEntry->GetBackupGraphic();
 587
 588         css::uno::Sequence< css::uno::Reference< css::graphic::XGraphic > >
 589             aGraphicSeq( 1 );
 590         aGraphicSeq[ 0 ] = backup;
 591
 592         css::uno::Sequence<OUString> aURLSeq { pEntry->GetCommand() };
 593
 594         try
 595         {
 596             GetSaveInData()->GetImageManager()->replaceImages(
 597                 SvxConfigPageHelper::GetImageType(), aURLSeq, aGraphicSeq );
 598
 599             m_xContentsListBox->remove(nActEntry);
 600
 601             OUString sId(OUString::number(reinterpret_cast<sal_Int64>(pEntry)));
 602             m_xContentsListBox->insert(nActEntry, sId);
 603             m_xContentsListBox->set_toggle(nActEntry, pEntry->IsVisible() ? TRISTATE_TRUE : TRISTATE_FALSE, 0);
 604             InsertEntryIntoUI(pEntry, m_xContentsListBox->get_widget(), nActEntry, 1);
 605
 606             m_xContentsListBox->select(nActEntry);
 607             m_xContentsListBox->scroll_to_row(nActEntry);
 608
 609             // reset backup in entry
 610             pEntry->SetBackupGraphic(
 611                 css::uno::Reference< css::graphic::XGraphic >() );
 612
 613             GetSaveInData()->PersistChanges(
 614                 GetSaveInData()->GetImageManager() );
 615         }
 616         catch ( const css::uno::Exception& )
 617         {
 618             TOOLS_WARN_EXCEPTION("cui.customize", "Error resetting image");
 619         }
 620     }
 621     else if (rIdent == "restoreItem")
 622     {
 623         int nActEntry = m_xContentsListBox->get_selected_index();
 624         SvxConfigEntry* pEntry =
 625             reinterpret_cast<SvxConfigEntry*>(m_xContentsListBox->get_id(nActEntry).toInt64());
 626
 627         ToolbarSaveInData* pSaveInData =
 628             static_cast<ToolbarSaveInData*>( GetSaveInData() );
 629
 630         OUString aSystemName =
 631             pSaveInData->GetSystemUIName( pEntry->GetCommand() );
 632
 633         if ( !pEntry->GetName().equals( aSystemName ) )
 634         {
 635             pEntry->SetName( aSystemName );
 636             m_xContentsListBox->set_text(
 637                 nActEntry, SvxConfigPageHelper::stripHotKey(aSystemName), 2);
 638             bNeedsApply = true;
 639         }
 640
 641         css::uno::Sequence<OUString> aURLSeq { pEntry->GetCommand() };
 642
 643         try
 644         {
 645             GetSaveInData()->GetImageManager()->removeImages(
 646                 SvxConfigPageHelper::GetImageType(), aURLSeq );
 647
 648             // reset backup in entry
 649             pEntry->SetBackupGraphic(
 650                 css::uno::Reference< css::graphic::XGraphic >() );
 651
 652             GetSaveInData()->PersistChanges(
 653                 GetSaveInData()->GetImageManager() );
 654
 655             m_xContentsListBox->remove(nActEntry);
 656
 657             OUString sId(OUString::number(reinterpret_cast<sal_Int64>(pEntry)));
 658             m_xContentsListBox->insert(nActEntry, sId);
 659             m_xContentsListBox->set_toggle(nActEntry,
 660                 pEntry->IsVisible() ? TRISTATE_TRUE : TRISTATE_FALSE, 0);
 661             InsertEntryIntoUI(pEntry, m_xContentsListBox->get_widget(), nActEntry, 1);
 662
 663             m_xContentsListBox->select(nActEntry);
 664             m_xContentsListBox->scroll_to_row(nActEntry);
 665
 666             bNeedsApply = true;
 667         }
 668         catch ( const css::uno::Exception& )
 669         {
 670             TOOLS_WARN_EXCEPTION("cui.customize", "Error restoring image");
 671         }
 672     }
 673     else
 674     {
 675         //This block should never be reached
 676         SAL_WARN("cui.customize", "Unknown insert option: " << rIdent);
 677         return;
 678     }
 679
 680     if ( bNeedsApply )
 681     {
 682         static_cast<ToolbarSaveInData*>( GetSaveInData())->ApplyToolbar( pToolbar );
 683         UpdateButtonStates();
 684     }
 685 }
 686
 687 IMPL_LINK_NOARG(SvxToolbarConfigPage, ResetToolbarHdl, weld::Button&, void)
 688 {
 689     sal_Int32 nSelectionPos = m_xTopLevelListBox->get_active();
 690
 691     SvxConfigEntry* pToolbar =
 692         reinterpret_cast<SvxConfigEntry*>(m_xTopLevelListBox->get_id(nSelectionPos).toInt64());
 693
 694     std::unique_ptr<weld::MessageDialog> xQueryBox(Application::CreateMessageDialog(GetFrameWeld(),
 695                                                    VclMessageType::Question, VclButtonsType::YesNo,
 696                                                    CuiResId(RID_SVXSTR_CONFIRM_RESTORE_DEFAULT)));
 697     if (xQueryBox->run() == RET_YES)
 698     {
 699         ToolbarSaveInData* pSaveInData =
 700             static_cast<ToolbarSaveInData*>(GetSaveInData());
 701
 702         pSaveInData->RestoreToolbar( pToolbar );
 703
 704         SelectElement();
 705     }
 706 }
 707
 708 void SvxToolbarConfigPage::UpdateButtonStates()
 709 {
 710     SvxConfigEntry* pToolbar = GetTopLevelSelection();
 711     int selection = m_xContentsListBox->get_selected_index();
 712
 713     bool  bIsSeparator =
 714         selection != -1 && reinterpret_cast<SvxConfigEntry*>(m_xContentsListBox->get_id(selection).toInt64())->IsSeparator();
 715     bool bIsValidSelection =
 716         !(m_xContentsListBox->n_children() == 0 || selection == -1);
 717
 718     m_xMoveUpButton->set_sensitive( bIsValidSelection );
 719     m_xMoveDownButton->set_sensitive( bIsValidSelection );
 720
 721     m_xRemoveCommandButton->set_sensitive( bIsValidSelection );
 722
 723     m_xModifyBtn->set_sensitive( bIsValidSelection && !bIsSeparator );
 724
 725     // Handle the gear button
 726     // "toolbar_gear_add" option is always enabled
 727     m_xGearBtn->set_item_sensitive("toolbar_gear_delete", pToolbar && pToolbar->IsDeletable());
 728     m_xGearBtn->set_item_sensitive("toolbar_gear_rename", pToolbar && pToolbar->IsRenamable());
 729 }
 730
 731 short SvxToolbarConfigPage::QueryReset()
 732 {
 733     OUString msg = CuiResId( RID_SVXSTR_CONFIRM_TOOLBAR_RESET );
 734
 735     OUString saveInName = m_xSaveInListBox->get_active_text();
 736
 737     OUString label = SvxConfigPageHelper::replaceSaveInName( msg, saveInName );
 738
 739     std::unique_ptr<weld::MessageDialog> xQueryBox(Application::CreateMessageDialog(GetFrameWeld(),
 740                                                    VclMessageType::Question, VclButtonsType::YesNo,
 741                                                    label));
 742     return xQueryBox->run();
 743 }
 744
 745 void SvxToolbarConfigPage::SelectElement()
 746 {
 747     m_xContentsListBox->clear();
 748
 749     SvxConfigEntry* pToolbar = GetTopLevelSelection();
 750     if ( pToolbar == nullptr )
 751     {
 752         //TODO: Disable related buttons
 753         m_xInsertBtn->set_sensitive( false );
 754         m_xResetBtn->set_sensitive( false );
 755         m_xGearBtn->set_sensitive( false );
 756
 757         return;
 758     }
 759     else
 760     {
 761         m_xInsertBtn->set_sensitive(true);
 762         m_xResetBtn->set_sensitive(true);
 763         m_xGearBtn->set_sensitive(true);
 764     }
 765
 766     switch (pToolbar->GetStyle())
 767     {
 768         case 0:
 769         {
 770             m_xGearBtn->set_item_active("toolbar_gear_iconOnly", true);
 771             break;
 772         }
 773         case 1:
 774         {
 775             m_xGearBtn->set_item_active("toolbar_gear_textOnly", true);
 776             break;
 777         }
 778         case 2:
 779         {
 780             m_xGearBtn->set_item_active("toolbar_gear_iconAndText", true);
 781             break;
 782         }
 783     }
 784
 785     int i = 0;
 786     SvxEntries* pEntries = pToolbar->GetEntries();
 787     for (auto const& entry : *pEntries)
 788     {
 789         OUString sId(OUString::number(reinterpret_cast<sal_Int64>(entry)));
 790         m_xContentsListBox->insert(i, sId);
 791         if (entry->IsBinding() && !entry->IsSeparator())
 792             m_xContentsListBox->set_toggle(i,  entry->IsVisible() ? TRISTATE_TRUE : TRISTATE_FALSE, 0);
 793         InsertEntryIntoUI(entry, m_xContentsListBox->get_widget(), i, 1);
 794         ++i;
 795     }
 796
 797     UpdateButtonStates();
 798 }
 799
 800 void SvxToolbarConfigPage::AddFunction(int nTarget)
 801 {
 802     SvxConfigEntry* pToolbar = GetTopLevelSelection();
 803
 804     if (pToolbar == nullptr)
 805         return;
 806
 807     // Add the command to the contents listbox of the selected toolbar
 808     int nNewLBEntry =
 809         SvxConfigPage::AddFunction(nTarget, true/*bAllowDuplicates*/);
 810
 811     if (nNewLBEntry == -1)
 812         return;
 813
 814     SvxConfigEntry* pEntry = reinterpret_cast<SvxConfigEntry*>(m_xContentsListBox->get_id(nNewLBEntry).toInt64());
 815
 816     if ( pEntry->IsBinding() ) //TODO sep ?
 817     {
 818         pEntry->SetVisible(true);
 819         m_xContentsListBox->set_toggle(nNewLBEntry, TRISTATE_TRUE, 0);
 820     }
 821
 822     InsertEntryIntoUI(pEntry, m_xContentsListBox->get_widget(), nNewLBEntry, 1);
 823
 824     // Changes are not visible on the toolbar until this point
 825     // TODO: Figure out a way to show the changes on the toolbar, but revert if
 826     //       the dialog is closed by pressing "Cancel"
 827     // get currently selected toolbar and apply change
 828     if ( pToolbar != nullptr )
 829     {
 830         static_cast<ToolbarSaveInData*>( GetSaveInData() )->ApplyToolbar( pToolbar );
 831     }
 832 }
 833
 834 SvxToolbarEntriesListBox::SvxToolbarEntriesListBox(std::unique_ptr<weld::TreeView> xParent, SvxToolbarConfigPage* pPg)
 835     : SvxMenuEntriesListBox(std::move(xParent), pPg)
 836 {
 837     m_xControl->connect_toggled(LINK(this, SvxToolbarEntriesListBox, CheckButtonHdl));
 838     m_xControl->connect_key_press(Link<const KeyEvent&, bool>()); //acknowledge we first remove the old one
 839     m_xControl->connect_key_press(LINK(this, SvxToolbarEntriesListBox, KeyInputHdl)); // then add the new one
 840 }
 841
 842 SvxToolbarEntriesListBox::~SvxToolbarEntriesListBox()
 843 {
 844 }
 845
 846 void SvxToolbarEntriesListBox::ChangedVisibility(int nRow)
 847 {
 848     SvxConfigEntry* pEntryData =
 849         reinterpret_cast<SvxConfigEntry*>(m_xControl->get_id(nRow).toInt64());
 850
 851     if (pEntryData->IsBinding())
 852     {
 853         pEntryData->SetVisible(m_xControl->get_toggle(nRow, 0) == TRISTATE_TRUE);
 854
 855         SvxConfigEntry* pToolbar = m_pPage->GetTopLevelSelection();
 856
 857         ToolbarSaveInData* pToolbarSaveInData = static_cast<ToolbarSaveInData*>(
 858             m_pPage->GetSaveInData() );
 859
 860         pToolbarSaveInData->ApplyToolbar( pToolbar );
 861     }
 862 }
 863
 864 IMPL_LINK(SvxToolbarEntriesListBox, CheckButtonHdl, const row_col&, rRowCol, void)
 865 {
 866     ChangedVisibility(rRowCol.first);
 867 }
 868
 869 IMPL_LINK(SvxToolbarEntriesListBox, KeyInputHdl, const KeyEvent&, rKeyEvent, bool)
 870 {
 871     // space key will change visibility of toolbar items
 872     if ( rKeyEvent.GetKeyCode() == KEY_SPACE )
 873     {
 874         int nRow = m_xControl->get_selected_index();
 875         SvxConfigEntry* pEntryData = reinterpret_cast<SvxConfigEntry*>(m_xControl->get_id(nRow).toInt64());
 876         if (pEntryData->IsBinding() && !pEntryData->IsSeparator())
 877         {
 878             m_xControl->set_toggle(nRow, m_xControl->get_toggle(nRow, 0) == TRISTATE_TRUE ? TRISTATE_FALSE : TRISTATE_TRUE, 0);
 879             ChangedVisibility(nRow);
 880         }
 881         return true;
 882     }
 883     return SvxMenuEntriesListBox::KeyInputHdl(rKeyEvent);
 884 }
 885
 886 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */