dbaccess/source/ui/app/AppDetailView.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 "AppDetailView.hxx"
  21 #include <osl/diagnose.h>
  22 #include <helpids.h>
  23 #include <strings.hrc>
  24 #include "AppView.hxx"
  25 #include <com/sun/star/ui/XUIConfigurationManager.hpp>
  26 #include <com/sun/star/ui/theModuleUIConfigurationManagerSupplier.hpp>
  27 #include <com/sun/star/ui/XImageManager.hpp>
  28 #include <com/sun/star/ui/ImageType.hpp>
  29 #include <com/sun/star/sdbcx/XViewsSupplier.hpp>
  30 #include <com/sun/star/graphic/XGraphic.hpp>
  31 #include <com/sun/star/util/URL.hpp>
  32 #include <core_resource.hxx>
  33 #include <vcl/svapp.hxx>
  34 #include "AppDetailPageHelper.hxx"
  35 #include <dbaccess/IController.hxx>
  36 #include <algorithm>
  37 #include <dbtreelistbox.hxx>
  38 #include "AppController.hxx"
  39
  40 using namespace ::dbaui;
  41 using namespace ::com::sun::star::uno;
  42 using namespace ::com::sun::star::sdbc;
  43 using namespace ::com::sun::star::ucb;
  44 using namespace ::com::sun::star::graphic;
  45 using namespace ::com::sun::star::ui;
  46 using namespace ::com::sun::star::container;
  47 using namespace ::com::sun::star::beans;
  48 using ::com::sun::star::util::URL;
  49 using ::com::sun::star::sdb::application::NamedDatabaseObject;
  50
  51 TaskEntry::TaskEntry( const OUString& _rAsciiUNOCommand, TranslateId _pHelpID, TranslateId pTitleResourceID, bool _bHideWhenDisabled )
  52     :sUNOCommand( _rAsciiUNOCommand )
  53     ,pHelpID( _pHelpID )
  54     ,sTitle( DBA_RES(pTitleResourceID) )
  55     ,bHideWhenDisabled( _bHideWhenDisabled )
  56 {
  57 }
  58
  59 void OTasksWindow::updateHelpText()
  60 {
  61     TranslateId pHelpTextId;
  62     int nCurEntry = m_xTreeView->get_selected_index();
  63     if (nCurEntry != -1)
  64         pHelpTextId = weld::fromId<TaskEntry*>(m_xTreeView->get_id(nCurEntry))->pHelpID;
  65     setHelpText(pHelpTextId);
  66 }
  67
  68 IMPL_LINK(OTasksWindow, onSelected, weld::TreeView&, rTreeView, bool)
  69 {
  70     m_nCursorIndex = rTreeView.get_cursor_index();
  71     if (m_nCursorIndex != -1)
  72     {
  73         URL aCommand;
  74         aCommand.Complete = weld::fromId<TaskEntry*>(rTreeView.get_id(m_nCursorIndex))->sUNOCommand;
  75         getDetailView()->getBorderWin().getView()->getAppController().executeChecked( aCommand, Sequence< PropertyValue >() );
  76     }
  77     return true;
  78 }
  79
  80 void OTasksWindow::GrabFocus()
  81 {
  82     if (!m_xTreeView)
  83         return;
  84     m_xTreeView->grab_focus();
  85 }
  86
  87 bool OTasksWindow::HasChildPathFocus() const
  88 {
  89     return m_xTreeView && m_xTreeView->has_focus();
  90 }
  91
  92 IMPL_LINK_NOARG(OTasksWindow, FocusInHdl, weld::Widget&, void)
  93 {
  94     m_xTreeView->select(m_nCursorIndex != -1 ? m_nCursorIndex : 0);
  95 }
  96
  97 IMPL_LINK_NOARG(OTasksWindow, FocusOutHdl, weld::Widget&, void)
  98 {
  99     m_nCursorIndex = m_xTreeView->get_cursor_index();
 100     m_xTreeView->unselect_all();
 101 }
 102
 103 IMPL_LINK_NOARG(OTasksWindow, OnEntrySelectHdl, weld::TreeView&, void)
 104 {
 105     m_nCursorIndex = m_xTreeView->get_cursor_index();
 106     updateHelpText();
 107 }
 108
 109 OTasksWindow::OTasksWindow(weld::Container* pParent, OApplicationDetailView* pDetailView)
 110     : OChildWindow(pParent, u"dbaccess/ui/taskwindow.ui"_ustr, u"TaskWindow"_ustr)
 111     , m_xTreeView(m_xBuilder->weld_tree_view(u"treeview"_ustr))
 112     , m_xDescription(m_xBuilder->weld_label(u"description"_ustr))
 113     , m_xHelpText(m_xBuilder->weld_text_view(u"helptext"_ustr))
 114     , m_pDetailView(pDetailView)
 115     , m_nCursorIndex(-1)
 116 {
 117     m_xContainer->set_stack_background();
 118
 119     m_xTreeView->set_help_id(HID_APP_CREATION_LIST);
 120     m_xTreeView->connect_row_activated(LINK(this, OTasksWindow, onSelected));
 121     m_xTreeView->connect_selection_changed(LINK(this, OTasksWindow, OnEntrySelectHdl));
 122     m_xTreeView->connect_focus_in(LINK(this, OTasksWindow, FocusInHdl));
 123     m_xTreeView->connect_focus_out(LINK(this, OTasksWindow, FocusOutHdl));
 124     // an arbitrary small size it's allowed to shrink to
 125     m_xTreeView->set_size_request(42, 42);
 126
 127     m_xHelpText->set_help_id(HID_APP_HELP_TEXT);
 128     m_xDescription->set_help_id(HID_APP_DESCRIPTION_TEXT);
 129 }
 130
 131 OTasksWindow::~OTasksWindow()
 132 {
 133     Clear();
 134 }
 135
 136 void OTasksWindow::setHelpText(TranslateId pId)
 137 {
 138     if (pId)
 139         m_xHelpText->set_text(DBA_RES(pId));
 140     else
 141         m_xHelpText->set_text(OUString());
 142 }
 143
 144 void OTasksWindow::fillTaskEntryList( const TaskEntryList& _rList )
 145 {
 146     Clear();
 147
 148     try
 149     {
 150         Reference< XModuleUIConfigurationManagerSupplier > xModuleCfgMgrSupplier =
 151             theModuleUIConfigurationManagerSupplier::get( getDetailView()->getBorderWin().getView()->getORB() );
 152         Reference< XUIConfigurationManager > xUIConfigMgr = xModuleCfgMgrSupplier->getUIConfigurationManager(
 153             u"com.sun.star.sdb.OfficeDatabaseDocument"_ustr
 154         );
 155         Reference< XImageManager > xImageMgr( xUIConfigMgr->getImageManager(), UNO_QUERY );
 156
 157         // copy the commands so we can use them with the config managers
 158         Sequence< OUString > aCommands( _rList.size() );
 159         std::transform(_rList.begin(), _rList.end(), aCommands.getArray(),
 160                        [](auto& copyTask) { return copyTask.sUNOCommand; });
 161
 162         Sequence< Reference< XGraphic> > aImages = xImageMgr->getImages(
 163             ImageType::SIZE_DEFAULT | ImageType::COLOR_NORMAL ,
 164             aCommands
 165         );
 166         assert(aImages.size() == _rList.size());
 167
 168         for (size_t nIndex = 0; nIndex < _rList.size(); ++nIndex)
 169         {
 170             OUString sId = weld::toId(new TaskEntry(_rList[nIndex]));
 171             m_xTreeView->append(sId, _rList[nIndex].sTitle);
 172             m_xTreeView->set_image(nIndex, aImages[nIndex]);
 173         }
 174     }
 175     catch(Exception&)
 176     {
 177     }
 178
 179     m_xTreeView->unselect_all();
 180     updateHelpText();
 181     Enable(!_rList.empty());
 182 }
 183
 184 void OTasksWindow::Clear()
 185 {
 186     m_xTreeView->all_foreach([this](weld::TreeIter& rEntry){
 187         TaskEntry* pUserData = weld::fromId<TaskEntry*>(m_xTreeView->get_id(rEntry));
 188         delete pUserData;
 189         return false;
 190     });
 191
 192     m_xTreeView->clear();
 193 }
 194
 195 OApplicationDetailView::OApplicationDetailView(weld::Container* pParent, OAppBorderWindow& rBorder,
 196                                                PreviewMode ePreviewMode)
 197     : m_xBuilder(Application::CreateBuilder(pParent, u"dbaccess/ui/appdetailwindow.ui"_ustr))
 198     , m_xContainer(m_xBuilder->weld_container(u"AppDetailWindow"_ustr))
 199     , m_xHorzSplitter(m_xBuilder->weld_paned(u"splitter"_ustr))
 200     , m_xTasksParent(m_xBuilder->weld_container(u"tasks"_ustr))
 201     , m_xContainerParent(m_xBuilder->weld_container(u"container"_ustr))
 202     , m_xTasks(new dbaui::OTitleWindow(m_xTasksParent.get(), STR_TASKS))
 203     , m_xTitleContainer(new dbaui::OTitleWindow(m_xContainerParent.get(), TranslateId()))
 204     , m_rBorderWin(rBorder)
 205 {
 206     m_xControlHelper = std::make_shared<OAppDetailPageHelper>(m_xTitleContainer->getChildContainer(), m_rBorderWin, ePreviewMode);
 207     m_xTitleContainer->setChildWindow(m_xControlHelper);
 208
 209     std::shared_ptr<OChildWindow> xTasks = std::make_shared<OTasksWindow>(m_xTasks->getChildContainer(), this);
 210     xTasks->Enable(!m_rBorderWin.getView()->getCommandController().isDataSourceReadOnly());
 211     m_xTasks->setChildWindow(xTasks);
 212 }
 213
 214 OApplicationDetailView::~OApplicationDetailView()
 215 {
 216 }
 217
 218 void OApplicationDetailView::setTaskExternalMnemonics( MnemonicGenerator const & rMnemonics )
 219 {
 220     m_aExternalMnemonics = rMnemonics;
 221 }
 222
 223 void OApplicationDetailView::createTablesPage(const Reference< XConnection >& _xConnection )
 224 {
 225     impl_createPage( E_TABLE, _xConnection, nullptr );
 226 }
 227
 228 void OApplicationDetailView::createPage( ElementType _eType,const Reference< XNameAccess >& _xContainer )
 229 {
 230     impl_createPage( _eType, nullptr, _xContainer );
 231 }
 232
 233 void OApplicationDetailView::impl_createPage( ElementType _eType, const Reference< XConnection >& _rxConnection,
 234     const Reference< XNameAccess >& _rxNonTableElements )
 235 {
 236     // get the data for the pane
 237     const TaskPaneData& rData = impl_getTaskPaneData( _eType );
 238     getTasksWindow().fillTaskEntryList( rData.aTasks );
 239
 240     // enable the pane as a whole, depending on the availability of the first command
 241     OSL_ENSURE( !rData.aTasks.empty(), "OApplicationDetailView::impl_createPage: no tasks at all!?" );
 242     bool bEnabled = !rData.aTasks.empty()
 243                 && getBorderWin().getView()->getCommandController().isCommandEnabled( rData.aTasks[0].sUNOCommand );
 244     getTasksWindow().Enable( bEnabled );
 245     m_xTitleContainer->setTitle(rData.pTitleId);
 246
 247     // let our helper create the object list
 248     if ( _eType == E_TABLE )
 249         GetControlHelper()->createTablesPage( _rxConnection );
 250     else
 251         GetControlHelper()->createPage( _eType, _rxNonTableElements );
 252 }
 253
 254 void OApplicationDetailView::impl_fillTaskPaneData(ElementType _eType, TaskPaneData& _rData) const
 255 {
 256     TaskEntryList& rList( _rData.aTasks );
 257     rList.clear(); rList.reserve( 4 );
 258
 259     switch ( _eType )
 260     {
 261     case E_TABLE:
 262         rList.emplace_back( u".uno:DBNewTable"_ustr, RID_STR_TABLES_HELP_TEXT_DESIGN, RID_STR_NEW_TABLE );
 263         rList.emplace_back( u".uno:DBNewTableAutoPilot"_ustr, RID_STR_TABLES_HELP_TEXT_WIZARD, RID_STR_NEW_TABLE_AUTO );
 264         rList.emplace_back( u".uno:DBNewView"_ustr, RID_STR_VIEWS_HELP_TEXT_DESIGN, RID_STR_NEW_VIEW, true );
 265         _rData.pTitleId = RID_STR_TABLES_CONTAINER;
 266         break;
 267
 268     case E_FORM:
 269         rList.emplace_back( u".uno:DBNewForm"_ustr, RID_STR_FORMS_HELP_TEXT, RID_STR_NEW_FORM );
 270         rList.emplace_back( u".uno:DBNewFormAutoPilot"_ustr, RID_STR_FORMS_HELP_TEXT_WIZARD, RID_STR_NEW_FORM_AUTO );
 271         _rData.pTitleId = RID_STR_FORMS_CONTAINER;
 272         break;
 273
 274     case E_REPORT:
 275         rList.emplace_back( u".uno:DBNewReport"_ustr, RID_STR_REPORT_HELP_TEXT, RID_STR_NEW_REPORT, true );
 276         rList.emplace_back( u".uno:DBNewReportAutoPilot"_ustr, RID_STR_REPORTS_HELP_TEXT_WIZARD, RID_STR_NEW_REPORT_AUTO );
 277         _rData.pTitleId = RID_STR_REPORTS_CONTAINER;
 278         break;
 279
 280     case E_QUERY:
 281         rList.emplace_back( u".uno:DBNewQuery"_ustr, RID_STR_QUERIES_HELP_TEXT, RID_STR_NEW_QUERY );
 282         rList.emplace_back( u".uno:DBNewQueryAutoPilot"_ustr, RID_STR_QUERIES_HELP_TEXT_WIZARD, RID_STR_NEW_QUERY_AUTO );
 283         rList.emplace_back( u".uno:DBNewQuerySql"_ustr, RID_STR_QUERIES_HELP_TEXT_SQL, RID_STR_NEW_QUERY_SQL );
 284         _rData.pTitleId = RID_STR_QUERIES_CONTAINER;
 285         break;
 286
 287     default:
 288         OSL_FAIL( "OApplicationDetailView::impl_fillTaskPaneData: illegal element type!" );
 289     }
 290
 291     // remove the entries which are not enabled currently
 292     for (TaskEntryList::iterator pTask = rList.begin(); pTask != rList.end();)
 293     {
 294         if  (   pTask->bHideWhenDisabled
 295             &&  !getBorderWin().getView()->getCommandController().isCommandEnabled( pTask->sUNOCommand )
 296             )
 297             pTask = rList.erase( pTask );
 298         else
 299         {
 300             ++pTask;
 301         }
 302     }
 303 }
 304
 305 const TaskPaneData& OApplicationDetailView::impl_getTaskPaneData( ElementType _eType )
 306 {
 307     if ( m_aTaskPaneData.empty() )
 308         m_aTaskPaneData.resize( size_t(E_ELEMENT_TYPE_COUNT) );
 309     OSL_ENSURE( ( _eType >= 0 ) && ( _eType < E_ELEMENT_TYPE_COUNT ), "OApplicationDetailView::impl_getTaskPaneData: illegal element type!" );
 310     TaskPaneData& rData = m_aTaskPaneData[ _eType ];
 311
 312     //oj: do not check, otherwise extensions will only be visible after a reload.
 313     impl_fillTaskPaneData( _eType, rData );
 314
 315     return rData;
 316 }
 317
 318 OUString OApplicationDetailView::getQualifiedName(const weld::TreeIter* _pEntry) const
 319 {
 320     return GetControlHelper()->getQualifiedName( _pEntry );
 321 }
 322
 323 bool OApplicationDetailView::isLeaf(const weld::TreeView& rTreeView, const weld::TreeIter& rEntry)
 324 {
 325     return OAppDetailPageHelper::isLeaf(rTreeView, rEntry);
 326 }
 327
 328 bool OApplicationDetailView::isALeafSelected() const
 329 {
 330     return GetControlHelper()->isALeafSelected();
 331 }
 332
 333 void OApplicationDetailView::selectAll()
 334 {
 335     GetControlHelper()->selectAll();
 336 }
 337
 338 void OApplicationDetailView::sortDown()
 339 {
 340     GetControlHelper()->sortDown();
 341 }
 342
 343 void OApplicationDetailView::sortUp()
 344 {
 345     GetControlHelper()->sortUp();
 346 }
 347
 348 bool OApplicationDetailView::isFilled() const
 349 {
 350     return GetControlHelper()->isFilled();
 351 }
 352
 353 ElementType OApplicationDetailView::getElementType() const
 354 {
 355     return GetControlHelper()->getElementType();
 356 }
 357
 358 void OApplicationDetailView::clearPages(bool _bTaskAlso)
 359 {
 360     if ( _bTaskAlso )
 361         getTasksWindow().Clear();
 362     GetControlHelper()->clearPages();
 363 }
 364
 365 sal_Int32 OApplicationDetailView::getSelectionCount()
 366 {
 367     return GetControlHelper()->getSelectionCount();
 368 }
 369
 370 sal_Int32 OApplicationDetailView::getElementCount() const
 371 {
 372     return GetControlHelper()->getElementCount();
 373 }
 374
 375 void OApplicationDetailView::getSelectionElementNames( std::vector< OUString>& _rNames ) const
 376 {
 377     GetControlHelper()->getSelectionElementNames( _rNames );
 378 }
 379
 380 void OApplicationDetailView::describeCurrentSelectionForControl(const weld::TreeView& rControl, Sequence< NamedDatabaseObject >& out_rSelectedObjects)
 381 {
 382     GetControlHelper()->describeCurrentSelectionForControl(rControl, out_rSelectedObjects);
 383 }
 384
 385 void OApplicationDetailView::describeCurrentSelectionForType( const ElementType _eType, Sequence< NamedDatabaseObject >& _out_rSelectedObjects )
 386 {
 387     GetControlHelper()->describeCurrentSelectionForType( _eType, _out_rSelectedObjects );
 388 }
 389
 390 vcl::Window* OApplicationDetailView::getMenuParent() const
 391 {
 392     return GetControlHelper()->getMenuParent();
 393 }
 394
 395 void OApplicationDetailView::adjustMenuPosition(const weld::TreeView& rControl, ::Point& rPos) const
 396 {
 397     return GetControlHelper()->adjustMenuPosition(rControl, rPos);
 398 }
 399
 400 void OApplicationDetailView::selectElements(const Sequence< OUString>& _aNames)
 401 {
 402     GetControlHelper()->selectElements( _aNames );
 403 }
 404
 405 std::unique_ptr<weld::TreeIter> OApplicationDetailView::getEntry(const Point& rPoint) const
 406 {
 407     return GetControlHelper()->getEntry(rPoint);
 408 }
 409
 410 bool OApplicationDetailView::isCutAllowed()
 411 {
 412     return false;
 413 }
 414
 415 bool OApplicationDetailView::isCopyAllowed()
 416 {
 417     return true;
 418 }
 419
 420 bool OApplicationDetailView::isPasteAllowed() { return true; }
 421
 422 void OApplicationDetailView::copy() { }
 423
 424 void OApplicationDetailView::cut()  { }
 425
 426 void OApplicationDetailView::paste() { }
 427
 428 std::unique_ptr<weld::TreeIter> OApplicationDetailView::elementAdded(ElementType _eType,const OUString& _rName, const Any& _rObject )
 429 {
 430     return GetControlHelper()->elementAdded(_eType, _rName, _rObject);
 431 }
 432
 433 void OApplicationDetailView::elementRemoved(ElementType _eType,const OUString& _rName )
 434 {
 435     GetControlHelper()->elementRemoved(_eType,_rName );
 436 }
 437
 438 void OApplicationDetailView::elementReplaced(ElementType _eType
 439                                                     ,const OUString& _rOldName
 440                                                     ,const OUString& _rNewName )
 441 {
 442     GetControlHelper()->elementReplaced( _eType, _rOldName, _rNewName );
 443 }
 444
 445 PreviewMode OApplicationDetailView::getPreviewMode() const
 446 {
 447     return GetControlHelper()->getPreviewMode();
 448 }
 449
 450 bool OApplicationDetailView::isPreviewEnabled() const
 451 {
 452     return GetControlHelper()->isPreviewEnabled();
 453 }
 454
 455 void OApplicationDetailView::switchPreview(PreviewMode _eMode)
 456 {
 457     GetControlHelper()->switchPreview(_eMode);
 458 }
 459
 460 void OApplicationDetailView::showPreview(const Reference< XContent >& _xContent)
 461 {
 462     GetControlHelper()->showPreview(_xContent);
 463 }
 464
 465 void OApplicationDetailView::showPreview(   const OUString& _sDataSourceName,
 466                                             const OUString& _sName,
 467                                             bool _bTable)
 468 {
 469     GetControlHelper()->showPreview(_sDataSourceName,_sName,_bTable);
 470 }
 471
 472 bool OApplicationDetailView::isSortUp() const
 473 {
 474     return GetControlHelper()->isSortUp();
 475 }
 476
 477 TreeListBox* OApplicationDetailView::getTreeWindow() const
 478 {
 479     DBTreeViewBase* pCurrent = GetControlHelper()->getCurrentView();
 480     if (!pCurrent)
 481         return nullptr;
 482     return &pCurrent->getListBox();
 483 }
 484
 485 OAppDetailPageHelper* OApplicationDetailView::GetControlHelper()
 486 {
 487     return static_cast<OAppDetailPageHelper*>(m_xControlHelper.get());
 488 }
 489
 490 const OAppDetailPageHelper* OApplicationDetailView::GetControlHelper() const
 491 {
 492     return static_cast<const OAppDetailPageHelper*>(m_xControlHelper.get());
 493 }
 494
 495 bool OApplicationDetailView::HasChildPathFocus() const
 496 {
 497     return m_xHorzSplitter->has_focus() ||
 498            m_xTasks->HasChildPathFocus() ||
 499            m_xTitleContainer->HasChildPathFocus();
 500 }
 501
 502 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */