sw/source/core/layout/objectformatterlayfrm.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: objectformatterlayfrm.hxx,v $
  10  * $Revision: 1.5 $
  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 #ifndef _OBJECTFORMATTERLAYFRM_HXX
  31 #define _OBJECTFORMATTERLAYFRM_HXX
  32
  33 #include <objectformatter.hxx>
  34
  35 class SwLayoutFrm;
  36
  37 // -----------------------------------------------------------------------------
  38 // Format floating screen objects, which are anchored at a given anchor text frame
  39 // and registered at the given page frame.
  40 // -----------------------------------------------------------------------------
  41 class SwObjectFormatterLayFrm : public SwObjectFormatter
  42 {
  43     private:
  44         // anchor layout frame
  45         SwLayoutFrm& mrAnchorLayFrm;
  46
  47         SwObjectFormatterLayFrm( SwLayoutFrm& _rAnchorLayFrm,
  48                                  const SwPageFrm& _rPageFrm,
  49                                  SwLayAction* _pLayAction );
  50
  51         /** method to format all anchored objects, which are registered at
  52             the page frame, whose 'anchor' isn't on this page frame and whose
  53             anchor frame is valid.
  54
  55             OD 2004-07-02 #i28701#
  56
  57             @author OD
  58
  59             @return boolean
  60             indicates, if format was successfull
  61         */
  62         bool _AdditionalFormatObjsOnPage();
  63
  64     protected:
  65
  66         virtual SwFrm& GetAnchorFrm();
  67
  68     public:
  69         virtual ~SwObjectFormatterLayFrm();
  70
  71         // --> OD 2005-01-10 #i40147# - add parameter <_bCheckForMovedFwd>.
  72         // Not relevant for objects anchored at layout frame.
  73         virtual bool DoFormatObj( SwAnchoredObject& _rAnchoredObj,
  74                                   const bool _bCheckForMovedFwd = false );
  75         // <--
  76         virtual bool DoFormatObjs();
  77
  78         static SwObjectFormatterLayFrm* CreateObjFormatter(
  79                                                 SwLayoutFrm& _rAnchorLayFrm,
  80                                                 const SwPageFrm& _rPageFrm,
  81                                                 SwLayAction* _pLayAction );
  82 };
  83
  84 #endif