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

#ifndef INCLUDED_SW_INC_TEXTBOXHELPER_HXX
#define INCLUDED_SW_INC_TEXTBOXHELPER_HXX

#include <map>
#include <optional>
#include <set>
#include <vector>

#include <com/sun/star/uno/Any.h>
#include <com/sun/star/uno/Type.h>
#include <com/sun/star/text/TextContentAnchorType.hpp>
#include <svx/swframetypes.hxx>

#include "swdllapi.h"

class SdrPage;
class SdrObject;
class SfxItemSet;
class SwFrameFormat;
class SwFrameFormats;
class SwFormatContent;
class SwDoc;
namespace tools
{
class Rectangle;
}
class ZSortFly;
namespace com::sun::star::drawing
{
class XShape;
}
namespace com::sun::star::text
{
class XTextFrame;
}

class SW_DLLPUBLIC SwTextBoxHelper
{
public:
    using SavedLink = std::map<const SwFrameFormat*, const SwFrameFormat*>;
    using SavedContent = std::map<const SwFrameFormat*, SwFormatContent>;
    static void create(SwFrameFormat* pShape, SdrObject* pObject, bool bCopyText = false);
    static void destroy(SwFrameFormat* pShape, SdrObject* pObject);
    static css::uno::Any queryInterface(const SwFrameFormat* pShape, const css::uno::Type& rType);

    static void syncProperty(SwFrameFormat* pShape, sal_uInt16 nWID, sal_uInt8 nMemberID,
                             const css::uno::Any& rValue, SdrObject* pObj = nullptr);
    static void syncProperty(SwFrameFormat* pShape, std::u16string_view rPropertyName,
                             const css::uno::Any& rValue, SdrObject* pObj = nullptr);
    static void getProperty(SwFrameFormat const* pShape, sal_uInt16 nWID, sal_uInt8 nMemberID,
                            css::uno::Any& rValue);
    static css::uno::Any getProperty(SwFrameFormat const* pShape, const OUString& rPropName);

    static css::text::TextContentAnchorType mapAnchorType(const RndStdIds& rAnchorID);

    static void syncFlyFrameAttr(SwFrameFormat& rShape, SfxItemSet const& rSet, SdrObject* pObj);

    static void updateTextBoxMargin(SdrObject* pObj);

    static bool setWrapThrough(SwFrameFormat* pShape);

    static bool changeAnchor(SwFrameFormat* pShape, SdrObject* pObj);

    static bool doTextBoxPositioning(SwFrameFormat* pShape, SdrObject* pObj);

    static std::optional<bool> isAnchorTypeDifferent(const SwFrameFormat* pShape);

    static bool isTextBoxShapeHasValidTextFrame(const SwFrameFormat* pShape);

    // Returns true on success. Synchronize z-order of the text frame of the given textbox
    // by setting it one level higher than the z-order of the shape of the textbox.
    static bool DoTextBoxZOrderCorrection(SwFrameFormat* pShape, SdrObject* pObj);

    static SwFrameFormat* getOtherTextBoxFormat(const SwFrameFormat* pFormat, sal_uInt16 nType,
                                                SdrObject* pObject = nullptr);
    static SwFrameFormat*
    getOtherTextBoxFormat(css::uno::Reference<css::drawing::XShape> const& xShape);
    static css::uno::Reference<css::text::XTextFrame>
    getUnoTextFrame(css::uno::Reference<css::drawing::XShape> const& xShape);
    static tools::Rectangle getTextRectangle(SdrObject* pShape, bool bAbsolute = true);

    static bool isTextBox(const SwFrameFormat* pFormat, sal_uInt16 nType,
                          SdrObject* pObject = nullptr);

    static bool hasTextFrame(const SdrObject* pObj);

    static sal_Int32 getCount(const SwDoc& rDoc);
    static sal_Int32 getCount(SdrPage const* pPage);
    static css::uno::Any getByIndex(SdrPage const* pPage, sal_Int32 nIndex);
    static sal_Int32 getOrdNum(const SdrObject* pObject);
    static void getShapeWrapThrough(const SwFrameFormat* pTextBox, bool& rWrapThrough);

    static void saveLinks(const SwFrameFormats& rFormats,
                          std::map<const SwFrameFormat*, const SwFrameFormat*>& rLinks);
    static void restoreLinks(std::set<ZSortFly>& rOld, std::vector<SwFrameFormat*>& rNew,
                             SavedLink& rSavedLinks);
};

class SwTextBoxNode
{
    // One TextBox-entry
    struct SwTextBoxElement
    {
        // The textframe format
        SwFrameFormat* m_pTextBoxFormat;
        // The Draw object where the textbox belongs to
        SdrObject* m_pDrawObject;
        // This is for indicating if the textbox is in special case: for example during undo.
        bool m_bIsActive;
    };

    // This vector stores the textboxes what belongs to this node
    std::vector<SwTextBoxElement> m_pTextBoxes;
    // This is the pointer to the shape format, which has this node
    // (and the textboxes)
    SwFrameFormat* m_pOwnerShapeFormat;

public:
    // Not needed.
    SwTextBoxNode() = delete;

    // ctor
    SwTextBoxNode(SwFrameFormat* pOwnerShapeFormat);
    // dtor
    ~SwTextBoxNode();

    // default copy ctor is enough
    SwTextBoxNode(SwTextBoxNode&) = default;

    // This method adds a textbox entry to the shape
    // Parameters:
    //     pDrawObject: The shape what the textbox be added to.
    //     pNewTextBox: The newly created textbox format what will be added to the shape.
    void AddTextBox(SdrObject* pDrawObject, SwFrameFormat* pNewTextBox);

    // This will remove the textbox entry.
    // Parameters:
    //     pDrawObject: The shape which have the textbox to be deleted.
    void DelTextBox(SdrObject* pDrawObject);

    // This will return with the frame format of the textbox what belongs
    // to the given shape (pDrawObject)
    SwFrameFormat* GetTextBox(const SdrObject* pDrawObject) const;

    // Is this textbox has special state, undo for example?
    bool IsTextBoxActive(const SdrObject* pDrawObject) const;

    // Setters for the state flag.
    void SetTextBoxInactive(SdrObject* pDrawObject);
    void SetTextBoxActive(SdrObject* pDrawObject);

    // If this is a group shape, that returns true.
    bool IsGroupTextBox() const;
    // This returns with the shape what this class belongs to.
    SwFrameFormat* GetOwnerShape() { return m_pOwnerShapeFormat; };
    // This will give the current number of textboxes.
    size_t GetTextBoxCount() const { return m_pTextBoxes.size(); };
};

#endif // INCLUDED_SW_INC_TEXTBOXHELPER_HXX

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