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