sw/source/core/layout/objectformatterlayfrm.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 #ifndef INCLUDED_SW_SOURCE_CORE_LAYOUT_OBJECTFORMATTERLAYFRM_HXX
  20 #define INCLUDED_SW_SOURCE_CORE_LAYOUT_OBJECTFORMATTERLAYFRM_HXX
  21
  22 #include <objectformatter.hxx>
  23
  24 class SwLayoutFrame;
  25
  26 // Format floating screen objects, which are anchored at a given anchor text frame
  27 // and registered at the given page frame.
  28 class SwObjectFormatterLayFrame : public SwObjectFormatter
  29 {
  30     private:
  31         // anchor layout frame
  32         SwLayoutFrame& mrAnchorLayFrame;
  33
  34         SwObjectFormatterLayFrame( SwLayoutFrame& _rAnchorLayFrame,
  35                                  const SwPageFrame& _rPageFrame,
  36                                  SwLayAction* _pLayAction );
  37
  38         /** method to format all anchored objects, which are registered at
  39             the page frame, whose 'anchor' isn't on this page frame and whose
  40             anchor frame is valid.
  41
  42             OD 2004-07-02 #i28701#
  43
  44             @return boolean
  45             indicates, if format was successful
  46         */
  47         bool AdditionalFormatObjsOnPage();
  48
  49     protected:
  50
  51         virtual SwFrame& GetAnchorFrame() override;
  52
  53     public:
  54         virtual ~SwObjectFormatterLayFrame() override;
  55
  56         // #i40147# - add parameter <_bCheckForMovedFwd>.
  57         // Not relevant for objects anchored at layout frame.
  58         virtual bool DoFormatObj( SwAnchoredObject& _rAnchoredObj,
  59                                   const bool _bCheckForMovedFwd = false ) override;
  60         virtual bool DoFormatObjs() override;
  61
  62         static std::unique_ptr<SwObjectFormatterLayFrame> CreateObjFormatter(
  63                                                 SwLayoutFrame& _rAnchorLayFrame,
  64                                                 const SwPageFrame& _rPageFrame,
  65                                                 SwLayAction* _pLayAction );
  66 };
  67
  68 #endif
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */