cui/source/customize/SvxMenuConfigPage.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/weld.hxx>
  25 #include <vcl/svapp.hxx>
  26
  27 #include <algorithm>
  28 #include <strings.hrc>
  29 #include <helpids.h>
  30
  31 #include <cfg.hxx>
  32 #include <SvxMenuConfigPage.hxx>
  33 #include <SvxConfigPageHelper.hxx>
  34 #include <dialmgr.hxx>
  35
  36 #include <comphelper/processfactory.hxx>
  37 #include <com/sun/star/ui/ImageType.hpp>
  38
  39 #include <dlgname.hxx>
  40
  41 SvxMenuConfigPage::SvxMenuConfigPage(weld::Container* pPage, weld::DialogController* pController, const SfxItemSet& rSet, bool bIsMenuBar)
  42     : SvxConfigPage(pPage, pController, rSet)
  43     , m_bIsMenuBar(bIsMenuBar)
  44 {
  45     m_xGearBtn = m_xBuilder->weld_menu_button("menugearbtn");
  46     m_xGearBtn->show();
  47     m_xContentsListBox.reset(new SvxMenuEntriesListBox(m_xBuilder->weld_tree_view("menucontents"), this));
  48     weld::TreeView& rTreeView = m_xContentsListBox->get_widget();
  49     rTreeView.connect_size_allocate(LINK(this, SvxMenuConfigPage, MenuEntriesSizeAllocHdl));
  50     Size aSize(m_xFunctions->get_size_request());
  51     rTreeView.set_size_request(aSize.Width(), aSize.Height());
  52     MenuEntriesSizeAllocHdl(aSize);
  53     rTreeView.set_hexpand(true);
  54     rTreeView.set_vexpand(true);
  55     rTreeView.show();
  56
  57     rTreeView.connect_changed(
  58         LINK( this, SvxMenuConfigPage, SelectMenuEntry ) );
  59
  60     rTreeView.connect_model_changed(LINK(this, SvxMenuConfigPage, ListModifiedHdl));
  61
  62     m_xGearBtn->connect_selected(LINK(this, SvxMenuConfigPage, GearHdl));
  63
  64     m_xCommandCategoryListBox->connect_changed(LINK(this, SvxMenuConfigPage, SelectCategory));
  65
  66     m_xMoveUpButton->connect_clicked( LINK( this, SvxConfigPage, MoveHdl) );
  67     m_xMoveDownButton->connect_clicked( LINK( this, SvxConfigPage, MoveHdl) );
  68
  69     m_xAddCommandButton->connect_clicked( LINK( this, SvxMenuConfigPage, AddCommandHdl ) );
  70     m_xRemoveCommandButton->connect_clicked( LINK( this, SvxMenuConfigPage, RemoveCommandHdl ) );
  71
  72     m_xInsertBtn->connect_selected(
  73         LINK( this, SvxMenuConfigPage, InsertHdl ) );
  74     m_xModifyBtn->connect_selected(
  75         LINK( this, SvxMenuConfigPage, ModifyItemHdl ) );
  76     m_xResetBtn->connect_clicked(
  77         LINK( this, SvxMenuConfigPage, ResetMenuHdl ) );
  78
  79     // These operations are not possible on menus/context menus yet
  80     m_xModifyBtn->remove_item("changeIcon");
  81     m_xModifyBtn->remove_item("resetIcon");
  82     m_xModifyBtn->remove_item("restoreItem");
  83
  84     if ( !bIsMenuBar )
  85     {
  86         //TODO: Remove this when the gear button is implemented for context menus
  87         m_xGearBtn->set_sensitive(false);
  88         m_xGearBtn->hide();
  89     }
  90     else
  91     {
  92         // TODO: Remove this when it is possible to reset menubar menus individually
  93         m_xResetBtn->set_sensitive(false);
  94     }
  95 }
  96
  97 IMPL_LINK_NOARG(SvxMenuConfigPage, ListModifiedHdl, weld::TreeView&, void)
  98 {
  99     // regenerate with the current ordering within the list
 100     SvxEntries* pEntries = GetTopLevelSelection()->GetEntries();
 101     pEntries->clear();
 102
 103     for (int i = 0; i < m_xContentsListBox->n_children(); ++i)
 104         pEntries->push_back(reinterpret_cast<SvxConfigEntry*>(m_xContentsListBox->get_id(i).toInt64()));
 105
 106     GetSaveInData()->SetModified();
 107     GetTopLevelSelection()->SetModified();
 108     UpdateButtonStates();
 109 }
 110
 111 IMPL_LINK(SvxMenuConfigPage, MenuEntriesSizeAllocHdl, const Size&, rSize, void)
 112 {
 113     weld::TreeView& rTreeView = m_xContentsListBox->get_widget();
 114     std::vector<int> aWidths;
 115
 116     int nExpectedSize = 16;
 117
 118     int nStandardImageColWidth = rTreeView.get_checkbox_column_width();
 119     int nMargin = nStandardImageColWidth - nExpectedSize;
 120     if (nMargin < 16)
 121         nMargin = 16;
 122
 123     if (SvxConfigPageHelper::GetImageType() & css::ui::ImageType::SIZE_LARGE)
 124         nExpectedSize = 24;
 125     else if (SvxConfigPageHelper::GetImageType() & css::ui::ImageType::SIZE_32)
 126         nExpectedSize = 32;
 127
 128     int nImageColWidth = nExpectedSize + nMargin;
 129
 130     aWidths.push_back(nImageColWidth);
 131     aWidths.push_back(rSize.Width() - (nImageColWidth + nStandardImageColWidth));
 132     rTreeView.set_column_fixed_widths(aWidths);
 133 }
 134
 135 SvxMenuConfigPage::~SvxMenuConfigPage()
 136 {
 137     for (int i = 0, nCount = m_xSaveInListBox->get_count(); i < nCount; ++i)
 138         delete reinterpret_cast<SaveInData*>(m_xSaveInListBox->get_id(i).toInt64());
 139     m_xSaveInListBox->clear();
 140 }
 141
 142 // Populates the Menu combo box
 143 void SvxMenuConfigPage::Init()
 144 {
 145     // ensure that the UI is cleared before populating it
 146     m_xTopLevelListBox->clear();
 147     m_xContentsListBox->clear();
 148
 149     ReloadTopLevelListBox();
 150
 151     m_xTopLevelListBox->set_active(0);
 152     SelectElement();
 153
 154     m_xCommandCategoryListBox->Init(
 155         comphelper::getProcessComponentContext(),
 156         m_xFrame,
 157         vcl::CommandInfoProvider::GetModuleIdentifier(m_xFrame));
 158     m_xCommandCategoryListBox->categorySelected(m_xFunctions.get(), OUString(), GetSaveInData());
 159 }
 160
 161 IMPL_LINK_NOARG(SvxMenuConfigPage, SelectMenuEntry, weld::TreeView&, void)
 162 {
 163     UpdateButtonStates();
 164 }
 165
 166 void SvxMenuConfigPage::UpdateButtonStates()
 167 {
 168     // Disable Up and Down buttons depending on current selection
 169     int selection = m_xContentsListBox->get_selected_index();
 170
 171     bool  bIsSeparator =
 172         selection != -1 && reinterpret_cast<SvxConfigEntry*>(m_xContentsListBox->get_id(selection).toInt64())->IsSeparator();
 173     bool bIsValidSelection =
 174         !(m_xContentsListBox->n_children() == 0 || selection == -1);
 175
 176     m_xMoveUpButton->set_sensitive(
 177         bIsValidSelection &&  selection != 0 );
 178     m_xMoveDownButton->set_sensitive(
 179         bIsValidSelection && selection != m_xContentsListBox->n_children() - 1);
 180
 181     m_xRemoveCommandButton->set_sensitive( bIsValidSelection );
 182
 183     m_xModifyBtn->set_sensitive( bIsValidSelection && !bIsSeparator);
 184
 185     // If there is no top level selection (menu), then everything working on the right box
 186     // which contains the functions of the selected menu/toolbar needs to be disabled
 187     SvxConfigEntry* pMenuData = GetTopLevelSelection();
 188
 189     m_xInsertBtn->set_sensitive(pMenuData != nullptr);
 190
 191     m_xAddCommandButton->set_sensitive(pMenuData != nullptr);
 192     m_xRemoveCommandButton->set_sensitive(pMenuData != nullptr);
 193
 194     //Handle the gear button
 195     if (pMenuData && m_bIsMenuBar)
 196     {
 197         // Add option (gear_add) will always be enabled
 198         m_xGearBtn->set_item_sensitive( "menu_gear_delete", pMenuData->IsDeletable() );
 199         m_xGearBtn->set_item_sensitive( "menu_gear_rename", pMenuData->IsRenamable() );
 200         m_xGearBtn->set_item_sensitive( "menu_gear_move", pMenuData->IsMovable() );
 201     }
 202 }
 203
 204 void SvxMenuConfigPage::DeleteSelectedTopLevel()
 205 {
 206     SvxConfigEntry* pMenuData = GetTopLevelSelection();
 207
 208     SvxEntries* pParentEntries =
 209         FindParentForChild( GetSaveInData()->GetEntries(), pMenuData );
 210
 211     SvxConfigPageHelper::RemoveEntry( pParentEntries, pMenuData );
 212     delete pMenuData;
 213
 214     ReloadTopLevelListBox();
 215
 216     GetSaveInData()->SetModified( );
 217 }
 218
 219 void SvxMenuConfigPage::DeleteSelectedContent()
 220 {
 221     int nActEntry = m_xContentsListBox->get_selected_index();
 222
 223     if (nActEntry != -1)
 224     {
 225         // get currently selected menu entry
 226         SvxConfigEntry* pMenuEntry =
 227             reinterpret_cast<SvxConfigEntry*>(m_xContentsListBox->get_id(nActEntry).toInt64());
 228
 229         // get currently selected menu
 230         SvxConfigEntry* pMenu = GetTopLevelSelection();
 231
 232         // remove menu entry from the list for this menu
 233         SvxConfigPageHelper::RemoveEntry( pMenu->GetEntries(), pMenuEntry );
 234
 235         // remove menu entry from UI
 236         m_xContentsListBox->remove(nActEntry);
 237
 238         // if this is a submenu entry, redraw the menus list box
 239         if ( pMenuEntry->IsPopup() )
 240         {
 241             ReloadTopLevelListBox();
 242         }
 243
 244         // delete data for menu entry
 245         delete pMenuEntry;
 246
 247         GetSaveInData()->SetModified();
 248         pMenu->SetModified();
 249     }
 250 }
 251
 252 short SvxMenuConfigPage::QueryReset()
 253 {
 254     OUString msg = CuiResId( RID_SVXSTR_CONFIRM_MENU_RESET );
 255
 256     OUString saveInName = m_xSaveInListBox->get_active_text();
 257
 258     OUString label = SvxConfigPageHelper::replaceSaveInName( msg, saveInName );
 259
 260     std::unique_ptr<weld::MessageDialog> xQueryBox(Application::CreateMessageDialog(GetFrameWeld(),
 261                                                    VclMessageType::Question, VclButtonsType::YesNo,
 262                                                    label));
 263     return xQueryBox->run();
 264 }
 265
 266 void SvxMenuConfigPage::SelectElement()
 267 {
 268     m_xContentsListBox->clear();
 269
 270     SvxConfigEntry* pMenuData = GetTopLevelSelection();
 271
 272     if ( pMenuData )
 273     {
 274         SvxEntries* pEntries = pMenuData->GetEntries();
 275
 276         int i = 0;
 277         for (auto const& entry : *pEntries)
 278         {
 279             OUString sId(OUString::number(reinterpret_cast<sal_Int64>(entry)));
 280             m_xContentsListBox->insert(i, sId);
 281             InsertEntryIntoUI(entry, i, 0);
 282             ++i;
 283         }
 284     }
 285
 286     UpdateButtonStates();
 287 }
 288
 289 IMPL_LINK(SvxMenuConfigPage, GearHdl, const OString&, rIdent, void)
 290 {
 291     if (rIdent == "menu_gear_add")
 292     {
 293         SvxMainMenuOrganizerDialog aDialog(GetFrameWeld(),
 294             GetSaveInData()->GetEntries(), nullptr, true );
 295
 296         if (aDialog.run() == RET_OK)
 297         {
 298             GetSaveInData()->SetEntries(aDialog.ReleaseEntries());
 299             ReloadTopLevelListBox(aDialog.GetSelectedEntry());
 300             GetSaveInData()->SetModified();
 301         }
 302     }
 303     else if (rIdent == "menu_gear_delete")
 304     {
 305         DeleteSelectedTopLevel();
 306     }
 307     else if (rIdent == "menu_gear_rename")
 308     {
 309         SvxConfigEntry* pMenuData = GetTopLevelSelection();
 310
 311         OUString sCurrentName( SvxConfigPageHelper::stripHotKey( pMenuData->GetName() ) );
 312         OUString sDesc = CuiResId( RID_SVXSTR_LABEL_NEW_NAME );
 313
 314         SvxNameDialog aNameDialog(GetFrameWeld(), sCurrentName, sDesc);
 315         aNameDialog.set_help_id(HID_SVX_CONFIG_RENAME_MENU);
 316         aNameDialog.set_title(CuiResId(RID_SVXSTR_RENAME_MENU));
 317
 318         if ( aNameDialog.run() == RET_OK )
 319         {
 320             OUString sNewName = aNameDialog.GetName();
 321
 322             if ( sCurrentName == sNewName )
 323                 return;
 324
 325             pMenuData->SetName( sNewName );
 326
 327             ReloadTopLevelListBox();
 328
 329             GetSaveInData()->SetModified();
 330         }
 331     }
 332     else if (rIdent == "menu_gear_move")
 333     {
 334         SvxConfigEntry* pMenuData = GetTopLevelSelection();
 335
 336         SvxMainMenuOrganizerDialog aDialog(GetFrameWeld(), GetSaveInData()->GetEntries(),
 337                 pMenuData, false );
 338         if (aDialog.run() == RET_OK)
 339         {
 340             GetSaveInData()->SetEntries(aDialog.ReleaseEntries());
 341
 342             ReloadTopLevelListBox();
 343
 344             GetSaveInData()->SetModified();
 345         }
 346     }
 347     else
 348     {
 349         //This block should never be reached
 350         SAL_WARN("cui.customize", "Unknown gear menu option: " << rIdent);
 351         return;
 352     }
 353
 354     UpdateButtonStates();
 355 }
 356
 357 IMPL_LINK_NOARG(SvxMenuConfigPage, SelectCategory, weld::ComboBox&, void)
 358 {
 359     OUString aSearchTerm( m_xSearchEdit->get_text() );
 360
 361     m_xCommandCategoryListBox->categorySelected(m_xFunctions.get(), aSearchTerm, GetSaveInData());
 362 }
 363
 364 IMPL_LINK_NOARG( SvxMenuConfigPage, AddCommandHdl, weld::Button&, void )
 365 {
 366     int nPos = AddFunction(-1, /*bAllowDuplicates*/false);
 367     if (nPos == -1)
 368         return;
 369     SvxConfigEntry* pEntry =
 370         reinterpret_cast<SvxConfigEntry*>(m_xContentsListBox->get_id(nPos).toInt64());
 371     InsertEntryIntoUI(pEntry, nPos, 0);
 372 }
 373
 374 IMPL_LINK_NOARG( SvxMenuConfigPage, RemoveCommandHdl, weld::Button&, void )
 375 {
 376     DeleteSelectedContent();
 377     if ( GetSaveInData()->IsModified() )
 378     {
 379         UpdateButtonStates();
 380     }
 381 }
 382
 383 IMPL_LINK(SvxMenuConfigPage, InsertHdl, const OString&, rIdent, void)
 384 {
 385     if (rIdent == "insertseparator")
 386     {
 387         SvxConfigEntry* pNewEntryData = new SvxConfigEntry;
 388         pNewEntryData->SetUserDefined();
 389         int nPos = AppendEntry(pNewEntryData, -1);
 390         InsertEntryIntoUI(pNewEntryData, nPos, 0);
 391     }
 392     else if (rIdent == "insertsubmenu")
 393     {
 394         OUString aNewName;
 395         OUString aDesc = CuiResId( RID_SVXSTR_SUBMENU_NAME );
 396
 397         SvxNameDialog aNameDialog(GetFrameWeld(), aNewName, aDesc);
 398         aNameDialog.set_help_id(HID_SVX_CONFIG_NAME_SUBMENU);
 399         aNameDialog.set_title(CuiResId( RID_SVXSTR_ADD_SUBMENU));
 400
 401         if (aNameDialog.run() == RET_OK)
 402         {
 403             aNewName = aNameDialog.GetName();
 404
 405             SvxConfigEntry* pNewEntryData =
 406                 new SvxConfigEntry( aNewName, aNewName, true, /*bParentData*/false );
 407             pNewEntryData->SetName( aNewName );
 408             pNewEntryData->SetUserDefined();
 409
 410             int nPos = AppendEntry(pNewEntryData, -1);
 411             InsertEntryIntoUI(pNewEntryData, nPos, 0);
 412
 413             ReloadTopLevelListBox();
 414
 415             m_xContentsListBox->scroll_to_row(nPos);
 416             m_xContentsListBox->select(nPos);
 417
 418             GetSaveInData()->SetModified();
 419         }
 420
 421     }
 422     else
 423     {
 424         //This block should never be reached
 425         SAL_WARN("cui.customize", "Unknown insert option: " << rIdent);
 426         return;
 427     }
 428
 429     if ( GetSaveInData()->IsModified() )
 430     {
 431         UpdateButtonStates();
 432     }
 433 }
 434
 435 IMPL_LINK(SvxMenuConfigPage, ModifyItemHdl, const OString&, rIdent, void)
 436 {
 437     if (rIdent == "renameItem")
 438     {
 439         int nActEntry = m_xContentsListBox->get_selected_index();
 440         SvxConfigEntry* pEntry =
 441             reinterpret_cast<SvxConfigEntry*>(m_xContentsListBox->get_id(nActEntry).toInt64());
 442
 443         OUString aNewName( SvxConfigPageHelper::stripHotKey( pEntry->GetName() ) );
 444         OUString aDesc = CuiResId( RID_SVXSTR_LABEL_NEW_NAME );
 445
 446         SvxNameDialog aNameDialog(GetFrameWeld(), aNewName, aDesc);
 447         aNameDialog.set_help_id(HID_SVX_CONFIG_RENAME_MENU_ITEM);
 448         aNameDialog.set_title(CuiResId(RID_SVXSTR_RENAME_MENU));
 449
 450         if (aNameDialog.run() == RET_OK)
 451         {
 452             aNewName = aNameDialog.GetName();
 453
 454             pEntry->SetName( aNewName );
 455             m_xContentsListBox->set_text(nActEntry, aNewName, 1);
 456
 457             GetSaveInData()->SetModified();
 458             GetTopLevelSelection()->SetModified();
 459         }
 460     }
 461     else
 462     {
 463         //This block should never be reached
 464         SAL_WARN("cui.customize", "Unknown insert option: " << rIdent);
 465         return;
 466     }
 467
 468     if ( GetSaveInData()->IsModified() )
 469     {
 470         UpdateButtonStates();
 471     }
 472 }
 473
 474 IMPL_LINK_NOARG(SvxMenuConfigPage, ResetMenuHdl, weld::Button&, void)
 475 {
 476     SvxConfigEntry* pMenuData = GetTopLevelSelection();
 477
 478     if (pMenuData == nullptr)
 479     {
 480         SAL_WARN("cui.customize", "RHB top level selection is null. A menu must be selected to reset!");
 481         return;
 482     }
 483
 484     std::unique_ptr<weld::MessageDialog> xQueryBox(Application::CreateMessageDialog(GetFrameWeld(),
 485                                                    VclMessageType::Question, VclButtonsType::YesNo,
 486                                                    CuiResId(RID_SVXSTR_CONFIRM_RESTORE_DEFAULT_MENU)));
 487
 488     // Resetting individual top-level menus is not possible at the moment.
 489     // So we are resetting only if it is a context menu
 490     if (!m_bIsMenuBar && xQueryBox->run() == RET_YES)
 491     {
 492         sal_Int32 nPos = m_xTopLevelListBox->get_active();
 493         ContextMenuSaveInData* pSaveInData = static_cast< ContextMenuSaveInData* >(GetSaveInData());
 494
 495         pSaveInData->ResetContextMenu(pMenuData);
 496
 497         // ensure that the UI is cleared before populating it
 498         m_xTopLevelListBox->clear();
 499         m_xContentsListBox->clear();
 500
 501         ReloadTopLevelListBox();
 502
 503         // Reselect the reset menu
 504         m_xTopLevelListBox->set_active(nPos);
 505         SelectElement();
 506     }
 507 }
 508
 509 SaveInData* SvxMenuConfigPage::CreateSaveInData(
 510     const css::uno::Reference< css::ui::XUIConfigurationManager >& xCfgMgr,
 511     const css::uno::Reference< css::ui::XUIConfigurationManager >& xParentCfgMgr,
 512     const OUString& aModuleId,
 513     bool bDocConfig )
 514 {
 515     if ( !m_bIsMenuBar )
 516         return static_cast< SaveInData* >( new ContextMenuSaveInData( xCfgMgr, xParentCfgMgr, aModuleId, bDocConfig ) );
 517
 518     return static_cast< SaveInData* >( new MenuSaveInData( xCfgMgr, xParentCfgMgr, aModuleId, bDocConfig ) );
 519 }
 520
 521  /* vim:set shiftwidth=4 softtabstop=4 expandtab: */