sfx2/source/inc/docundomanager.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
  20 #ifndef INCLUDED_SFX2_SOURCE_INC_DOCUNDOMANAGER_HXX
  21 #define INCLUDED_SFX2_SOURCE_INC_DOCUNDOMANAGER_HXX
  22
  23 #include <sfx2/sfxbasemodel.hxx>
  24
  25 #include <com/sun/star/document/XUndoManager.hpp>
  26
  27 #include <cppuhelper/implbase.hxx>
  28 #include <vcl/svapp.hxx>
  29
  30 #include <memory>
  31
  32 /** base class for sub components of an SfxBaseModel, which share their ref count and lifetime with the SfxBaseModel
  33 */
  34 class SfxModelSubComponent
  35 {
  36 public:
  37     /** checks whether the instance is alive, i.e. properly initialized, and not yet disposed
  38     */
  39     void    MethodEntryCheck()
  40     {
  41         m_rModel.MethodEntryCheck( true );
  42     }
  43
  44 protected:
  45     SfxModelSubComponent( SfxBaseModel& i_model )
  46         :m_rModel( i_model )
  47     {
  48     }
  49     virtual ~SfxModelSubComponent();
  50
  51     void acquireModel()  { m_rModel.acquire(); }
  52     void releaseModel()  { m_rModel.release(); }
  53
  54 protected:
  55     const SfxBaseModel& getBaseModel() const { return m_rModel; }
  56           SfxBaseModel& getBaseModel()       { return m_rModel; }
  57
  58 private:
  59     SfxBaseModel&   m_rModel;
  60 };
  61
  62 class SfxModelGuard
  63 {
  64 public:
  65     enum AllowedModelState
  66     {
  67         // not yet initialized
  68         E_INITIALIZING,
  69         // fully alive, i.e. initialized, and not yet disposed
  70         E_FULLY_ALIVE
  71     };
  72
  73     SfxModelGuard( SfxBaseModel const & i_rModel, const AllowedModelState i_eState = E_FULLY_ALIVE )
  74         : m_aGuard()
  75     {
  76         i_rModel.MethodEntryCheck( i_eState != E_INITIALIZING );
  77     }
  78     SfxModelGuard( SfxModelSubComponent& i_rSubComponent )
  79         :m_aGuard()
  80     {
  81         i_rSubComponent.MethodEntryCheck();
  82     }
  83
  84     void clear()
  85     {
  86         m_aGuard.clear();
  87     }
  88
  89 private:
  90     SolarMutexClearableGuard  m_aGuard;
  91 };
  92
  93 namespace sfx2
  94 {
  95     //= DocumentUndoManager
  96
  97     struct DocumentUndoManager_Impl;
  98     class DocumentUndoManager   :public ::cppu::WeakImplHelper<css::document::XUndoManager>
  99                                 ,public SfxModelSubComponent
 100     {
 101         friend struct DocumentUndoManager_Impl;
 102
 103     public:
 104         DocumentUndoManager( SfxBaseModel& i_document );
 105         virtual ~DocumentUndoManager() override;
 106         DocumentUndoManager(const DocumentUndoManager&) = delete;
 107         DocumentUndoManager& operator=(const DocumentUndoManager&) = delete;
 108
 109         void    disposing();
 110
 111         // non-UNO API for our owner
 112         /** determines whether we have an open Undo context. No mutex locking within this method, no disposal check - this
 113             is the responsibility of the owner.
 114         */
 115         bool    isInContext() const;
 116
 117         // XInterface
 118         virtual void SAL_CALL acquire(  ) noexcept override;
 119         virtual void SAL_CALL release(  ) noexcept override;
 120
 121         // XUndoManager
 122         virtual void SAL_CALL enterUndoContext( const OUString& i_title ) override;
 123         virtual void SAL_CALL enterHiddenUndoContext(  ) override;
 124         virtual void SAL_CALL leaveUndoContext(  ) override;
 125         virtual void SAL_CALL addUndoAction( const css::uno::Reference< css::document::XUndoAction >& i_action ) override;
 126         virtual void SAL_CALL undo(  ) override;
 127         virtual void SAL_CALL redo(  ) override;
 128         virtual sal_Bool SAL_CALL isUndoPossible(  ) override;
 129         virtual sal_Bool SAL_CALL isRedoPossible(  ) override;
 130         virtual OUString SAL_CALL getCurrentUndoActionTitle(  ) override;
 131         virtual OUString SAL_CALL getCurrentRedoActionTitle(  ) override;
 132         virtual css::uno::Sequence< OUString > SAL_CALL getAllUndoActionTitles(  ) override;
 133         virtual css::uno::Sequence< OUString > SAL_CALL getAllRedoActionTitles(  ) override;
 134         virtual void SAL_CALL clear(  ) override;
 135         virtual void SAL_CALL clearRedo(  ) override;
 136         virtual void SAL_CALL reset(  ) override;
 137         virtual void SAL_CALL addUndoManagerListener( const css::uno::Reference< css::document::XUndoManagerListener >& i_listener ) override;
 138         virtual void SAL_CALL removeUndoManagerListener( const css::uno::Reference< css::document::XUndoManagerListener >& i_listener ) override;
 139
 140         // XLockable, base of XUndoManager
 141         virtual void SAL_CALL lock(  ) override;
 142         virtual void SAL_CALL unlock(  ) override;
 143         virtual sal_Bool SAL_CALL isLocked(  ) override;
 144
 145         // XChild, base of XUndoManager
 146         virtual css::uno::Reference< css::uno::XInterface > SAL_CALL getParent(  ) override;
 147         virtual void SAL_CALL setParent( const css::uno::Reference< css::uno::XInterface >& Parent ) override;
 148
 149     private:
 150         std::unique_ptr< DocumentUndoManager_Impl > m_pImpl;
 151     };
 152
 153
 154 } // namespace sfx2
 155
 156
 157 #endif // INCLUDED_SFX2_SOURCE_INC_DOCUNDOMANAGER_HXX
 158
 159 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */