diff options
Diffstat (limited to 'sw/source/core/inc/objectformatter.hxx')
| -rw-r--r-- | sw/source/core/inc/objectformatter.hxx | 174 |
1 files changed, 174 insertions, 0 deletions
diff --git a/sw/source/core/inc/objectformatter.hxx b/sw/source/core/inc/objectformatter.hxx new file mode 100644 index 000000000..99d8644f2 --- /dev/null +++ b/sw/source/core/inc/objectformatter.hxx @@ -0,0 +1,174 @@ +/* -*- 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; + + /** helper method for method <FormatObj_(..)> - performs the intrinsic + format of the layout of the given layout frame and all its lower + layout frames. + + #i28701# + IMPORTANT NOTE: + Method corresponds to methods <SwLayAction::FormatLayoutFly(..)> and + <SwLayAction::FormatLayout(..)>. Thus, its code for the formatting have + to be synchronised. + */ + void FormatLayout_( SwLayoutFrame& _rLayoutFrame ); + + /** helper method for method <FormatObj_(..)> - performs the intrinsic + format of the content of the given floating screen object. + + #i28701# + */ + 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; + } + + /** performs the intrinsic format of a given floating screen object and its content. + */ + void FormatObj_( SwAnchoredObject& _rAnchoredObj ); + + /** invokes the intrinsic format method for all floating screen objects, + anchored at anchor frame on the given page frame + + for format of floating screen objects for + follow text frames, the 'master' text frame is passed to the method. + Thus, the objects, whose anchor character is inside the follow text + frame can be formatted. + + @param _pMasterTextFrame + input parameter - pointer to 'master' text frame. default value: NULL + */ + bool FormatObjsAtFrame_( SwTextFrame* _pMasterTextFrame = nullptr ); + + /** accessor to collected anchored object + */ + SwAnchoredObject* GetCollectedObj( const sal_uInt32 _nIndex ); + + /** accessor to 'anchor' page number of collected anchored object + */ + sal_uInt32 GetPgNumOfCollected( const sal_uInt32 _nIndex ); + + /** accessor to 'anchor' type of collected anchored object + */ + bool IsCollectedAnchoredAtMaster( const sal_uInt32 _nIndex ); + + /** accessor to total number of collected anchored objects + */ + sal_uInt32 CountOfCollected(); + + public: + virtual ~SwObjectFormatter(); + + /** intrinsic method to format a certain floating screen object + + #i40147# - add parameter <_bCheckForMovedFwd> + + @param _rAnchoredObj + input parameter - anchored object, which have to be formatted. + + @param _bCheckForMovedFwd + input parameter - boolean indicating, that after a successful + format of the anchored object the anchor frame has to be checked, + if it would moved forward due to the positioning of the anchored object. + default value: false + value only considered, if wrapping style influence has to be + considered for the positioning of the anchored object. + */ + virtual bool DoFormatObj( SwAnchoredObject& _rAnchoredObj, + const bool _bCheckForMovedFwd = false ) = 0; + + /** intrinsic method to format all floating screen objects + */ + virtual bool DoFormatObjs() = 0; + + /** method to format all floating screen objects at the given anchor frame + */ + static bool FormatObjsAtFrame( SwFrame& _rAnchorFrame, + const SwPageFrame& _rPageFrame, + SwLayAction* _pLayAction = nullptr ); + + /** method to format a given floating screen object + */ + static bool FormatObj( SwAnchoredObject& _rAnchoredObj, + SwFrame* _pAnchorFrame = nullptr, + const SwPageFrame* _pPageFrame = nullptr ); +}; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |