chart2/source/controller/main/UndoGuard.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 #pragma once
  20
  21 #include "ChartModelClone.hxx"
  22
  23 #include <rtl/ustring.hxx>
  24
  25 #include <memory>
  26
  27 namespace com::sun::star::document { class XUndoManager; }
  28 namespace com::sun::star::frame { class XModel; }
  29
  30 namespace chart
  31 {
  32
  33 /** A guard which does nothing, unless you explicitly call commitAction. In particular, in its destructor, it
  34     does neither auto-commit nor auto-rollback the model changes.
  35  */
  36 class UndoGuard
  37 {
  38 public:
  39     explicit UndoGuard(
  40         OUString i_undoMessage,
  41         const css::uno::Reference< css::document::XUndoManager > & i_undoManager,
  42         const ModelFacet i_facet = E_MODEL
  43     );
  44     ~UndoGuard();
  45
  46     void    commit();
  47     void    rollback();
  48
  49 protected:
  50     bool    isActionPosted() const { return m_bActionPosted; }
  51
  52 private:
  53     void    discardSnapshot();
  54
  55 private:
  56     rtl::Reference<::chart::ChartModel>                       m_xChartModel;
  57     const css::uno::Reference< css::document::XUndoManager >  m_xUndoManager;
  58
  59     std::shared_ptr< ChartModelClone >  m_pDocumentSnapshot;
  60     OUString                           m_aUndoString;
  61     bool                                    m_bActionPosted;
  62 };
  63
  64 /** A guard which, in its destructor, restores the model state it found in the constructor. If
  65     <member>commitAction</member> is called inbetween, the restoration is not performed.
  66  */
  67 class UndoLiveUpdateGuard : public UndoGuard
  68 {
  69 public:
  70     explicit UndoLiveUpdateGuard(
  71         const OUString& i_undoMessage,
  72         const css::uno::Reference< css::document::XUndoManager > & i_undoManager
  73     );
  74     ~UndoLiveUpdateGuard();
  75 };
  76
  77 /** Same as UndoLiveUpdateGuard but with additional storage of the chart's data.
  78     Only use this if the data has internal data.
  79  */
  80 class UndoLiveUpdateGuardWithData :
  81         public UndoGuard
  82 {
  83 public:
  84     explicit UndoLiveUpdateGuardWithData(
  85         const OUString& i_undoMessage,
  86         const css::uno::Reference< css::document::XUndoManager > & i_undoManager
  87     );
  88     ~UndoLiveUpdateGuardWithData();
  89 };
  90
  91 class UndoGuardWithSelection : public UndoGuard
  92 {
  93 public:
  94     explicit UndoGuardWithSelection(
  95         const OUString& i_undoMessage,
  96         const css::uno::Reference< css::document::XUndoManager > & i_undoManager
  97     );
  98     virtual ~UndoGuardWithSelection();
  99 };
 100
 101 class HiddenUndoContext
 102 {
 103 public:
 104     explicit HiddenUndoContext(
 105         const css::uno::Reference< css::document::XUndoManager > & i_undoManager
 106     );
 107     ~HiddenUndoContext();
 108
 109 private:
 110     css::uno::Reference< css::document::XUndoManager >    m_xUndoManager;
 111 };
 112
 113 }
 114
 115 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */