ViewShellManager.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 .
 */
 
#pragma once
 
#include "ShellFactory.hxx"
#include <o3tl/deleter.hxx>
#include <memory>
#include <utility>
 
class FmFormShell;
class SfxShell;
 
namespace sd
{
class ViewShell;
class ViewShellBase;
 
class ViewShellManager
{
public:
    typedef std::shared_ptr<ShellFactory<SfxShell>> SharedShellFactory;
 
    ViewShellManager(ViewShellBase& rBase);
 
    ~ViewShellManager();
 
    void Shutdown();
 
    void AddSubShellFactory(ViewShell const* pViewShell, const SharedShellFactory& rpFactory);
    void RemoveSubShellFactory(ViewShell const* pViewShell, const SharedShellFactory& rpFactory);
 
    void ActivateViewShell(ViewShell* pViewShell);
 
    void ActivateShell(SfxShell* pShell);
 
    void DeactivateViewShell(const ViewShell* pShell);
 
    void DeactivateShell(const SfxShell* pShell);
 
    void SetFormShell(const ViewShell* pParentShell, FmFormShell* pFormShell, bool bAbove);
 
    void ActivateSubShell(const ViewShell& rParentShell, ShellId nId);
 
    void DeactivateSubShell(const ViewShell& rParentShell, ShellId nId);
 
    void InvalidateAllSubShells(ViewShell const* pViewShell);
 
    void MoveToTop(const ViewShell& rShell);
 
    SfxShell* GetShell(ShellId nId) const;
 
    SfxShell* GetTopShell() const;
 
    SfxShell* GetTopViewShell() const;
 
    class UpdateLock
    {
    public:
        UpdateLock(std::shared_ptr<ViewShellManager> pManager)
            : mpManager(std::move(pManager))
        {
            mpManager->LockUpdate();
        }
        ~UpdateLock() COVERITY_NOEXCEPT_FALSE { mpManager->UnlockUpdate(); }
 
    private:
        std::shared_ptr<ViewShellManager> mpManager;
    };
    friend class UpdateLock;
 
private:
    class Implementation;
    std::unique_ptr<ViewShellManager::Implementation,
                    o3tl::default_delete<ViewShellManager::Implementation>>
        mpImpl;
    bool mbValid;
 
    void LockUpdate();
    void UnlockUpdate();
};
 
} // end of namespace sd
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */