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 <comphelper/diagnose_ex.hxx>
  37
  38 #include <functional>
  39
  40 namespace rptui
  41 {
  42     using namespace ::com::sun::star;
  43     using namespace uno;
  44     using namespace beans;
  45     using namespace awt;
  46     using namespace container;
  47     using namespace report;
  48
  49
  50 namespace
  51 {
  52     void lcl_collectElements(const uno::Reference< report::XSection >& _xSection,::std::vector< uno::Reference< drawing::XShape> >& _rControls)
  53     {
  54         if ( _xSection.is() )
  55         {
  56             sal_Int32 nCount = _xSection->getCount();
  57             _rControls.reserve(nCount);
  58             while ( nCount )
  59             {
  60                 uno::Reference< drawing::XShape> xShape(_xSection->getByIndex(nCount-1),uno::UNO_QUERY);
  61                 _rControls.push_back(xShape);
  62                 _xSection->remove(xShape);
  63                 --nCount;
  64             }
  65         }
  66     }
  67
  68     void lcl_insertElements(const uno::Reference< report::XSection >& _xSection,const ::std::vector< uno::Reference< drawing::XShape> >& _aControls)
  69     {
  70         if ( !_xSection.is() )
  71             return;
  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                 TOOLS_WARN_EXCEPTION( "reportdesign", "lcl_insertElements");
  88             }
  89         }
  90     }
  91
  92     void lcl_setValues(const uno::Reference< report::XSection >& _xSection,const ::std::vector< ::std::pair< OUString ,uno::Any> >& _aValues)
  93     {
  94         if ( !_xSection.is() )
  95             return;
  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                 TOOLS_WARN_EXCEPTION( "reportdesign", "lcl_setValues");
 106             }
 107         }
 108     }
 109 }
 110
 111
 112 OSectionUndo::OSectionUndo(OReportModel& _rMod
 113                            ,sal_uInt16 _nSlot
 114                            ,Action _eAction
 115                            ,TranslateId pCommentID)
 116 : OCommentUndoAction(_rMod,pCommentID)
 117 ,m_eAction(_eAction)
 118 ,m_nSlot(_nSlot)
 119 ,m_bInserted(false)
 120 {
 121 }
 122
 123 OSectionUndo::~OSectionUndo()
 124 {
 125     if ( m_bInserted )
 126         return;
 127
 128     OXUndoEnvironment& rEnv = static_cast< OReportModel& >( m_rMod ).GetUndoEnv();
 129     for (uno::Reference<drawing::XShape>& xShape : m_aControls)
 130     {
 131         rEnv.RemoveElement(xShape);
 132         try
 133         {
 134             comphelper::disposeComponent(xShape);
 135         }
 136         catch(const uno::Exception &)
 137         {
 138             TOOLS_WARN_EXCEPTION( "reportdesign", "");
 139         }
 140     }
 141 }
 142
 143 void OSectionUndo::collectControls(const uno::Reference< report::XSection >& _xSection)
 144 {
 145     m_aControls.clear();
 146     try
 147     {
 148         // copy all properties for restoring
 149         uno::Reference< beans::XPropertySetInfo> xInfo = _xSection->getPropertySetInfo();
 150         const uno::Sequence< beans::Property> aSeq = xInfo->getProperties();
 151         for(const beans::Property& rProp : aSeq)
 152         {
 153             if ( 0 == (rProp.Attributes & beans::PropertyAttribute::READONLY) )
 154                 m_aValues.emplace_back(rProp.Name,_xSection->getPropertyValue(rProp.Name));
 155         }
 156         lcl_collectElements(_xSection,m_aControls);
 157     }
 158     catch(uno::Exception&)
 159     {
 160     }
 161 }
 162
 163 void OSectionUndo::Undo()
 164 {
 165     try
 166     {
 167         switch ( m_eAction )
 168         {
 169         case Inserted:
 170             implReRemove();
 171             break;
 172
 173         case Removed:
 174             implReInsert();
 175             break;
 176         }
 177     }
 178     catch( const Exception& )
 179     {
 180         TOOLS_WARN_EXCEPTION( "reportdesign", "OSectionUndo::Undo" );
 181     }
 182 }
 183
 184 void OSectionUndo::Redo()
 185 {
 186     try
 187     {
 188         switch ( m_eAction )
 189         {
 190         case Inserted:
 191             implReInsert();
 192             break;
 193
 194         case Removed:
 195             implReRemove();
 196             break;
 197         }
 198     }
 199     catch( const Exception& )
 200     {
 201         TOOLS_WARN_EXCEPTION( "reportdesign", "OSectionUndo::Redo" );
 202     }
 203 }
 204
 205 OReportSectionUndo::OReportSectionUndo(
 206     OReportModel& _rMod, sal_uInt16 _nSlot,
 207     ::std::function<uno::Reference<report::XSection>(OReportHelper*)> _pMemberFunction,
 208     const uno::Reference<report::XReportDefinition>& _xReport, Action _eAction)
 209     : OSectionUndo(_rMod, _nSlot, _eAction, {})
 210     , m_aReportHelper(_xReport)
 211     , m_pMemberFunction(std::move(_pMemberFunction))
 212 {
 213     if( m_eAction == Removed )
 214         collectControls(m_pMemberFunction(&m_aReportHelper));
 215 }
 216
 217 OReportSectionUndo::~OReportSectionUndo()
 218 {
 219 }
 220
 221 void OReportSectionUndo::implReInsert( )
 222 {
 223     const uno::Sequence< beans::PropertyValue > aArgs;
 224     m_pController->executeChecked(m_nSlot,aArgs);
 225     uno::Reference< report::XSection > xSection = m_pMemberFunction(&m_aReportHelper);
 226     lcl_insertElements(xSection,m_aControls);
 227     lcl_setValues(xSection,m_aValues);
 228     m_bInserted = true;
 229 }
 230
 231 void OReportSectionUndo::implReRemove( )
 232 {
 233     if( m_eAction == Removed )
 234         collectControls(m_pMemberFunction(&m_aReportHelper));
 235     const uno::Sequence< beans::PropertyValue > aArgs;
 236     m_pController->executeChecked(m_nSlot,aArgs);
 237     m_bInserted = false;
 238 }
 239
 240 OGroupSectionUndo::OGroupSectionUndo(
 241     OReportModel& _rMod, sal_uInt16 _nSlot,
 242     ::std::function<uno::Reference<report::XSection>(OGroupHelper*)> _pMemberFunction,
 243     const uno::Reference<report::XGroup>& _xGroup, Action _eAction, TranslateId pCommentID)
 244     : OSectionUndo(_rMod, _nSlot, _eAction, pCommentID)
 245     , m_aGroupHelper(_xGroup)
 246     , m_pMemberFunction(std::move(_pMemberFunction))
 247 {
 248     if( m_eAction == Removed )
 249     {
 250         uno::Reference< report::XSection > xSection = m_pMemberFunction(&m_aGroupHelper);
 251         if ( xSection.is() )
 252             m_sName = xSection->getName();
 253         collectControls(xSection);
 254     }
 255 }
 256
 257 OUString OGroupSectionUndo::GetComment() const
 258 {
 259     if ( m_sName.isEmpty() )
 260     {
 261         try
 262         {
 263             uno::Reference< report::XSection > xSection = const_cast<OGroupSectionUndo*>(this)->m_pMemberFunction(&const_cast<OGroupSectionUndo*>(this)->m_aGroupHelper);
 264
 265             if ( xSection.is() )
 266                 m_sName = xSection->getName();
 267         }
 268         catch (const uno::Exception&)
 269         {
 270         }
 271     }
 272     return m_strComment + m_sName;
 273 }
 274
 275 void OGroupSectionUndo::implReInsert( )
 276 {
 277     const OUString aHeaderFooterOnName(SID_GROUPHEADER_WITHOUT_UNDO == m_nSlot? PROPERTY_HEADERON : PROPERTY_FOOTERON);
 278     uno::Sequence< beans::PropertyValue > aArgs{
 279         comphelper::makePropertyValue(aHeaderFooterOnName, true),
 280         comphelper::makePropertyValue(PROPERTY_GROUP, m_aGroupHelper.getGroup())
 281     };
 282     m_pController->executeChecked(m_nSlot,aArgs);
 283
 284     uno::Reference< report::XSection > xSection = m_pMemberFunction(&m_aGroupHelper);
 285     lcl_insertElements(xSection,m_aControls);
 286     lcl_setValues(xSection,m_aValues);
 287     m_bInserted = true;
 288 }
 289
 290 void OGroupSectionUndo::implReRemove( )
 291 {
 292     if( m_eAction == Removed )
 293         collectControls(m_pMemberFunction(&m_aGroupHelper));
 294
 295     const OUString aHeaderFooterOnName(SID_GROUPHEADER_WITHOUT_UNDO == m_nSlot? PROPERTY_HEADERON : PROPERTY_FOOTERON);
 296     uno::Sequence< beans::PropertyValue > aArgs{
 297         comphelper::makePropertyValue(aHeaderFooterOnName, false),
 298         comphelper::makePropertyValue(PROPERTY_GROUP, m_aGroupHelper.getGroup())
 299     };
 300
 301     m_pController->executeChecked(m_nSlot,aArgs);
 302     m_bInserted = false;
 303 }
 304
 305
 306 OGroupUndo::OGroupUndo(OReportModel& _rMod
 307                        ,TranslateId pCommentID
 308                        ,Action  _eAction
 309                        ,uno::Reference< report::XGroup> _xGroup
 310                        ,uno::Reference< report::XReportDefinition > _xReportDefinition)
 311 : OCommentUndoAction(_rMod,pCommentID)
 312 ,m_xGroup(std::move(_xGroup))
 313 ,m_xReportDefinition(std::move(_xReportDefinition))
 314 ,m_eAction(_eAction)
 315 {
 316     m_nLastPosition = getPositionInIndexAccess(m_xReportDefinition->getGroups(),m_xGroup);
 317 }
 318
 319 void OGroupUndo::implReInsert( )
 320 {
 321     try
 322     {
 323         m_xReportDefinition->getGroups()->insertByIndex(m_nLastPosition,uno::Any(m_xGroup));
 324     }
 325     catch(uno::Exception&)
 326     {
 327         TOOLS_WARN_EXCEPTION( "reportdesign", "Exception caught while undoing remove group");
 328     }
 329 }
 330
 331 void OGroupUndo::implReRemove( )
 332 {
 333     try
 334     {
 335         m_xReportDefinition->getGroups()->removeByIndex(m_nLastPosition);
 336     }
 337     catch(uno::Exception&)
 338     {
 339         TOOLS_WARN_EXCEPTION( "reportdesign", "Exception caught while redoing remove group");
 340     }
 341 }
 342
 343 void OGroupUndo::Undo()
 344 {
 345     switch ( m_eAction )
 346     {
 347     case Inserted:
 348         implReRemove();
 349         break;
 350
 351     case Removed:
 352         implReInsert();
 353         break;
 354     }
 355
 356 }
 357
 358 void OGroupUndo::Redo()
 359 {
 360     switch ( m_eAction )
 361     {
 362     case Inserted:
 363         implReInsert();
 364         break;
 365
 366     case Removed:
 367         implReRemove();
 368         break;
 369     }
 370 }
 371
 372
 373 } // rptui
 374
 375
 376 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */