path: root/sw/source/core/objectpositioning/ascharanchoredobjectposition.cxx

/* -*- 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 .
 */

#include <anchoreddrawobject.hxx>
#include <ascharanchoredobjectposition.hxx>
#include <frame.hxx>
#include <txtfrm.hxx>
#include <flyfrms.hxx>
#include <svx/svdobj.hxx>
#include <frmfmt.hxx>
#include <frmatr.hxx>
#include <editeng/lrspitem.hxx>
#include <editeng/ulspitem.hxx>
#include <fmtornt.hxx>


using namespace ::com::sun::star;
using namespace objectpositioning;

/** constructor */
SwAsCharAnchoredObjectPosition::SwAsCharAnchoredObjectPosition(
                                    SdrObject& _rDrawObj,
                                    const Point&    _rProposedAnchorPos,
                                    const AsCharFlags _nFlags,
                                    const SwTwips     _nLineAscent,
                                    const SwTwips     _nLineDescent,
                                    const SwTwips     _nLineAscentInclObjs,
                                    const SwTwips     _nLineDescentInclObjs )
    : SwAnchoredObjectPosition( _rDrawObj ),
      mrProposedAnchorPos( _rProposedAnchorPos ),
      mnFlags( _nFlags ),
      mnLineAscent( _nLineAscent ),
      mnLineDescent( _nLineDescent ),
      mnLineAscentInclObjs( _nLineAscentInclObjs ),
      mnLineDescentInclObjs( _nLineDescentInclObjs ),
      maAnchorPos ( Point() ),
      mnRelPos ( 0 ),
      maObjBoundRect ( SwRect() ),
      mnLineAlignment ( sw::LineAlign::NONE )
{}

/** destructor */
SwAsCharAnchoredObjectPosition::~SwAsCharAnchoredObjectPosition()
{}

/** method to cast <SwAnchoredObjectPosition::GetAnchorFrame()> to needed type */
const SwTextFrame& SwAsCharAnchoredObjectPosition::GetAnchorTextFrame() const
{
    OSL_ENSURE( dynamic_cast<const SwTextFrame*>( &GetAnchorFrame() ) !=  nullptr,
            "SwAsCharAnchoredObjectPosition::GetAnchorTextFrame() - wrong anchor frame type" );

    return static_cast<const SwTextFrame&>(GetAnchorFrame());
}

/** calculate position for object

    OD 30.07.2003 #110978#
    members <maAnchorPos>, <mnRelPos>, <maObjBoundRect> and
    <mnLineAlignment> are calculated.
    calculated position is set at the given object.
*/
void SwAsCharAnchoredObjectPosition::CalcPosition()
{
    const SwTextFrame& rAnchorFrame = GetAnchorTextFrame();
    // swap anchor frame, if swapped. Note: destructor takes care of the 'undo'
    SwFrameSwapper aFrameSwapper( &rAnchorFrame, false );

    SwRectFnSet aRectFnSet(&rAnchorFrame);

    Point aAnchorPos( mrProposedAnchorPos );

    const SwFrameFormat& rFrameFormat = GetFrameFormat();

    SwRect aObjBoundRect( GetAnchoredObj().GetObjRect() );
    SwTwips nObjWidth = aRectFnSet.GetWidth(aObjBoundRect);

    // determine spacing values considering layout-/text-direction
    const SvxLRSpaceItem& rLRSpace = rFrameFormat.GetLRSpace();
    const SvxULSpaceItem& rULSpace = rFrameFormat.GetULSpace();
    SwTwips nLRSpaceLeft, nLRSpaceRight, nULSpaceUpper, nULSpaceLower;
    {
        if ( rAnchorFrame.IsVertical() )
        {
            // Seems to be easier to do it all the horizontal way
            // So, from now on think horizontal.
            rAnchorFrame.SwitchVerticalToHorizontal( aObjBoundRect );
            rAnchorFrame.SwitchVerticalToHorizontal( aAnchorPos );

            // convert the spacing values
            nLRSpaceLeft = rULSpace.GetUpper();
            nLRSpaceRight = rULSpace.GetLower();
            nULSpaceUpper = rLRSpace.GetRight();
            nULSpaceLower = rLRSpace.GetLeft();
        }
        else
        {
            if ( rAnchorFrame.IsRightToLeft() )
            {
                nLRSpaceLeft = rLRSpace.GetRight();
                nLRSpaceRight = rLRSpace.GetLeft();
            }
            else
            {
                nLRSpaceLeft = rLRSpace.GetLeft();
                nLRSpaceRight = rLRSpace.GetRight();
            }

            nULSpaceUpper = rULSpace.GetUpper();
            nULSpaceLower = rULSpace.GetLower();
        }
    }

    // consider left and upper spacing by adjusting anchor position.
    // left spacing is only considered, if requested.
    if( mnFlags & AsCharFlags::UlSpace )
    {
        aAnchorPos.AdjustX(nLRSpaceLeft );
    }
    aAnchorPos.AdjustY(nULSpaceUpper );

    // for drawing objects: consider difference between its bounding rectangle
    // and its snapping rectangle by adjusting anchor position.
    // left difference is only considered, if requested.
    if( !IsObjFly() )
    {
        SwRect aSnapRect = GetObject().GetSnapRect();
        if ( rAnchorFrame.IsVertical() )
        {
            rAnchorFrame.SwitchVerticalToHorizontal( aSnapRect );
        }

        if( mnFlags & AsCharFlags::UlSpace )
        {
            aAnchorPos.AdjustX(aSnapRect.Left() - aObjBoundRect.Left() );
        }
        aAnchorPos.AdjustY(aSnapRect.Top() - aObjBoundRect.Top() );
    }

    // enlarge bounding rectangle of object by its spacing.
    aObjBoundRect.AddLeft( - nLRSpaceLeft );
    aObjBoundRect.AddWidth( nLRSpaceRight );
    aObjBoundRect.AddTop( - nULSpaceUpper );
    aObjBoundRect.AddHeight( nULSpaceLower );

    // calculate relative position to given base line.
    const SwFormatVertOrient& rVert = rFrameFormat.GetVertOrient();
    const SwTwips nObjBoundHeight = ( mnFlags & AsCharFlags::Rotate )
                                    ? aObjBoundRect.Width()
                                    : aObjBoundRect.Height();
    const SwTwips nRelPos = GetRelPosToBase( nObjBoundHeight, rVert );

    // for initial positioning:
    // adjust the proposed anchor position by difference between
    // calculated relative position to base line and current maximal line ascent.
    // Note: In the following line formatting the base line will be adjusted
    //       by the same difference.
    if( mnFlags & AsCharFlags::Init && nRelPos < 0 && mnLineAscentInclObjs < -nRelPos )
    {
        if( mnFlags & AsCharFlags::Rotate )
            aAnchorPos.AdjustX( -(mnLineAscentInclObjs + nRelPos) );
        else
            aAnchorPos.AdjustY( -(mnLineAscentInclObjs + nRelPos) );
    }

    // consider BIDI-multiportion by adjusting proposed anchor position
    if( mnFlags & AsCharFlags::Bidi )
        aAnchorPos.AdjustX( -(aObjBoundRect.Width()) );

    // calculate relative position considering rotation and inside rotation
    // reverse direction.
    Point aRelPos;
    {
        if( mnFlags & AsCharFlags::Rotate )
        {
            if( mnFlags & AsCharFlags::Reverse )
                aRelPos.setX( -nRelPos - aObjBoundRect.Width() );
            else
            {
                aRelPos.setX( nRelPos );
                aRelPos.setY( -aObjBoundRect.Height() );
            }
        }
        else
            aRelPos.setY( nRelPos );
    }

    if( !IsObjFly() )
    {
        if( !( mnFlags & AsCharFlags::Quick ) )
        {
            // save calculated Y-position value for 'automatic' vertical positioning,
            // in order to avoid a switch to 'manual' vertical positioning in
            // <SwDrawContact::Changed_(..)>.
            const sal_Int16 eVertOrient = rVert.GetVertOrient();
            if( rVert.GetPos() != nRelPos && eVertOrient != text::VertOrientation::NONE )
            {
                SwFormatVertOrient aVert( rVert );
                aVert.SetPos( nRelPos );
                const_cast<SwFrameFormat&>(rFrameFormat).LockModify();
                const_cast<SwFrameFormat&>(rFrameFormat).SetFormatAttr( aVert );
                const_cast<SwFrameFormat&>(rFrameFormat).UnlockModify();
            }

            // determine absolute anchor position considering layout directions.
            // Note: Use copy of <aAnchorPos>, because it's needed for
            //       setting relative position.
            Point aAbsAnchorPos( aAnchorPos );
            if ( rAnchorFrame.IsRightToLeft() )
            {
                rAnchorFrame.SwitchLTRtoRTL( aAbsAnchorPos );
                aAbsAnchorPos.AdjustX( -nObjWidth );
            }
            if ( rAnchorFrame.IsVertical() )
                rAnchorFrame.SwitchHorizontalToVertical( aAbsAnchorPos );

            // set proposed anchor position at the drawing object.
            // OD 2004-04-06 #i26791# - distinction between 'master' drawing
            // object and 'virtual' drawing object no longer needed.
            GetObject().SetAnchorPos( aAbsAnchorPos );

            // move drawing object to set its correct relative position.
            {
                SwRect aSnapRect = GetObject().GetSnapRect();
                if ( rAnchorFrame.IsVertical() )
                    rAnchorFrame.SwitchVerticalToHorizontal( aSnapRect );

                Point aDiff;
                if ( rAnchorFrame.IsRightToLeft() )
                    aDiff = aRelPos + aAbsAnchorPos - aSnapRect.TopLeft();
                else
                    aDiff = aRelPos + aAnchorPos - aSnapRect.TopLeft();

                if ( rAnchorFrame.IsVertical() )
                    aDiff = Point( -aDiff.Y(), aDiff.X() );

                // OD 2004-04-06 #i26791# - distinction between 'master' drawing
                // object and 'virtual' drawing object no longer needed.
                GetObject().Move( Size( aDiff.X(), aDiff.Y() ) );
            }
        }

        // switch horizontal, LTR anchor position to absolute values.
        if ( rAnchorFrame.IsRightToLeft() )
        {
            rAnchorFrame.SwitchLTRtoRTL( aAnchorPos );
            aAnchorPos.AdjustX( -nObjWidth );
        }
        if ( rAnchorFrame.IsVertical() )
            rAnchorFrame.SwitchHorizontalToVertical( aAnchorPos );

        // #i44347# - keep last object rectangle at anchored object
        OSL_ENSURE( dynamic_cast<const SwAnchoredDrawObject*>( &GetAnchoredObj() ) !=  nullptr,
                 "<SwAsCharAnchoredObjectPosition::CalcPosition()> - wrong type of anchored object." );
        SwAnchoredDrawObject& rAnchoredDrawObj =
                        static_cast<SwAnchoredDrawObject&>( GetAnchoredObj() );
        rAnchoredDrawObj.SetLastObjRect( rAnchoredDrawObj.GetObjRect().SVRect() );
    }
    else
    {
        // determine absolute anchor position and calculate corresponding
        // relative position and its relative position attribute.
        // Note: The relative position contains the spacing values.
        Point aRelAttr;
        if ( rAnchorFrame.IsRightToLeft() )
        {
            rAnchorFrame.SwitchLTRtoRTL( aAnchorPos );
            aAnchorPos.AdjustX( -nObjWidth );
        }
        if ( rAnchorFrame.IsVertical() )
        {
            rAnchorFrame.SwitchHorizontalToVertical( aAnchorPos );
            aRelAttr = Point( -nRelPos, 0 );
            aRelPos = Point( -aRelPos.Y(), aRelPos.X() );
        }
        else
            aRelAttr = Point( 0, nRelPos );

        // OD 2004-03-23 #i26791#
        OSL_ENSURE( dynamic_cast<const SwFlyInContentFrame*>( &GetAnchoredObj()) !=  nullptr,
                "<SwAsCharAnchoredObjectPosition::CalcPosition()> - wrong anchored object." );
        const SwFlyInContentFrame& rFlyInContentFrame =
                static_cast<const SwFlyInContentFrame&>(GetAnchoredObj());
        if ( !(mnFlags & AsCharFlags::Quick) &&
             ( aAnchorPos != rFlyInContentFrame.GetRefPoint() ||
               aRelAttr != rFlyInContentFrame.GetCurrRelPos() ) )
        {
            // set new anchor position and relative position
            SwFlyInContentFrame* pFlyInContentFrame = &const_cast<SwFlyInContentFrame&>(rFlyInContentFrame);
            pFlyInContentFrame->SetRefPoint( aAnchorPos, aRelAttr, aRelPos );
            if( nObjWidth != aRectFnSet.GetWidth(pFlyInContentFrame->getFrameArea()) )
            {
                // recalculate object bound rectangle, if object width has changed.
                aObjBoundRect = GetAnchoredObj().GetObjRect();
                aObjBoundRect.AddLeft( - rLRSpace.GetLeft() );
                aObjBoundRect.AddWidth( rLRSpace.GetRight() );
                aObjBoundRect.AddTop( - rULSpace.GetUpper() );
                aObjBoundRect.AddHeight( rULSpace.GetLower() );
            }
        }
        OSL_ENSURE( aRectFnSet.GetHeight(rFlyInContentFrame.getFrameArea()),
            "SwAnchoredObjectPosition::CalcPosition(..) - fly frame has an invalid height" );
    }

    // keep calculated values
    maAnchorPos = aAnchorPos;
    mnRelPos = nRelPos;
    maObjBoundRect = aObjBoundRect;
}

/** determine the relative position to base line for object position type AS_CHAR

    OD 29.07.2003 #110978#
    Note about values set at member <mnLineAlignment> -
    value gives feedback for the line formatting.
    0 - no feedback; 1|2|3 - proposed formatting of characters
    at top|at center|at bottom of line.
*/
SwTwips SwAsCharAnchoredObjectPosition::GetRelPosToBase(
                                            const SwTwips _nObjBoundHeight,
                                            const SwFormatVertOrient& _rVert )
{
    SwTwips nRelPosToBase = 0;

    mnLineAlignment = sw::LineAlign::NONE;

    const sal_Int16 eVertOrient = _rVert.GetVertOrient();

    if ( eVertOrient == text::VertOrientation::NONE )
        nRelPosToBase = _rVert.GetPos();
    else
    {
        if ( eVertOrient == text::VertOrientation::CENTER )
            nRelPosToBase -= _nObjBoundHeight /  2;
        else if ( eVertOrient == text::VertOrientation::TOP )
            nRelPosToBase -= _nObjBoundHeight;
        else if ( eVertOrient == text::VertOrientation::BOTTOM )
            nRelPosToBase = 0;
        else if ( eVertOrient == text::VertOrientation::CHAR_CENTER )
            nRelPosToBase -= ( _nObjBoundHeight + mnLineAscent - mnLineDescent ) / 2;
        else if ( eVertOrient == text::VertOrientation::CHAR_TOP )
            nRelPosToBase -= mnLineAscent;
        else if ( eVertOrient == text::VertOrientation::CHAR_BOTTOM )
            nRelPosToBase += mnLineDescent - _nObjBoundHeight;
        else
        {
            if( _nObjBoundHeight >= mnLineAscentInclObjs + mnLineDescentInclObjs )
            {
                // object is at least as high as the line. Thus, no more is
                // positioning necessary. Also, the max. ascent isn't changed.
                nRelPosToBase -= mnLineAscentInclObjs;
                if ( eVertOrient == text::VertOrientation::LINE_CENTER )
                    mnLineAlignment = sw::LineAlign::CENTER;
                else if ( eVertOrient == text::VertOrientation::LINE_TOP )
                    mnLineAlignment = sw::LineAlign::TOP;
                else if ( eVertOrient == text::VertOrientation::LINE_BOTTOM )
                    mnLineAlignment = sw::LineAlign::BOTTOM;
            }
            else if ( eVertOrient == text::VertOrientation::LINE_CENTER )
            {
                nRelPosToBase -= ( _nObjBoundHeight + mnLineAscentInclObjs - mnLineDescentInclObjs ) / 2;
                mnLineAlignment = sw::LineAlign::CENTER;
            }
            else if ( eVertOrient == text::VertOrientation::LINE_TOP )
            {
                nRelPosToBase -= mnLineAscentInclObjs;
                mnLineAlignment = sw::LineAlign::TOP;
            }
            else if ( eVertOrient == text::VertOrientation::LINE_BOTTOM )
            {
                nRelPosToBase += mnLineDescentInclObjs - _nObjBoundHeight;
                mnLineAlignment = sw::LineAlign::BOTTOM;
            }
        }
    }

    return nRelPosToBase;
}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */