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_SW_INC_IDOCUMENTLAYOUTACCESS_HXX
21 #define INCLUDED_SW_INC_IDOCUMENTLAYOUTACCESS_HXX
22 
23 class SwViewShell;
24 class SwRootFrame;
25 class SwFrameFormat;
26 class SfxItemSet;
27 class SwLayouter;
28 class SwFormatAnchor;
29 enum class RndStdIds;
30 
31 /** Provides access to the layout of a document.
32 */
33 class IDocumentLayoutAccess
34 {
35 public:
36 
37     /** Returns the layout set at the document.
38     */
39     virtual const SwViewShell* GetCurrentViewShell() const = 0;
40     virtual       SwViewShell* GetCurrentViewShell() = 0;
41     virtual const SwRootFrame* GetCurrentLayout() const = 0;
42     virtual       SwRootFrame* GetCurrentLayout() = 0;
43     virtual bool HasLayout() const = 0;
44 
45     /** !!!The old layout must be deleted!!!
46     */
47     virtual void SetCurrentViewShell( SwViewShell* pNew ) = 0;
48 
49     virtual SwFrameFormat* MakeLayoutFormat( RndStdIds eRequest, const SfxItemSet* pSet ) = 0;
50 
51     virtual SwLayouter* GetLayouter() = 0;
52     virtual const SwLayouter* GetLayouter() const = 0;
53     virtual void SetLayouter( SwLayouter* pNew ) = 0;
54 
55     virtual void DelLayoutFormat( SwFrameFormat *pFormat ) = 0;
56 
57     virtual SwFrameFormat* CopyLayoutFormat( const SwFrameFormat& rSrc, const SwFormatAnchor& rNewAnchor,
58                                      bool bSetTextFlyAtt, bool bMakeFrames ) = 0;
59 
60 protected:
61 
~IDocumentLayoutAccess()62     virtual ~IDocumentLayoutAccess() {};
63  };
64 
65  #endif // INCLUDED_SW_INC_IDOCUMENTLAYOUTACCESS_HXX
66 
67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
68