IDocumentUndoRedo.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_SW_INC_IDOCUMENTUNDOREDO_HXX
#define INCLUDED_SW_INC_IDOCUMENTUNDOREDO_HXX

#include <sal/types.h>

#include "swundo.hxx"
#include <memory>

class SwRewriter;
class SwNodes;
class SwUndo;
class SwView;

namespace sw {
    class RepeatContext;
}

class IDocumentUndoRedo
{
public:

    virtual void DoUndo(bool const bDoUndo) = 0;

    virtual bool DoesUndo() const = 0;

    virtual void DoGroupUndo(bool const bDoUndo) = 0;

    virtual bool DoesGroupUndo() const = 0;

    virtual void DoDrawUndo(bool const bDoUndo) = 0;

    virtual bool DoesDrawUndo() const = 0;

    virtual void DoRepair(bool bRepair) = 0;
    virtual bool DoesRepair() const = 0;

    virtual void SetUndoNoModifiedPosition() = 0;

    virtual void LockUndoNoModifiedPosition() = 0;

    virtual void UnLockUndoNoModifiedPosition() = 0;

    virtual void SetUndoNoResetModified() = 0;

    virtual bool IsUndoNoResetModified() const = 0;

    virtual bool Undo() = 0;

    virtual SwUndoId StartUndo(SwUndoId const eUndoId,
                SwRewriter const*const  pRewriter) = 0;

    virtual SwUndoId EndUndo(SwUndoId const eUndoId,
                SwRewriter const*const  pRewriter) = 0;

    virtual void DelAllUndoObj() = 0;

    virtual bool GetLastUndoInfo(OUString *const o_pStr,
                SwUndoId *const o_pId,
                const SwView* pView = nullptr) const = 0;

    virtual SwUndoComments_t GetUndoComments() const = 0;

    virtual bool Redo() = 0;

    virtual bool GetFirstRedoInfo(OUString *const o_pStr,
                                  SwUndoId *const o_pId,
                                  const SwView* pView = nullptr) const = 0;

    virtual SwUndoComments_t GetRedoComments() const = 0;

    virtual bool Repeat(::sw::RepeatContext & rContext,
                sal_uInt16 const nRepeatCnt) = 0;

    virtual SwUndoId GetRepeatInfo(OUString *const o_pStr) const = 0;

    virtual void AppendUndo(std::unique_ptr<SwUndo> pUndo) = 0;

    virtual void ClearRedo() = 0;

    /* Is the given nodes array the Undo nodes array?
    */
    virtual bool IsUndoNodes(SwNodes const& rNodes) const = 0;

    virtual size_t GetUndoActionCount(const bool bCurrentLevel = true) const = 0;

    virtual void SetView(SwView* pView) = 0;

protected:
    virtual ~IDocumentUndoRedo() {};
};

namespace sw {

class UndoGuard
{
public:

    UndoGuard(IDocumentUndoRedo & rUndoRedo)
        :   m_rUndoRedo(rUndoRedo)
        ,   m_bUndoWasEnabled(rUndoRedo.DoesUndo())
    {
        m_rUndoRedo.DoUndo(false);
    }
    ~UndoGuard()
    {
        m_rUndoRedo.DoUndo(m_bUndoWasEnabled);
    }

    bool UndoWasEnabled() const
    {
        return m_bUndoWasEnabled;
    }

private:
    IDocumentUndoRedo & m_rUndoRedo;
    bool const m_bUndoWasEnabled;
};

class GroupUndoGuard
{
public:

    GroupUndoGuard(IDocumentUndoRedo & rUndoRedo)
        :   m_rUndoRedo(rUndoRedo)
        ,   m_bGroupUndoWasEnabled(rUndoRedo.DoesGroupUndo())
    {
        m_rUndoRedo.DoGroupUndo(false);
    }
    ~GroupUndoGuard()
    {
        m_rUndoRedo.DoGroupUndo(m_bGroupUndoWasEnabled);
    }

private:
    IDocumentUndoRedo & m_rUndoRedo;
    bool const m_bGroupUndoWasEnabled;
};

class DrawUndoGuard
{
public:

    DrawUndoGuard(IDocumentUndoRedo & rUndoRedo)
        :   m_rUndoRedo(rUndoRedo)
        ,   m_bDrawUndoWasEnabled(rUndoRedo.DoesDrawUndo())
    {
        m_rUndoRedo.DoDrawUndo(false);
    }
    ~DrawUndoGuard()
    {
        m_rUndoRedo.DoDrawUndo(m_bDrawUndoWasEnabled);
    }

private:
    IDocumentUndoRedo & m_rUndoRedo;
    bool const m_bDrawUndoWasEnabled;
};

} // namespace sw

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */