anchoreddrawobject.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_INC_ANCHOREDDRAWOBJECT_HXX
#define INCLUDED_SW_INC_ANCHOREDDRAWOBJECT_HXX

#include "anchoredobject.hxx"
#include <optional>

namespace tools { class Rectangle; }

class SwAnchoredDrawObject final : public SwAnchoredObject
{
    private:
        // boolean, indicating that the object position has been invalidated
        // and that a positioning has to be performed.
        bool mbValidPos;

        // rectangle, keeping the last object rectangle after the positioning
        std::optional<tools::Rectangle> maLastObjRect;

        // boolean, indicating that anchored drawing object hasn't been attached
        // to an anchor frame yet. Once, it is attached to an anchor frame the
        // boolean changes its state.
        bool mbNotYetAttachedToAnchorFrame;

        // boolean, indicating that anchored
        // drawing object hasn't been positioned yet. Once, it's positioned the
        // boolean changes its state.
        bool mbNotYetPositioned;

        // boolean, indicating that after change of layout direction the
        // anchored drawing object has to be captured on the page, if it exceeds
        // the left or right page margin.
        // Needed for compatibility option <DoNotCaptureDrawObjsOnPage>
        bool mbCaptureAfterLayoutDirChange;

        void MakeObjPosAnchoredAtPara();

        void MakeObjPosAnchoredAtLayout();

        void SetPositioningAttr();

        void SetDrawObjAnchor();

        void InvalidatePage_( SwPageFrame* _pPageFrame );

        virtual void ObjectAttachedToAnchorFrame() override;

        virtual void RegisterAtCorrectPage() override;
        virtual void RegisterAtPage(SwPageFrame &) override;

        virtual bool SetObjTop_( const SwTwips _nTop) override;
        virtual bool SetObjLeft_( const SwTwips _nLeft) override;

        virtual SwRect GetObjBoundRect() const override;

    public:

        SwAnchoredDrawObject();
        virtual ~SwAnchoredDrawObject() override;

        // declaration of pure virtual methods of base class <SwAnchoredObject>
        virtual void MakeObjPos() override;
        virtual void InvalidateObjPos() override;
        bool IsValidPos() const
        {
            return mbValidPos;
        }

        // accessors to the format
        virtual SwFrameFormat& GetFrameFormat() override;
        virtual const SwFrameFormat& GetFrameFormat() const override;

        // accessors to the object area and its position
        virtual SwRect GetObjRect() const override;

        std::optional<tools::Rectangle> const & GetLastObjRect() const { return maLastObjRect;}
        void SetLastObjRect( const tools::Rectangle& _rNewObjRect );

        void AdjustPositioningAttr( const SwFrame* _pNewAnchorFrame,
                                    const SwRect* _pNewObjRect = nullptr );

        virtual void NotifyBackground( SwPageFrame* _pPageFrame,
                                       const SwRect& _rRect,
                                       PrepareHint _eHint ) override;

        bool NotYetPositioned() const
        {
            return mbNotYetPositioned;
        }

        // change of layout direction needs to be tracked
        // for setting <mbCaptureAfterLayoutDirChange>.
        virtual void UpdateLayoutDir() override;
        bool IsOutsidePage() const;

        // new Loop control
        void ValidateThis() { mbValidPos = true; }

        virtual const char* getElementName( ) const override { return "SwAnchoredDrawObject"; }
};

#endif

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