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/propertyvalue.hxx>
  33 #include <comphelper/types.hxx>
  34 #include <svx/unoshape.hxx>
  35 #include <utility>
  36 #include <tools/diagnose_ex.h>
  37
  38 #include <functional>
  39 #include <string_view>
  40
  41 namespace rptui
  42 {
  43     using namespace ::com::sun::star;
  44     using namespace uno;
  45     using namespace lang;
  46     using namespace beans;
  47     using namespace awt;
  48     using namespace util;
  49     using namespace container;
  50     using namespace report;
  51
  52
  53 namespace
  54 {
  55     void lcl_collectElements(const uno::Reference< report::XSection >& _xSection,::std::vector< uno::Reference< drawing::XShape> >& _rControls)
  56     {
  57         if ( _xSection.is() )
  58         {
  59             sal_Int32 nCount = _xSection->getCount();
  60             _rControls.reserve(nCount);
  61             while ( nCount )
  62             {
  63                 uno::Reference< drawing::XShape> xShape(_xSection->getByIndex(nCount-1),uno::UNO_QUERY);
  64                 _rControls.push_back(xShape);
  65                 _xSection->remove(xShape);
  66                 --nCount;
  67             }
  68         }
  69     }
  70
  71     void lcl_insertElements(const uno::Reference< report::XSection >& _xSection,const ::std::vector< uno::Reference< drawing::XShape> >& _aControls)
  72     {
  73         if ( !_xSection.is() )
  74             return;
  75
  76         ::std::vector< uno::Reference< drawing::XShape> >::const_reverse_iterator aIter = _aControls.rbegin();
  77         ::std::vector< uno::Reference< drawing::XShape> >::const_reverse_iterator aEnd = _aControls.rend();
  78         for (; aIter != aEnd; ++aIter)
  79         {
  80             try
  81             {
  82                 const awt::Point aPos = (*aIter)->getPosition();
  83                 const awt::Size aSize = (*aIter)->getSize();
  84                 _xSection->add(*aIter);
  85                 (*aIter)->setPosition( aPos );
  86                 (*aIter)->setSize( aSize );
  87             }
  88             catch(const uno::Exception&)
  89             {
  90                 TOOLS_WARN_EXCEPTION( "reportdesign", "lcl_insertElements");
  91             }
  92         }
  93     }
  94
  95     void lcl_setValues(const uno::Reference< report::XSection >& _xSection,const ::std::vector< ::std::pair< OUString ,uno::Any> >& _aValues)
  96     {
  97         if ( !_xSection.is() )
  98             return;
  99
 100         for (const auto& [rPropName, rValue] : _aValues)
 101         {
 102             try
 103             {
 104                 _xSection->setPropertyValue(rPropName, rValue);
 105             }
 106             catch(const uno::Exception&)
 107             {
 108                 TOOLS_WARN_EXCEPTION( "reportdesign", "lcl_setValues");
 109             }
 110         }
 111     }
 112 }
 113
 114
 115 OSectionUndo::OSectionUndo(OReportModel& _rMod
 116                            ,sal_uInt16 _nSlot
 117                            ,Action _eAction
 118                            ,TranslateId pCommentID)
 119 : OCommentUndoAction(_rMod,pCommentID)
 120 ,m_eAction(_eAction)
 121 ,m_nSlot(_nSlot)
 122 ,m_bInserted(false)
 123 {
 124 }
 125
 126 OSectionUndo::~OSectionUndo()
 127 {
 128     if ( m_bInserted )
 129         return;
 130
 131     OXUndoEnvironment& rEnv = static_cast< OReportModel& >( rMod ).GetUndoEnv();
 132     for (uno::Reference<drawing::XShape>& xShape : m_aControls)
 133     {
 134         rEnv.RemoveElement(xShape);
 135
 136 #if OSL_DEBUG_LEVEL > 0
 137         SvxShape* pShape = comphelper::getFromUnoTunnel<SvxShape>( xShape );
 138         SdrObject* pObject = pShape ? pShape->GetSdrObject() : nullptr;
 139         OSL_ENSURE( pShape && pShape->HasSdrObjectOwnership() && pObject && !pObject->IsInserted(),
 140             "OSectionUndo::~OSectionUndo: inconsistency in the shape/object ownership!" );
 141 #endif
 142         try
 143         {
 144             comphelper::disposeComponent(xShape);
 145         }
 146         catch(const uno::Exception &)
 147         {
 148             TOOLS_WARN_EXCEPTION( "reportdesign", "");
 149         }
 150     }
 151 }
 152
 153 void OSectionUndo::collectControls(const uno::Reference< report::XSection >& _xSection)
 154 {
 155     m_aControls.clear();
 156     try
 157     {
 158         // copy all properties for restoring
 159         uno::Reference< beans::XPropertySetInfo> xInfo = _xSection->getPropertySetInfo();
 160         const uno::Sequence< beans::Property> aSeq = xInfo->getProperties();
 161         for(const beans::Property& rProp : aSeq)
 162         {
 163             if ( 0 == (rProp.Attributes & beans::PropertyAttribute::READONLY) )
 164                 m_aValues.emplace_back(rProp.Name,_xSection->getPropertyValue(rProp.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         TOOLS_WARN_EXCEPTION( "reportdesign", "OSectionUndo::Undo" );
 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         TOOLS_WARN_EXCEPTION( "reportdesign", "OSectionUndo::Redo" );
 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, {})
 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, TranslateId 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     const OUString aHeaderFooterOnName(SID_GROUPHEADER_WITHOUT_UNDO == m_nSlot? std::u16string_view(u"" PROPERTY_HEADERON) : std::u16string_view(u"" PROPERTY_FOOTERON));
 288     uno::Sequence< beans::PropertyValue > aArgs{
 289         comphelper::makePropertyValue(aHeaderFooterOnName, true),
 290         comphelper::makePropertyValue(PROPERTY_GROUP, m_aGroupHelper.getGroup())
 291     };
 292     m_pController->executeChecked(m_nSlot,aArgs);
 293
 294     uno::Reference< report::XSection > xSection = m_pMemberFunction(&m_aGroupHelper);
 295     lcl_insertElements(xSection,m_aControls);
 296     lcl_setValues(xSection,m_aValues);
 297     m_bInserted = true;
 298 }
 299
 300 void OGroupSectionUndo::implReRemove( )
 301 {
 302     if( m_eAction == Removed )
 303         collectControls(m_pMemberFunction(&m_aGroupHelper));
 304
 305     const OUString aHeaderFooterOnName(SID_GROUPHEADER_WITHOUT_UNDO == m_nSlot? std::u16string_view(u"" PROPERTY_HEADERON) : std::u16string_view(u"" PROPERTY_FOOTERON));
 306     uno::Sequence< beans::PropertyValue > aArgs{
 307         comphelper::makePropertyValue(aHeaderFooterOnName, false),
 308         comphelper::makePropertyValue(PROPERTY_GROUP, m_aGroupHelper.getGroup())
 309     };
 310
 311     m_pController->executeChecked(m_nSlot,aArgs);
 312     m_bInserted = false;
 313 }
 314
 315
 316 OGroupUndo::OGroupUndo(OReportModel& _rMod
 317                        ,TranslateId pCommentID
 318                        ,Action  _eAction
 319                        ,const uno::Reference< report::XGroup>& _xGroup
 320                        ,const uno::Reference< report::XReportDefinition >& _xReportDefinition)
 321 : OCommentUndoAction(_rMod,pCommentID)
 322 ,m_xGroup(_xGroup)
 323 ,m_xReportDefinition(_xReportDefinition)
 324 ,m_eAction(_eAction)
 325 {
 326     m_nLastPosition = getPositionInIndexAccess(m_xReportDefinition->getGroups(),m_xGroup);
 327 }
 328
 329 void OGroupUndo::implReInsert( )
 330 {
 331     try
 332     {
 333         m_xReportDefinition->getGroups()->insertByIndex(m_nLastPosition,uno::makeAny(m_xGroup));
 334     }
 335     catch(uno::Exception&)
 336     {
 337         TOOLS_WARN_EXCEPTION( "reportdesign", "Exception caught while undoing remove group");
 338     }
 339 }
 340
 341 void OGroupUndo::implReRemove( )
 342 {
 343     try
 344     {
 345         m_xReportDefinition->getGroups()->removeByIndex(m_nLastPosition);
 346     }
 347     catch(uno::Exception&)
 348     {
 349         TOOLS_WARN_EXCEPTION( "reportdesign", "Exception caught while redoing remove group");
 350     }
 351 }
 352
 353 void OGroupUndo::Undo()
 354 {
 355     switch ( m_eAction )
 356     {
 357     case Inserted:
 358         implReRemove();
 359         break;
 360
 361     case Removed:
 362         implReInsert();
 363         break;
 364     }
 365
 366 }
 367
 368 void OGroupUndo::Redo()
 369 {
 370     switch ( m_eAction )
 371     {
 372     case Inserted:
 373         implReInsert();
 374         break;
 375
 376     case Removed:
 377         implReRemove();
 378         break;
 379     }
 380 }
 381
 382
 383 } // rptui
 384
 385
 386 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */