sw/inc/HandleAnchorNodeChg.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #pragma once
  20
  21 #include "pam.hxx"
  22 #include <wrtsh.hxx>
  23
  24 class SwFlyFrameFormat;
  25 class SwFormatAnchor;
  26 class SwFlyFrame;
  27
  28 // helper class to track change of anchor node of at-paragraph respectively
  29 // at-character anchored fly frames
  30 // if such a change happens, it has to be checked, if the count of the anchor
  31 // frames also change. if yes, a re-creation of the fly frames is needed:
  32 // - deletion of existing fly frames before the intrinsic anchor node changes
  33 // - creation of new fly frames after the intrinsic anchor node change.
  34 class SwHandleAnchorNodeChg
  35 {
  36 public:
  37     /** checks, if re-creation of fly frames for an anchor node change at the
  38         given fly frame format is necessary, and performs the first part.
  39
  40         @param _rFlyFrameFormat
  41         reference to the fly frame format instance, which is handled.
  42
  43         @param _rNewAnchorFormat
  44         new anchor attribute, which will be applied at the given fly frame format
  45
  46         @param _pKeepThisFlyFrame
  47         optional parameter - pointer to a fly frame of the given fly frame format,
  48         which isn't deleted, if re-creation of fly frames is necessary.
  49     */
  50     SwHandleAnchorNodeChg(SwFlyFrameFormat& _rFlyFrameFormat,
  51                           const SwFormatAnchor& _rNewAnchorFormat,
  52                           SwFlyFrame const* _pKeepThisFlyFrame = nullptr);
  53
  54     /** calls <SwFlyFrameFormat::MakeFrames>, if re-creation of fly frames is necessary. */
  55     ~SwHandleAnchorNodeChg();
  56
  57 private:
  58     // fly frame format, which is tracked for an anchor node change.
  59     SwFlyFrameFormat& mrFlyFrameFormat;
  60     // internal flag, which indicates that the certain anchor node change occurs
  61     // and that re-creation of fly frames is necessary.
  62     bool mbAnchorNodeChanged;
  63
  64     /// If the fly frame has a comment, this points to the old comment anchor.
  65     std::optional<SwPosition> moCommentAnchor;
  66
  67     SwWrtShell* mpWrtShell;
  68
  69     void ImplDestroy();
  70
  71     SwHandleAnchorNodeChg(const SwHandleAnchorNodeChg&) = delete;
  72     void operator=(const SwHandleAnchorNodeChg) = delete;
  73 };
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */