xref: /AOO41X/main/sw/source/core/layout/objectformatterlayfrm.hxx (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 #ifndef _OBJECTFORMATTERLAYFRM_HXX
28 #define _OBJECTFORMATTERLAYFRM_HXX
29 
30 #include <objectformatter.hxx>
31 
32 class SwLayoutFrm;
33 
34 // -----------------------------------------------------------------------------
35 // Format floating screen objects, which are anchored at a given anchor text frame
36 // and registered at the given page frame.
37 // -----------------------------------------------------------------------------
38 class SwObjectFormatterLayFrm : public SwObjectFormatter
39 {
40     private:
41         // anchor layout frame
42         SwLayoutFrm& mrAnchorLayFrm;
43 
44         SwObjectFormatterLayFrm( SwLayoutFrm& _rAnchorLayFrm,
45                                  const SwPageFrm& _rPageFrm,
46                                  SwLayAction* _pLayAction );
47 
48         /** method to format all anchored objects, which are registered at
49             the page frame, whose 'anchor' isn't on this page frame and whose
50             anchor frame is valid.
51 
52             OD 2004-07-02 #i28701#
53 
54             @author OD
55 
56             @return boolean
57             indicates, if format was successfull
58         */
59         bool _AdditionalFormatObjsOnPage();
60 
61     protected:
62 
63         virtual SwFrm& GetAnchorFrm();
64 
65     public:
66         virtual ~SwObjectFormatterLayFrm();
67 
68         // --> OD 2005-01-10 #i40147# - add parameter <_bCheckForMovedFwd>.
69         // Not relevant for objects anchored at layout frame.
70         virtual bool DoFormatObj( SwAnchoredObject& _rAnchoredObj,
71                                   const bool _bCheckForMovedFwd = false );
72         // <--
73         virtual bool DoFormatObjs();
74 
75         static SwObjectFormatterLayFrm* CreateObjFormatter(
76                                                 SwLayoutFrm& _rAnchorLayFrm,
77                                                 const SwPageFrm& _rPageFrm,
78                                                 SwLayAction* _pLayAction );
79 };
80 
81 #endif
82