reportdesign/inc/UndoActions.hxx

   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 #ifndef INCLUDED_REPORTDESIGN_INC_UNDOACTIONS_HXX
  20 #define INCLUDED_REPORTDESIGN_INC_UNDOACTIONS_HXX
  21
  22 #include "dllapi.h"
  23
  24 #include "RptModel.hxx"
  25
  26 #include <com/sun/star/util/XModifyListener.hpp>
  27 #include <com/sun/star/beans/XPropertySet.hpp>
  28 #include <com/sun/star/beans/PropertyChangeEvent.hpp>
  29 #include <com/sun/star/container/XNameContainer.hpp>
  30 #include <com/sun/star/container/ContainerEvent.hpp>
  31 #include <com/sun/star/report/XReportDefinition.hpp>
  32 #include <com/sun/star/report/XGroup.hpp>
  33 #include <com/sun/star/document/XUndoManager.hpp>
  34
  35 #include <comphelper/sequence.hxx>
  36 #include <svl/lstner.hxx>
  37 #include <svx/svdouno.hxx>
  38 #include <svx/svdundo.hxx>
  39
  40 #include <functional>
  41
  42 namespace dbaui
  43 {
  44     class IController;
  45 }
  46 namespace rptui
  47 {
  48     enum Action
  49     {
  50         Inserted = 1,
  51         Removed  = 2
  52     };
  53
  54     /** Helper class to allow std::mem_fun for SAL_CALL
  55     */
  56     class REPORTDESIGN_DLLPUBLIC OGroupHelper
  57     {
  58         css::uno::Reference< css::report::XGroup > m_xGroup;
  59         OGroupHelper(const OGroupHelper&) = delete;
  60         OGroupHelper& operator=(const OGroupHelper&) = delete;
  61     public:
  62         OGroupHelper(const css::uno::Reference< css::report::XGroup >& _xGroup)
  63             :m_xGroup(_xGroup)
  64         {
  65         }
  66         css::uno::Reference< css::report::XSection >   getHeader() { return m_xGroup->getHeader(); }
  67         css::uno::Reference< css::report::XSection >   getFooter() { return m_xGroup->getFooter(); }
  68         const css::uno::Reference< css::report::XGroup >&     getGroup() { return m_xGroup; }
  69
  70         bool getHeaderOn() { return m_xGroup->getHeaderOn(); }
  71         bool getFooterOn() { return m_xGroup->getFooterOn(); }
  72
  73         static ::std::function<css::uno::Reference< css::report::XSection>(OGroupHelper *)> getMemberFunction(const css::uno::Reference< css::report::XSection >& _xSection);
  74
  75     };
  76
  77     /** Helper class to allow std::mem_fun for SAL_CALL
  78     */
  79     class REPORTDESIGN_DLLPUBLIC OReportHelper
  80     {
  81         css::uno::Reference< css::report::XReportDefinition > m_xReport;
  82     public:
  83         OReportHelper(const css::uno::Reference< css::report::XReportDefinition >& _xReport)
  84             :m_xReport(_xReport)
  85         {
  86         }
  87         css::uno::Reference< css::report::XSection > getReportHeader() { return m_xReport->getReportHeader(); }
  88         css::uno::Reference< css::report::XSection > getReportFooter() { return m_xReport->getReportFooter(); }
  89         css::uno::Reference< css::report::XSection > getPageHeader()   { return m_xReport->getPageHeader(); }
  90         css::uno::Reference< css::report::XSection > getPageFooter()   { return m_xReport->getPageFooter(); }
  91         css::uno::Reference< css::report::XSection > getDetail()       { return m_xReport->getDetail(); }
  92
  93         bool getReportHeaderOn() { return m_xReport->getReportHeaderOn(); }
  94         bool getReportFooterOn() { return m_xReport->getReportFooterOn(); }
  95         bool getPageHeaderOn() { return m_xReport->getPageHeaderOn(); }
  96         bool getPageFooterOn() { return m_xReport->getPageFooterOn(); }
  97
  98         static ::std::function<css::uno::Reference< css::report::XSection>(OReportHelper *)> getMemberFunction(const css::uno::Reference< css::report::XSection >& _xSection);
  99     };
 100
 101
 102     //= UndoContext
 103
 104     class UndoContext
 105     {
 106     public:
 107         UndoContext( SfxUndoManager& i_undoManager, const OUString& i_undoTitle )
 108             :m_rUndoManager( i_undoManager )
 109         {
 110             m_rUndoManager.EnterListAction( i_undoTitle, OUString(), 0, ViewShellId(-1) );
 111         }
 112
 113         ~UndoContext()
 114         {
 115             m_rUndoManager.LeaveListAction();
 116         }
 117
 118     private:
 119         SfxUndoManager& m_rUndoManager;
 120     };
 121
 122
 123     //= UndoSuppressor
 124
 125     class UndoSuppressor
 126     {
 127     public:
 128         UndoSuppressor( SfxUndoManager& i_undoManager )
 129             :m_rUndoManager( i_undoManager )
 130         {
 131             m_rUndoManager.EnableUndo( false );
 132         }
 133
 134         ~UndoSuppressor()
 135         {
 136             m_rUndoManager.EnableUndo( true );
 137         }
 138
 139     private:
 140         SfxUndoManager& m_rUndoManager;
 141     };
 142
 143
 144     //= OCommentUndoAction
 145
 146     class REPORTDESIGN_DLLPUBLIC OCommentUndoAction : public SdrUndoAction
 147     {
 148     protected:
 149         OUString                m_strComment; // undo, redo comment
 150         ::dbaui::IController*   m_pController;
 151
 152     public:
 153         OCommentUndoAction(SdrModel& rMod, const char* pCommentID);
 154         virtual ~OCommentUndoAction() override;
 155
 156         virtual OUString GetComment() const override { return m_strComment; }
 157         virtual void        Undo() override;
 158         virtual void        Redo() override;
 159     };
 160
 161     // OUndoContainerAction
 162
 163     class REPORTDESIGN_DLLPUBLIC OUndoContainerAction: public OCommentUndoAction
 164     {
 165         OUndoContainerAction(OUndoContainerAction&) = delete;
 166         void operator =(OUndoContainerAction&) = delete;
 167     protected:
 168         css::uno::Reference< css::uno::XInterface >
 169                         m_xElement;     // object not owned by the action
 170         css::uno::Reference< css::uno::XInterface >
 171                         m_xOwnElement;  // object owned by the action
 172         css::uno::Reference< css::container::XIndexContainer >
 173                         m_xContainer;
 174         Action          m_eAction;
 175
 176     public:
 177         OUndoContainerAction(SdrModel& rMod
 178                             ,Action _eAction
 179                             ,const css::uno::Reference< css::container::XIndexContainer >& rContainer
 180                             ,const css::uno::Reference< css::uno::XInterface>& xElem
 181                             ,const char* pCommentId);
 182         virtual ~OUndoContainerAction() override;
 183
 184         virtual void Undo() override;
 185         virtual void Redo() override;
 186
 187     protected:
 188         virtual void    implReInsert( );
 189         virtual void    implReRemove( );
 190     };
 191
 192
 193     // OUndoReportSectionAction
 194
 195     class REPORTDESIGN_DLLPUBLIC OUndoReportSectionAction : public OUndoContainerAction
 196     {
 197         OReportHelper                               m_aReportHelper;
 198         ::std::function<css::uno::Reference< css::report::XSection >(OReportHelper *)> m_pMemberFunction;
 199     public:
 200         OUndoReportSectionAction(SdrModel& rMod
 201                             ,Action _eAction
 202                             ,::std::function<css::uno::Reference< css::report::XSection >(OReportHelper *)> _pMemberFunction
 203                             ,const css::uno::Reference< css::report::XReportDefinition >& _xReport
 204                             ,const css::uno::Reference< css::uno::XInterface>& xElem
 205                             ,const char* pCommentId);
 206
 207     protected:
 208         virtual void    implReInsert( ) override;
 209         virtual void    implReRemove( ) override;
 210     };
 211
 212
 213     // OUndoGroupSectionAction
 214     class REPORTDESIGN_DLLPUBLIC OUndoGroupSectionAction : public OUndoContainerAction
 215     {
 216         OGroupHelper                                m_aGroupHelper;
 217         ::std::function<css::uno::Reference< css::report::XSection >(OGroupHelper *)> m_pMemberFunction;
 218     public:
 219         OUndoGroupSectionAction(SdrModel& rMod
 220                             ,Action _eAction
 221                             ,::std::function<css::uno::Reference< css::report::XSection >(OGroupHelper *)> _pMemberFunction
 222                             ,const css::uno::Reference< css::report::XGroup >& _xGroup
 223                             ,const css::uno::Reference< css::uno::XInterface>& xElem
 224                             ,const char* pCommentId);
 225
 226     protected:
 227         virtual void    implReInsert( ) override;
 228         virtual void    implReRemove( ) override;
 229     };
 230
 231     // ORptUndoPropertyAction
 232     class REPORTDESIGN_DLLPUBLIC ORptUndoPropertyAction: public OCommentUndoAction
 233     {
 234         css::uno::Reference< css::beans::XPropertySet> m_xObj;
 235         OUString               m_aPropertyName;
 236         css::uno::Any          m_aNewValue;
 237         css::uno::Any          m_aOldValue;
 238
 239         /** sets either the old value or the new value again at the property set.
 240          *
 241          * \param _bOld If set to <TRUE/> than the old value will be set otherwise the new value will be set.
 242          */
 243         void setProperty(bool _bOld);
 244     protected:
 245         virtual css::uno::Reference< css::beans::XPropertySet> getObject();
 246
 247     public:
 248         ORptUndoPropertyAction(SdrModel& rMod, const css::beans::PropertyChangeEvent& evt);
 249
 250         virtual void Undo() override;
 251         virtual void Redo() override;
 252
 253         virtual OUString GetComment() const override;
 254     };
 255
 256
 257     // OUndoPropertyReportSectionAction
 258
 259     class REPORTDESIGN_DLLPUBLIC OUndoPropertyReportSectionAction : public ORptUndoPropertyAction
 260     {
 261         OReportHelper                               m_aReportHelper;
 262         ::std::function<css::uno::Reference< css::report::XSection >(OReportHelper *)> m_pMemberFunction;
 263     protected:
 264         virtual css::uno::Reference< css::beans::XPropertySet> getObject() override;
 265     public:
 266         OUndoPropertyReportSectionAction(SdrModel& rMod
 267                             ,const css::beans::PropertyChangeEvent& evt
 268                             ,::std::function<css::uno::Reference< css::report::XSection >(OReportHelper *)> _pMemberFunction
 269                             ,const css::uno::Reference< css::report::XReportDefinition >& _xReport
 270                             );
 271     };
 272
 273
 274     // OUndoPropertyGroupSectionAction
 275
 276     class REPORTDESIGN_DLLPUBLIC OUndoPropertyGroupSectionAction : public ORptUndoPropertyAction
 277     {
 278         OGroupHelper                                m_aGroupHelper;
 279         ::std::function<css::uno::Reference< css::report::XSection >(OGroupHelper *)> m_pMemberFunction;
 280     protected:
 281         virtual css::uno::Reference< css::beans::XPropertySet> getObject() override;
 282     public:
 283         OUndoPropertyGroupSectionAction(SdrModel& rMod
 284                             ,const css::beans::PropertyChangeEvent& evt
 285                             ,::std::function<css::uno::Reference< css::report::XSection >(OGroupHelper *)> _pMemberFunction
 286                             ,const css::uno::Reference< css::report::XGroup >& _xGroup
 287                             );
 288     };
 289
 290 }
 291 #endif // INCLUDED_REPORTDESIGN_INC_UNDOACTIONS_HXX
 292
 293 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */