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