objectformatter.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef INCLUDED_SW_SOURCE_CORE_INC_OBJECTFORMATTER_HXX
#define INCLUDED_SW_SOURCE_CORE_INC_OBJECTFORMATTER_HXX
 
#include <sal/types.h>
#include <memory>
 
class SwFrame;
// #i26945#
class SwTextFrame;
class SwLayoutFrame;
class SwPageFrame;
class SwAnchoredObject;
class SwLayAction;
// OD 2004-10-04 #i26945#
class SwPageNumAndTypeOfAnchors;
 
// #i28701#
// Format floating screen objects, which are anchored at the given anchor frame
// and registered at the given page frame.
 
class SwObjectFormatter
{
    private:
        // page frame, at which the floating screen objects are registered.
        const SwPageFrame& mrPageFrame;
 
        // value of document compatibility option 'Consider wrapping style on
        // object positioning'
        const bool mbConsiderWrapOnObjPos;
 
        // layout action calling the format of the floating screen objects
        SwLayAction* mpLayAction;
 
        // data structure to collect page number of object's 'anchor'
        // #i26945#
        std::unique_ptr<SwPageNumAndTypeOfAnchors> mpPgNumAndTypeOfAnchors;
 
        void FormatLayout_( SwLayoutFrame& _rLayoutFrame );
 
        void FormatObjContent( SwAnchoredObject& _rAnchoredObj );
 
    protected:
        SwObjectFormatter( const SwPageFrame& _rPageFrame,
                           SwLayAction* _pLayAction,
                           const bool _bCollectPgNumOfAnchors = false );
 
        static std::unique_ptr<SwObjectFormatter> CreateObjFormatter( SwFrame& _rAnchorFrame,
                                                      const SwPageFrame& _rPageFrame,
                                                      SwLayAction* _pLayAction );
 
        virtual SwFrame& GetAnchorFrame() = 0;
 
        const SwPageFrame& GetPageFrame() const
        {
            return mrPageFrame;
        }
 
        bool ConsiderWrapOnObjPos() const
        {
            return mbConsiderWrapOnObjPos;
        }
 
        SwLayAction* GetLayAction()
        {
            return mpLayAction;
        }
 
        void FormatObj_( SwAnchoredObject& _rAnchoredObj );
 
        bool FormatObjsAtFrame_( SwTextFrame* _pMasterTextFrame = nullptr );
 
        SwAnchoredObject* GetCollectedObj( const sal_uInt32 _nIndex );
 
        sal_uInt32 GetPgNumOfCollected( const sal_uInt32 _nIndex );
 
        bool IsCollectedAnchoredAtMaster( const sal_uInt32 _nIndex );
 
        sal_uInt32 CountOfCollected();
 
    public:
        virtual ~SwObjectFormatter();
 
        virtual bool DoFormatObj( SwAnchoredObject& _rAnchoredObj,
                                  const bool _bCheckForMovedFwd = false ) = 0;
 
        virtual bool DoFormatObjs() = 0;
 
        static bool FormatObjsAtFrame( SwFrame& _rAnchorFrame,
                                     const SwPageFrame& _rPageFrame,
                                     SwLayAction* _pLayAction = nullptr );
 
        static bool FormatObj( SwAnchoredObject& _rAnchoredObj,
                               SwFrame* _pAnchorFrame = nullptr,
                               const SwPageFrame* _pPageFrame = nullptr );
};
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */