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