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