sw/inc/IDocumentLayoutAccess.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: IDocumentLayoutAccess.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef IDOCUMENTLAYOUTACCESS_HXX_INCLUDED
  32 #define IDOCUMENTLAYOUTACCESS_HXX_INCLUDED
  33
  34 #include <swtypes.hxx>
  35
  36 class SwRootFrm;
  37 class SwFrmFmt;
  38 class SfxItemSet;
  39 class SwLayouter;
  40 class SwFmtAnchor;
  41
  42 /** Provides access to the layout of a document.
  43 */
  44 class IDocumentLayoutAccess
  45 {
  46 public:
  47
  48     /** Returns the layout set at the document.
  49     */
  50     virtual const SwRootFrm* GetRootFrm() const = 0;
  51     virtual       SwRootFrm* GetRootFrm() = 0;
  52
  53     /** !!!The old layout must be deleted!!!
  54     */
  55     virtual void SetRootFrm( SwRootFrm* pNew ) = 0;
  56
  57     /**
  58     */
  59     virtual SwFrmFmt* MakeLayoutFmt( RndStdIds eRequest, const SfxItemSet* pSet ) = 0;
  60
  61     /**
  62     */
  63     virtual SwLayouter* GetLayouter() = 0;
  64     virtual const SwLayouter* GetLayouter() const = 0;
  65     virtual void SetLayouter( SwLayouter* pNew ) = 0;
  66
  67     /**
  68     */
  69     virtual void DelLayoutFmt( SwFrmFmt *pFmt ) = 0;
  70
  71     /**
  72     */
  73     virtual SwFrmFmt* CopyLayoutFmt( const SwFrmFmt& rSrc, const SwFmtAnchor& rNewAnchor,
  74                                      bool bSetTxtFlyAtt, bool bMakeFrms ) = 0;
  75
  76 protected:
  77
  78     virtual ~IDocumentLayoutAccess() {};
  79  };
  80
  81  #endif // IDOCUMENTLAYOUTACCESS_HXX_INCLUDED