reportdesign/source/ui/misc/RptUndo.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 <RptUndo.hxx>
  21 #include <strings.hxx>
  22 #include <rptui_slotid.hrc>
  23 #include <UITools.hxx>
  24 #include <UndoEnv.hxx>
  25
  26 #include <dbaccess/IController.hxx>
  27 #include <com/sun/star/report/XSection.hpp>
  28 #include <com/sun/star/beans/PropertyAttribute.hpp>
  29
  30 #include <com/sun/star/awt/Point.hpp>
  31 #include <com/sun/star/awt/Size.hpp>
  32 #include <comphelper/types.hxx>
  33 #include <svx/unoshape.hxx>
  34 #include <utility>
  35 #include <vcl/settings.hxx>
  36
  37 #include <functional>
  38
  39 namespace rptui
  40 {
  41     using namespace ::com::sun::star;
  42     using namespace uno;
  43     using namespace lang;
  44     using namespace beans;
  45     using namespace awt;
  46     using namespace util;
  47     using namespace container;
  48     using namespace report;
  49
  50
  51 namespace
  52 {
  53     void lcl_collectElements(const uno::Reference< report::XSection >& _xSection,::std::vector< uno::Reference< drawing::XShape> >& _rControls)
  54     {
  55         if ( _xSection.is() )
  56         {
  57             sal_Int32 nCount = _xSection->getCount();
  58             _rControls.reserve(nCount);
  59             while ( nCount )
  60             {
  61                 uno::Reference< drawing::XShape> xShape(_xSection->getByIndex(nCount-1),uno::UNO_QUERY);
  62                 _rControls.push_back(xShape);
  63                 _xSection->remove(xShape);
  64                 --nCount;
  65             }
  66         }
  67     }
  68
  69     void lcl_insertElements(const uno::Reference< report::XSection >& _xSection,const ::std::vector< uno::Reference< drawing::XShape> >& _aControls)
  70     {
  71         if ( _xSection.is() )
  72         {
  73             ::std::vector< uno::Reference< drawing::XShape> >::const_reverse_iterator aIter = _aControls.rbegin();
  74             ::std::vector< uno::Reference< drawing::XShape> >::const_reverse_iterator aEnd = _aControls.rend();
  75             for (; aIter != aEnd; ++aIter)
  76             {
  77                 try
  78                 {
  79                     const awt::Point aPos = (*aIter)->getPosition();
  80                     const awt::Size aSize = (*aIter)->getSize();
  81                     _xSection->add(*aIter);
  82                     (*aIter)->setPosition( aPos );
  83                     (*aIter)->setSize( aSize );
  84                 }
  85                 catch(const uno::Exception&)
  86                 {
  87                     OSL_FAIL("lcl_insertElements:Exception caught!");
  88                 }
  89             }
  90         }
  91     }
  92
  93     void lcl_setValues(const uno::Reference< report::XSection >& _xSection,const ::std::vector< ::std::pair< OUString ,uno::Any> >& _aValues)
  94     {
  95         if ( _xSection.is() )
  96         {
  97             for (const auto& [rPropName, rValue] : _aValues)
  98             {
  99                 try
 100                 {
 101                     _xSection->setPropertyValue(rPropName, rValue);
 102                 }
 103                 catch(const uno::Exception&)
 104                 {
 105                     OSL_FAIL("lcl_setValues:Exception caught!");
 106                 }
 107             }
 108         }
 109     }
 110 }
 111
 112
 113 OSectionUndo::OSectionUndo(OReportModel& _rMod
 114                            ,sal_uInt16 _nSlot
 115                            ,Action _eAction
 116                            ,const char* pCommentID)
 117 : OCommentUndoAction(_rMod,pCommentID)
 118 ,m_eAction(_eAction)
 119 ,m_nSlot(_nSlot)
 120 ,m_bInserted(false)
 121 {
 122 }
 123
 124 OSectionUndo::~OSectionUndo()
 125 {
 126     if ( !m_bInserted )
 127     {
 128         OXUndoEnvironment& rEnv = static_cast< OReportModel& >( rMod ).GetUndoEnv();
 129         for (uno::Reference<drawing::XShape>& xShape : m_aControls)
 130         {
 131             rEnv.RemoveElement(xShape);
 132
 133 #if OSL_DEBUG_LEVEL > 0
 134             SvxShape* pShape = SvxShape::getImplementation( xShape );
 135             SdrObject* pObject = pShape ? pShape->GetSdrObject() : nullptr;
 136             OSL_ENSURE( pShape && pShape->HasSdrObjectOwnership() && pObject && !pObject->IsInserted(),
 137                 "OSectionUndo::~OSectionUndo: inconsistency in the shape/object ownership!" );
 138 #endif
 139             try
 140             {
 141                 comphelper::disposeComponent(xShape);
 142             }
 143             catch(const uno::Exception &)
 144             {
 145                 OSL_FAIL("Exception caught!");
 146             }
 147         }
 148     }
 149 }
 150
 151 void OSectionUndo::collectControls(const uno::Reference< report::XSection >& _xSection)
 152 {
 153     m_aControls.clear();
 154     try
 155     {
 156         // copy all properties for restoring
 157         uno::Reference< beans::XPropertySetInfo> xInfo = _xSection->getPropertySetInfo();
 158         uno::Sequence< beans::Property> aSeq = xInfo->getProperties();
 159         const beans::Property* pIter = aSeq.getConstArray();
 160         const beans::Property* pEnd  = pIter + aSeq.getLength();
 161         for(;pIter != pEnd;++pIter)
 162         {
 163             if ( 0 == (pIter->Attributes & beans::PropertyAttribute::READONLY) )
 164                 m_aValues.emplace_back(pIter->Name,_xSection->getPropertyValue(pIter->Name));
 165         }
 166         lcl_collectElements(_xSection,m_aControls);
 167     }
 168     catch(uno::Exception&)
 169     {
 170     }
 171 }
 172
 173 void OSectionUndo::Undo()
 174 {
 175     try
 176     {
 177         switch ( m_eAction )
 178         {
 179         case Inserted:
 180             implReRemove();
 181             break;
 182
 183         case Removed:
 184             implReInsert();
 185             break;
 186         }
 187     }
 188     catch( const Exception& )
 189     {
 190         OSL_FAIL( "OSectionUndo::Undo: caught an exception!" );
 191     }
 192 }
 193
 194 void OSectionUndo::Redo()
 195 {
 196     try
 197     {
 198         switch ( m_eAction )
 199         {
 200         case Inserted:
 201             implReInsert();
 202             break;
 203
 204         case Removed:
 205             implReRemove();
 206             break;
 207         }
 208     }
 209     catch( const Exception& )
 210     {
 211         OSL_FAIL( "OSectionUndo::Redo: caught an exception!" );
 212     }
 213 }
 214
 215 OReportSectionUndo::OReportSectionUndo(
 216     OReportModel& _rMod, sal_uInt16 _nSlot,
 217     ::std::function<uno::Reference<report::XSection>(OReportHelper*)> _pMemberFunction,
 218     const uno::Reference<report::XReportDefinition>& _xReport, Action _eAction)
 219     : OSectionUndo(_rMod, _nSlot, _eAction, nullptr)
 220     , m_aReportHelper(_xReport)
 221     , m_pMemberFunction(std::move(_pMemberFunction))
 222 {
 223     if( m_eAction == Removed )
 224         collectControls(m_pMemberFunction(&m_aReportHelper));
 225 }
 226
 227 OReportSectionUndo::~OReportSectionUndo()
 228 {
 229 }
 230
 231 void OReportSectionUndo::implReInsert( )
 232 {
 233     const uno::Sequence< beans::PropertyValue > aArgs;
 234     m_pController->executeChecked(m_nSlot,aArgs);
 235     uno::Reference< report::XSection > xSection = m_pMemberFunction(&m_aReportHelper);
 236     lcl_insertElements(xSection,m_aControls);
 237     lcl_setValues(xSection,m_aValues);
 238     m_bInserted = true;
 239 }
 240
 241 void OReportSectionUndo::implReRemove( )
 242 {
 243     if( m_eAction == Removed )
 244         collectControls(m_pMemberFunction(&m_aReportHelper));
 245     const uno::Sequence< beans::PropertyValue > aArgs;
 246     m_pController->executeChecked(m_nSlot,aArgs);
 247     m_bInserted = false;
 248 }
 249
 250 OGroupSectionUndo::OGroupSectionUndo(
 251     OReportModel& _rMod, sal_uInt16 _nSlot,
 252     ::std::function<uno::Reference<report::XSection>(OGroupHelper*)> _pMemberFunction,
 253     const uno::Reference<report::XGroup>& _xGroup, Action _eAction, const char* pCommentID)
 254     : OSectionUndo(_rMod, _nSlot, _eAction, pCommentID)
 255     , m_aGroupHelper(_xGroup)
 256     , m_pMemberFunction(std::move(_pMemberFunction))
 257 {
 258     if( m_eAction == Removed )
 259     {
 260         uno::Reference< report::XSection > xSection = m_pMemberFunction(&m_aGroupHelper);
 261         if ( xSection.is() )
 262             m_sName = xSection->getName();
 263         collectControls(xSection);
 264     }
 265 }
 266
 267 OUString OGroupSectionUndo::GetComment() const
 268 {
 269     if ( m_sName.isEmpty() )
 270     {
 271         try
 272         {
 273             uno::Reference< report::XSection > xSection = const_cast<OGroupSectionUndo*>(this)->m_pMemberFunction(&const_cast<OGroupSectionUndo*>(this)->m_aGroupHelper);
 274
 275             if ( xSection.is() )
 276                 m_sName = xSection->getName();
 277         }
 278         catch (const uno::Exception&)
 279         {
 280         }
 281     }
 282     return m_strComment + m_sName;
 283 }
 284
 285 void OGroupSectionUndo::implReInsert( )
 286 {
 287     uno::Sequence< beans::PropertyValue > aArgs(2);
 288
 289     aArgs[0].Name = SID_GROUPHEADER_WITHOUT_UNDO == m_nSlot? OUString(PROPERTY_HEADERON) : OUString(PROPERTY_FOOTERON);
 290     aArgs[0].Value <<= true;
 291     aArgs[1].Name = PROPERTY_GROUP;
 292     aArgs[1].Value <<= m_aGroupHelper.getGroup();
 293     m_pController->executeChecked(m_nSlot,aArgs);
 294
 295     uno::Reference< report::XSection > xSection = m_pMemberFunction(&m_aGroupHelper);
 296     lcl_insertElements(xSection,m_aControls);
 297     lcl_setValues(xSection,m_aValues);
 298     m_bInserted = true;
 299 }
 300
 301 void OGroupSectionUndo::implReRemove( )
 302 {
 303     if( m_eAction == Removed )
 304         collectControls(m_pMemberFunction(&m_aGroupHelper));
 305
 306     uno::Sequence< beans::PropertyValue > aArgs(2);
 307
 308     aArgs[0].Name = SID_GROUPHEADER_WITHOUT_UNDO == m_nSlot? OUString(PROPERTY_HEADERON) : OUString(PROPERTY_FOOTERON);
 309     aArgs[0].Value <<= false;
 310     aArgs[1].Name = PROPERTY_GROUP;
 311     aArgs[1].Value <<= m_aGroupHelper.getGroup();
 312
 313     m_pController->executeChecked(m_nSlot,aArgs);
 314     m_bInserted = false;
 315 }
 316
 317
 318 OGroupUndo::OGroupUndo(OReportModel& _rMod
 319                        ,const char* pCommentID
 320                        ,Action  _eAction
 321                        ,const uno::Reference< report::XGroup>& _xGroup
 322                        ,const uno::Reference< report::XReportDefinition >& _xReportDefinition)
 323 : OCommentUndoAction(_rMod,pCommentID)
 324 ,m_xGroup(_xGroup)
 325 ,m_xReportDefinition(_xReportDefinition)
 326 ,m_eAction(_eAction)
 327 {
 328     m_nLastPosition = getPositionInIndexAccess(m_xReportDefinition->getGroups().get(),m_xGroup);
 329 }
 330
 331 void OGroupUndo::implReInsert( )
 332 {
 333     try
 334     {
 335         m_xReportDefinition->getGroups()->insertByIndex(m_nLastPosition,uno::makeAny(m_xGroup));
 336     }
 337     catch(uno::Exception&)
 338     {
 339         OSL_FAIL("Exception caught while undoing remove group");
 340     }
 341 }
 342
 343 void OGroupUndo::implReRemove( )
 344 {
 345     try
 346     {
 347         m_xReportDefinition->getGroups()->removeByIndex(m_nLastPosition);
 348     }
 349     catch(uno::Exception&)
 350     {
 351         OSL_FAIL("Exception caught while redoing remove group");
 352     }
 353 }
 354
 355 void OGroupUndo::Undo()
 356 {
 357     switch ( m_eAction )
 358     {
 359     case Inserted:
 360         implReRemove();
 361         break;
 362
 363     case Removed:
 364         implReInsert();
 365         break;
 366     }
 367
 368 }
 369
 370 void OGroupUndo::Redo()
 371 {
 372     switch ( m_eAction )
 373     {
 374     case Inserted:
 375         implReInsert();
 376         break;
 377
 378     case Removed:
 379         implReRemove();
 380         break;
 381     }
 382 }
 383
 384
 385 } // rptui
 386
 387
 388 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */