reportdesign/source/ui/report/propbrw.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 #include <memory>
  20 #include <propbrw.hxx>
  21 #include <RptObject.hxx>
  22 #include <ReportController.hxx>
  23 #include <cppuhelper/component_context.hxx>
  24 #include <strings.hrc>
  25 #include <rptui_slotid.hrc>
  26 #include <tools/debug.hxx>
  27 #include <tools/diagnose_ex.h>
  28 #include <com/sun/star/awt/XLayoutConstrains.hpp>
  29 #include <com/sun/star/awt/PosSize.hpp>
  30 #include <com/sun/star/beans/PropertyValue.hpp>
  31 #include <com/sun/star/frame/Frame.hpp>
  32 #include <com/sun/star/inspection/ObjectInspector.hpp>
  33 #include <com/sun/star/inspection/DefaultHelpProvider.hpp>
  34 #include <com/sun/star/lang/XServiceInfo.hpp>
  35 #include <com/sun/star/report/inspection/DefaultComponentInspectorModel.hpp>
  36 #include <svx/svxids.hrc>
  37 #include <vcl/stdtext.hxx>
  38 #include <vcl/weld.hxx>
  39 #include <svx/svdview.hxx>
  40 #include <svx/svdogrp.hxx>
  41 #include <svx/svdpage.hxx>
  42 #include <svx/svditer.hxx>
  43
  44 #include <toolkit/helper/vclunohelper.hxx>
  45 #include <comphelper/namecontainer.hxx>
  46 #include <comphelper/types.hxx>
  47 #include <comphelper/sequence.hxx>
  48 #include <core_resource.hxx>
  49 #include <SectionView.hxx>
  50 #include <ReportSection.hxx>
  51 #include <strings.hxx>
  52 #include <DesignView.hxx>
  53 #include <ViewsWindow.hxx>
  54 #include <UITools.hxx>
  55 #include <unotools/confignode.hxx>
  56
  57 namespace rptui
  58 {
  59 #define STD_WIN_SIZE_X  300
  60 #define STD_WIN_SIZE_Y  350
  61
  62 using namespace ::com::sun::star;
  63 using namespace uno;
  64 using namespace lang;
  65 using namespace frame;
  66 using namespace beans;
  67 using namespace container;
  68 using namespace ::comphelper;
  69
  70
  71 namespace
  72 {
  73     bool lcl_shouldEnableHelpSection( const Reference< XComponentContext >& _rxContext )
  74     {
  75         ::utl::OConfigurationTreeRoot aConfiguration(
  76             ::utl::OConfigurationTreeRoot::createWithComponentContext(
  77                 _rxContext, "/org.openoffice.Office.ReportDesign/PropertyBrowser/" ) );
  78
  79         bool bEnabled = false;
  80         OSL_VERIFY( aConfiguration.getNodeValue( "DirectHelp"  ) >>= bEnabled );
  81         return bEnabled;
  82     }
  83 }
  84
  85
  86 // PropBrw
  87
  88
  89 PropBrw::PropBrw(const Reference< XComponentContext >& _xORB, vcl::Window* pParent, ODesignView*  _pDesignView)
  90           :DockingWindow(pParent,WinBits(WB_STDMODELESS|WB_SIZEABLE|WB_3DLOOK|WB_ROLLABLE))
  91           ,m_xORB(_xORB)
  92           ,m_pDesignView(_pDesignView)
  93           ,m_pView( nullptr )
  94           ,m_bInitialStateChange(true)
  95 {
  96
  97     Size aPropWinSize(STD_WIN_SIZE_X,STD_WIN_SIZE_Y);
  98     SetOutputSizePixel(aPropWinSize);
  99
 100     try
 101     {
 102         // create a frame wrapper for myself
 103         m_xMeAsFrame = Frame::create( m_xORB );
 104         m_xMeAsFrame->initialize( VCLUnoHelper::GetInterface ( this ) );
 105         m_xMeAsFrame->setName("report property browser");  // change name!
 106     }
 107     catch (Exception&)
 108     {
 109         DBG_UNHANDLED_EXCEPTION("reportdesign");
 110         OSL_FAIL("PropBrw::PropBrw: could not create/initialize my frame!");
 111         m_xMeAsFrame.clear();
 112     }
 113
 114     if (m_xMeAsFrame.is())
 115     {
 116         try
 117         {
 118             ::cppu::ContextEntry_Init aHandlerContextInfo[] =
 119             {
 120                 ::cppu::ContextEntry_Init( "ContextDocument", makeAny( m_pDesignView->getController().getModel() )),
 121                 ::cppu::ContextEntry_Init( "DialogParentWindow", makeAny( VCLUnoHelper::GetInterface ( this ) )),
 122                 ::cppu::ContextEntry_Init( "ActiveConnection", makeAny( m_pDesignView->getController().getConnection() ) ),
 123             };
 124             m_xInspectorContext.set(
 125                 ::cppu::createComponentContext( aHandlerContextInfo, SAL_N_ELEMENTS( aHandlerContextInfo ),
 126                 m_xORB ) );
 127             // create a property browser controller
 128             bool bEnableHelpSection = lcl_shouldEnableHelpSection( m_xORB );
 129             Reference< inspection::XObjectInspectorModel> xInspectorModel( bEnableHelpSection
 130                 ?   report::inspection::DefaultComponentInspectorModel::createWithHelpSection( m_xInspectorContext, 3, 8 )
 131                 :   report::inspection::DefaultComponentInspectorModel::createDefault( m_xInspectorContext ) );
 132
 133             m_xBrowserController = inspection::ObjectInspector::createWithModel(m_xInspectorContext, xInspectorModel);
 134             if ( !m_xBrowserController.is() )
 135             {
 136                 const OUString sServiceName( "com.sun.star.inspection.ObjectInspector" );
 137                 ShowServiceNotAvailableError(pParent ? pParent->GetFrameWeld() : nullptr, sServiceName, true);
 138             }
 139             else
 140             {
 141                 m_xBrowserController->attachFrame( Reference<XFrame>(m_xMeAsFrame, UNO_QUERY_THROW));
 142                 m_xBrowserComponentWindow = m_xMeAsFrame->getComponentWindow();
 143                 OSL_ENSURE(m_xBrowserComponentWindow.is(), "PropBrw::PropBrw: attached the controller, but have no component window!");
 144                 if ( bEnableHelpSection )
 145                 {
 146                     uno::Reference< inspection::XObjectInspector > xInspector( m_xBrowserController, uno::UNO_SET_THROW );
 147                     uno::Reference< inspection::XObjectInspectorUI > xInspectorUI( xInspector->getInspectorUI() );
 148                     uno::Reference< uno::XInterface > xDefaultHelpProvider( inspection::DefaultHelpProvider::create( m_xInspectorContext, xInspectorUI ) );
 149                 }
 150             }
 151         }
 152         catch (Exception&)
 153         {
 154             DBG_UNHANDLED_EXCEPTION("reportdesign");
 155             OSL_FAIL("PropBrw::PropBrw: could not create/initialize the browser controller!");
 156             try
 157             {
 158                 ::comphelper::disposeComponent(m_xBrowserController);
 159                 ::comphelper::disposeComponent(m_xBrowserComponentWindow);
 160             }
 161             catch(Exception&) { }
 162             m_xBrowserController.clear();
 163             m_xBrowserComponentWindow.clear();
 164         }
 165     }
 166
 167     if (m_xBrowserComponentWindow.is())
 168     {
 169
 170         m_xBrowserComponentWindow->setPosSize(0, 0, aPropWinSize.Width(), aPropWinSize.Height(),
 171             awt::PosSize::WIDTH | awt::PosSize::HEIGHT | awt::PosSize::X | awt::PosSize::Y);
 172         Resize();
 173         m_xBrowserComponentWindow->setVisible(true);
 174     }
 175     ::rptui::notifySystemWindow(pParent,this,::comphelper::mem_fun(&TaskPaneList::AddWindow));
 176 }
 177
 178
 179 PropBrw::~PropBrw()
 180 {
 181     disposeOnce();
 182 }
 183
 184 void PropBrw::dispose()
 185 {
 186     if (m_xBrowserController.is())
 187         implDetachController();
 188
 189     try
 190     {
 191         uno::Reference<container::XNameContainer> xName(m_xInspectorContext,uno::UNO_QUERY);
 192         if ( xName.is() )
 193         {
 194             const OUString pProps[] = { OUString( "ContextDocument" )
 195                                             ,  OUString( "DialogParentWindow" )
 196                                             , OUString( "ActiveConnection" )};
 197             for (const auto & i : pProps)
 198                 xName->removeByName(i);
 199         }
 200     }
 201     catch(Exception&)
 202     {}
 203
 204     ::rptui::notifySystemWindow(this,this,::comphelper::mem_fun(&TaskPaneList::RemoveWindow));
 205     m_pDesignView.clear();
 206     DockingWindow::dispose();
 207 }
 208
 209 void PropBrw::setCurrentPage(const OUString& _sLastActivePage)
 210 {
 211     m_sLastActivePage = _sLastActivePage;
 212 }
 213
 214
 215 void PropBrw::implDetachController()
 216 {
 217     m_sLastActivePage = getCurrentPage();
 218     implSetNewObject(  );
 219
 220     if ( m_xMeAsFrame.is() )
 221         m_xMeAsFrame->setComponent( nullptr, nullptr );
 222
 223     if ( m_xBrowserController.is() )
 224         m_xBrowserController->attachFrame( nullptr );
 225
 226     m_xMeAsFrame.clear();
 227     m_xBrowserController.clear();
 228     m_xBrowserComponentWindow.clear();
 229 }
 230
 231 OUString PropBrw::getCurrentPage() const
 232 {
 233     OUString sCurrentPage;
 234     try
 235     {
 236         if ( m_xBrowserController.is() )
 237         {
 238             OSL_VERIFY( m_xBrowserController->getViewData() >>= sCurrentPage );
 239         }
 240
 241         if ( sCurrentPage.isEmpty() )
 242             sCurrentPage = m_sLastActivePage;
 243     }
 244     catch( const Exception& )
 245     {
 246         OSL_FAIL( "PropBrw::getCurrentPage: caught an exception while retrieving the current page!" );
 247     }
 248     return sCurrentPage;
 249 }
 250
 251
 252 bool PropBrw::Close()
 253 {
 254     m_xLastSection.clear();
 255     // suspend the controller (it is allowed to veto)
 256     if ( m_xMeAsFrame.is() )
 257     {
 258         try
 259         {
 260             Reference< XController > xController( m_xMeAsFrame->getController() );
 261             if ( xController.is() && !xController->suspend( true ) )
 262                 return false;
 263         }
 264         catch( const Exception& )
 265         {
 266             OSL_FAIL( "FmPropBrw::Close: caught an exception while asking the controller!" );
 267         }
 268     }
 269     implDetachController();
 270
 271     if( IsRollUp() )
 272         RollDown();
 273
 274     m_pDesignView->getController().executeUnChecked(SID_PROPERTYBROWSER_LAST_PAGE,uno::Sequence< beans::PropertyValue>());
 275
 276     return true;
 277 }
 278
 279
 280 uno::Sequence< Reference<uno::XInterface> > PropBrw::CreateCompPropSet(const SdrMarkList& _rMarkList)
 281 {
 282     const size_t nMarkCount = _rMarkList.GetMarkCount();
 283     ::std::vector< uno::Reference< uno::XInterface> > aSets;
 284     aSets.reserve(nMarkCount);
 285
 286     for(size_t i=0; i<nMarkCount; ++i)
 287     {
 288         SdrObject* pCurrent = _rMarkList.GetMark(i)->GetMarkedSdrObj();
 289
 290         ::std::unique_ptr<SdrObjListIter> pGroupIterator;
 291         if (pCurrent->IsGroupObject())
 292         {
 293             pGroupIterator.reset(new SdrObjListIter(pCurrent->GetSubList()));
 294             pCurrent = pGroupIterator->IsMore() ? pGroupIterator->Next() : nullptr;
 295         }
 296
 297         while (pCurrent)
 298         {
 299             OObjectBase* pObj = dynamic_cast<OObjectBase*>(pCurrent);
 300             if ( pObj )
 301                 aSets.push_back(CreateComponentPair(pObj));
 302
 303             // next element
 304             pCurrent = pGroupIterator.get() && pGroupIterator->IsMore() ? pGroupIterator->Next() : nullptr;
 305         }
 306     }
 307     return uno::Sequence< Reference<uno::XInterface> >(aSets.data(), aSets.size());
 308 }
 309
 310 void PropBrw::implSetNewObject( const uno::Sequence< Reference<uno::XInterface> >& _aObjects )
 311 {
 312     if ( m_xBrowserController.is() )
 313     {
 314         try
 315         {
 316             m_xBrowserController->inspect(uno::Sequence< Reference<uno::XInterface> >());
 317             m_xBrowserController->inspect(_aObjects);
 318         }
 319         catch( const Exception& )
 320         {
 321             OSL_FAIL( "FmPropBrw::StateChanged: caught an exception while setting the initial page!" );
 322         }
 323     }
 324     SetText( GetHeadlineName(_aObjects) );
 325 }
 326
 327
 328 OUString PropBrw::GetHeadlineName( const uno::Sequence< Reference<uno::XInterface> >& _aObjects )
 329 {
 330     OUString aName;
 331     if ( !_aObjects.hasElements() )
 332     {
 333         aName = RptResId(RID_STR_BRWTITLE_NO_PROPERTIES);
 334     }
 335     else if ( _aObjects.getLength() == 1 )    // single selection
 336     {
 337         aName = RptResId(RID_STR_BRWTITLE_PROPERTIES);
 338
 339         uno::Reference< container::XNameContainer > xNameCont(_aObjects[0],uno::UNO_QUERY);
 340         Reference< lang::XServiceInfo > xServiceInfo( xNameCont->getByName("ReportComponent"), UNO_QUERY );
 341         if ( xServiceInfo.is() )
 342         {
 343             const char* pResId;
 344             if ( xServiceInfo->supportsService( SERVICE_FIXEDTEXT ) )
 345             {
 346                 pResId = RID_STR_PROPTITLE_FIXEDTEXT;
 347             }
 348             else if ( xServiceInfo->supportsService( SERVICE_IMAGECONTROL ) )
 349             {
 350                 pResId = RID_STR_PROPTITLE_IMAGECONTROL;
 351             }
 352             else if ( xServiceInfo->supportsService( SERVICE_FORMATTEDFIELD ) )
 353             {
 354                 pResId = RID_STR_PROPTITLE_FORMATTED;
 355             }
 356             else if ( xServiceInfo->supportsService( SERVICE_SHAPE ) )
 357             {
 358                 pResId = RID_STR_PROPTITLE_SHAPE;
 359             }
 360             else if ( xServiceInfo->supportsService( SERVICE_REPORTDEFINITION ) )
 361             {
 362                 pResId = RID_STR_PROPTITLE_REPORT;
 363             }
 364             else if ( xServiceInfo->supportsService( SERVICE_SECTION ) )
 365             {
 366                 pResId = RID_STR_PROPTITLE_SECTION;
 367             }
 368             else if ( xServiceInfo->supportsService( SERVICE_FUNCTION ) )
 369             {
 370                 pResId = RID_STR_PROPTITLE_FUNCTION;
 371             }
 372             else if ( xServiceInfo->supportsService( SERVICE_GROUP ) )
 373             {
 374                 pResId = RID_STR_PROPTITLE_GROUP;
 375             }
 376             else if ( xServiceInfo->supportsService( SERVICE_FIXEDLINE ) )
 377             {
 378                 pResId = RID_STR_PROPTITLE_FIXEDLINE;
 379             }
 380             else
 381             {
 382                 OSL_FAIL("Unknown service name!");
 383                 aName += RID_STR_CLASS_FORMATTEDFIELD;
 384                 return aName;
 385             }
 386
 387             aName += RptResId(pResId);
 388         }
 389     }
 390     else    // multiselection
 391     {
 392         aName = RptResId(RID_STR_BRWTITLE_PROPERTIES);
 393         aName += RptResId(RID_STR_BRWTITLE_MULTISELECT);
 394     }
 395
 396     return aName;
 397 }
 398
 399 uno::Reference< uno::XInterface> PropBrw::CreateComponentPair(OObjectBase* _pObj)
 400 {
 401     _pObj->initializeOle();
 402     return CreateComponentPair(_pObj->getAwtComponent(),_pObj->getReportComponent());
 403 }
 404
 405 uno::Reference< uno::XInterface> PropBrw::CreateComponentPair(const uno::Reference< uno::XInterface>& _xFormComponent
 406                                                               ,const uno::Reference< uno::XInterface>& _xReportComponent)
 407 {
 408     uno::Reference< container::XNameContainer > xNameCont = ::comphelper::NameContainer_createInstance(cppu::UnoType<XInterface>::get());
 409     xNameCont->insertByName("FormComponent",uno::makeAny(_xFormComponent));
 410     xNameCont->insertByName("ReportComponent",uno::makeAny(_xReportComponent));
 411     xNameCont->insertByName("RowSet",uno::makeAny(uno::Reference< uno::XInterface>(m_pDesignView->getController().getRowSet())));
 412
 413     return xNameCont.get();
 414 }
 415
 416 ::Size PropBrw::getMinimumSize() const
 417 {
 418     ::Size aSize;
 419     Reference< awt::XLayoutConstrains > xLayoutConstrains( m_xBrowserController, UNO_QUERY );
 420     if( xLayoutConstrains.is() )
 421     {
 422         awt::Size aMinSize = xLayoutConstrains->getMinimumSize();
 423         aMinSize.Height += 4;
 424         aMinSize.Width += 4;
 425         aSize.setHeight( aMinSize.Height );
 426         aSize.setWidth( aMinSize.Width );
 427     }
 428     return aSize;
 429 }
 430
 431 void PropBrw::Resize()
 432 {
 433     Window::Resize();
 434
 435     Reference< awt::XLayoutConstrains > xLayoutConstrains( m_xBrowserController, UNO_QUERY );
 436     if( xLayoutConstrains.is() )
 437     {
 438         ::Size aMinSize = getMinimumSize();
 439         SetMinOutputSizePixel( aMinSize );
 440         ::Size aSize = GetOutputSizePixel();
 441         bool bResize = false;
 442         if( aSize.Width() < aMinSize.Width() )
 443         {
 444             aSize.setWidth( aMinSize.Width() );
 445             bResize = true;
 446         }
 447         if( aSize.Height() < aMinSize.Height() )
 448         {
 449             aSize.setHeight( aMinSize.Height() );
 450             bResize = true;
 451         }
 452         if( bResize )
 453             SetOutputSizePixel( aSize );
 454     }
 455     // adjust size
 456     if (m_xBrowserComponentWindow.is())
 457     {
 458         Size  aSize = GetOutputSizePixel();
 459         m_xBrowserComponentWindow->setPosSize(0, 0, aSize.Width(), aSize.Height(),
 460             awt::PosSize::WIDTH | awt::PosSize::HEIGHT);
 461     }
 462 }
 463
 464 void PropBrw::Update( OSectionView* pNewView )
 465 {
 466     try
 467     {
 468         if ( m_pView )
 469         {
 470             EndListening( *(m_pView->GetModel()) );
 471             m_pView = nullptr;
 472         }
 473
 474         // set focus on initialization
 475         if ( m_bInitialStateChange )
 476         {
 477             // if we're just newly created, we want to have the focus
 478             PostUserEvent( LINK( this, PropBrw, OnAsyncGetFocus ), nullptr, true );
 479             m_bInitialStateChange = false;
 480             // and additionally, we want to show the page which was active during
 481             // our previous incarnation
 482             if ( !m_sLastActivePage.isEmpty() && m_xBrowserController.is() )
 483             {
 484                 try
 485                 {
 486                     m_xBrowserController->restoreViewData( makeAny( m_sLastActivePage ) );
 487                 }
 488                 catch( const Exception& )
 489                 {
 490                     OSL_FAIL( "FmPropBrw::StateChanged: caught an exception while setting the initial page!" );
 491                 }
 492             }
 493         }
 494
 495         if ( !pNewView )
 496             return;
 497         else
 498             m_pView = pNewView;
 499
 500         uno::Sequence< Reference<uno::XInterface> > aMarkedObjects;
 501         OViewsWindow* pViews = m_pView->getReportSection()->getSectionWindow()->getViewsWindow();
 502         const sal_uInt16 nSectionCount = pViews->getSectionCount();
 503         for (sal_uInt16 i = 0; i < nSectionCount; ++i)
 504         {
 505             OSectionWindow* pSectionWindow = pViews->getSectionWindow(i);
 506             if ( pSectionWindow )
 507             {
 508                 const SdrMarkList& rMarkList = pSectionWindow->getReportSection().getSectionView().GetMarkedObjectList();
 509                 aMarkedObjects = ::comphelper::concatSequences(aMarkedObjects,CreateCompPropSet( rMarkList ));
 510             }
 511         }
 512
 513         if ( aMarkedObjects.hasElements() ) // multiple selection
 514         {
 515             m_xLastSection.clear();
 516             implSetNewObject( aMarkedObjects );
 517         }
 518         else if ( m_xLastSection != m_pView->getReportSection()->getSection() )
 519         {
 520             uno::Reference< uno::XInterface> xTemp(m_pView->getReportSection()->getSection());
 521             m_xLastSection = xTemp;
 522             uno::Reference< container::XNameContainer > xNameCont = ::comphelper::NameContainer_createInstance(cppu::UnoType<XInterface>::get() );
 523             xNameCont->insertByName("ReportComponent",uno::makeAny(xTemp));
 524             xTemp = xNameCont;
 525
 526             implSetNewObject( uno::Sequence< uno::Reference< uno::XInterface> >(&xTemp,1) );
 527         }
 528
 529         StartListening( *(m_pView->GetModel()) );
 530     }
 531     catch ( Exception& )
 532     {
 533         OSL_FAIL( "PropBrw::Update: Exception occurred!" );
 534     }
 535 }
 536
 537 void PropBrw::Update( const uno::Reference< uno::XInterface>& _xReportComponent)
 538 {
 539     if ( m_xLastSection != _xReportComponent )
 540     {
 541         m_xLastSection = _xReportComponent;
 542         try
 543         {
 544             if ( m_pView )
 545             {
 546                 EndListening( *(m_pView->GetModel()) );
 547                 m_pView = nullptr;
 548             }
 549
 550             uno::Reference< uno::XInterface> xTemp(CreateComponentPair(_xReportComponent,_xReportComponent));
 551             implSetNewObject( uno::Sequence< uno::Reference< uno::XInterface> >(&xTemp,1) );
 552         }
 553         catch ( Exception& )
 554         {
 555             OSL_FAIL( "PropBrw::Update: Exception occurred!" );
 556         }
 557     }
 558 }
 559
 560 IMPL_LINK_NOARG( PropBrw, OnAsyncGetFocus, void*, void )
 561 {
 562     if (m_xBrowserComponentWindow.is())
 563         m_xBrowserComponentWindow->setFocus();
 564 }
 565
 566 void PropBrw::LoseFocus()
 567 {
 568     DockingWindow::LoseFocus();
 569     if (m_pDesignView)
 570         m_pDesignView->getController().InvalidateAll();
 571 }
 572
 573 }
 574
 575 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */