Provide tooling for EditView exclusive Primitives

We have the case that e.g. a placeholder Graphic/Text
shall only be processed/shown in the EditView of the
application, but not in any other Primitive-based
usages, including exports, SlideSHow, etc.

I already thought about that when initially converting
Draw/Impress to Primitives, but always found other
solutions, mainly because full XShapes/SdrObjects
had to be taken into account, that can be handled in
VC/VOC/OC implementation. But here we have varying
visualisations of one shape.

Thus I implemented a helper Primitive called
ExclusiveEditViewPrimitive2D. Anything you embed
there will only be processed when the switch to
do so is active in the ViewInformation2D. And
that switch is only set in the EditView paint.

Change-Id: I307f4b0fe7f8faf98789787f216cac7be86a0515
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/165066
Tested-by: Jenkins
Reviewed-by: Armin Le Grand <Armin.Le.Grand@me.com>

8 files changed, 152 insertions, 2 deletions

diff --git a/drawinglayer/Library_drawinglayer.mk b/drawinglayer/Library_drawinglayer.mk
index e5c02487741a..8e5463606dd9 100644
--- a/drawinglayer/Library_drawinglayer.mk
+++ b/drawinglayer/Library_drawinglayer.mk
@@ -112,6 +112,7 @@ $(eval $(call gb_Library_add_exception_objects,drawinglayer,\
     drawinglayer/source/primitive2d/discretebitmapprimitive2d \
     drawinglayer/source/primitive2d/discreteshadowprimitive2d \
     drawinglayer/source/primitive2d/embedded3dprimitive2d \
+    drawinglayer/source/primitive2d/exclusiveeditviewprimitive2d \
     drawinglayer/source/primitive2d/epsprimitive2d \
     drawinglayer/source/primitive2d/fillgraphicprimitive2d \
     drawinglayer/source/primitive2d/fillgradientprimitive2d \
diff --git a/drawinglayer/source/geometry/viewinformation2d.cxx b/drawinglayer/source/geometry/viewinformation2d.cxx
index 50c7c4357b22..296e34a0def2 100644
--- a/drawinglayer/source/geometry/viewinformation2d.cxx
+++ b/drawinglayer/source/geometry/viewinformation2d.cxx
@@ -94,7 +94,10 @@ protected:
     // is important for handling of TextHierarchyEditPrimitive2D to suppress
     // the text for objects in TextEdit - the text is visualized by the
     // active EditEngine/Outliner overlay, so it would be double visualized
-    bool mbTextEditActive;
+    bool mbTextEditActive : 1;
+
+    // processed view is an EditView
+    bool mbEditViewActive : 1;
 
     // allow to reduce DisplayQuality (e.g. sw 3d fallback renderer for interactions)
     bool mbReducedDisplayQuality : 1;
@@ -117,6 +120,7 @@ public:
         , mfViewTime(0.0)
         , maAutoColor(COL_AUTO)
         , mbTextEditActive(false)
+        , mbEditViewActive(false)
         , mbReducedDisplayQuality(false)
         , mbUseAntiAliasing(ViewInformation2D::getGlobalAntiAliasing())
         , mbPixelSnapHairline(mbUseAntiAliasing && bForwardPixelSnapHairline)
@@ -207,6 +211,9 @@ public:
     bool getTextEditActive() const { return mbTextEditActive; }
     void setTextEditActive(bool bNew) { mbTextEditActive = bNew; }
 
+    bool getEditViewActive() const { return mbEditViewActive; }
+    void setEditViewActive(bool bNew) { mbEditViewActive = bNew; }
+
     bool getReducedDisplayQuality() const { return mbReducedDisplayQuality; }
     void setReducedDisplayQuality(bool bNew) { mbReducedDisplayQuality = bNew; }
 
@@ -224,6 +231,7 @@ public:
                 && mxVisualizedPage == rCandidate.mxVisualizedPage
                 && mfViewTime == rCandidate.mfViewTime && maAutoColor == rCandidate.maAutoColor
                 && mbTextEditActive == rCandidate.mbTextEditActive
+                && mbEditViewActive == rCandidate.mbEditViewActive
                 && mbReducedDisplayQuality == rCandidate.mbReducedDisplayQuality
                 && mbUseAntiAliasing == rCandidate.mbUseAntiAliasing
                 && mbPixelSnapHairline == rCandidate.mbPixelSnapHairline);
@@ -374,6 +382,16 @@ void ViewInformation2D::setTextEditActive(bool bNew)
     mpViewInformation2D->setTextEditActive(bNew);
 }
 
+bool ViewInformation2D::getEditViewActive() const
+{
+    return mpViewInformation2D->getEditViewActive();
+}
+
+void ViewInformation2D::setEditViewActive(bool bNew)
+{
+    mpViewInformation2D->setEditViewActive(bNew);
+}
+
 bool ViewInformation2D::getPixelSnapHairline() const
 {
     return mpViewInformation2D->getPixelSnapHairline();
diff --git a/drawinglayer/source/primitive2d/exclusiveeditviewprimitive2d.cxx b/drawinglayer/source/primitive2d/exclusiveeditviewprimitive2d.cxx
new file mode 100644
index 000000000000..a510b97b5b02
--- /dev/null
+++ b/drawinglayer/source/primitive2d/exclusiveeditviewprimitive2d.cxx
@@ -0,0 +1,55 @@
+/* -*- 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 <drawinglayer/primitive2d/exclusiveeditviewprimitive2d.hxx>
+#include <drawinglayer/primitive2d/drawinglayer_primitivetypes2d.hxx>
+
+using namespace com::sun::star;
+
+namespace drawinglayer::primitive2d
+{
+ExclusiveEditViewPrimitive2D::ExclusiveEditViewPrimitive2D(Primitive2DContainer&& aChildren)
+    : GroupPrimitive2D(std::move(aChildren))
+{
+}
+
+basegfx::B2DRange
+ExclusiveEditViewPrimitive2D::getB2DRange(const geometry::ViewInformation2D& rViewInformation) const
+{
+    return getChildren().getB2DRange(rViewInformation);
+}
+
+void ExclusiveEditViewPrimitive2D::get2DDecomposition(
+    Primitive2DDecompositionVisitor& rVisitor,
+    const geometry::ViewInformation2D& rViewInformation) const
+{
+    // check if EditView is visualized. if yes, use content by calling parent class. if no, suppress it
+    if (rViewInformation.getEditViewActive())
+        GroupPrimitive2D::get2DDecomposition(rVisitor, rViewInformation);
+}
+
+// provide unique ID
+sal_uInt32 ExclusiveEditViewPrimitive2D::getPrimitive2DID() const
+{
+    return PRIMITIVE2D_ID_EXCLUSIVEEDITVIEWPRIMITIVE2D;
+}
+
+} // end of namespace
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/include/drawinglayer/geometry/viewinformation2d.hxx b/include/drawinglayer/geometry/viewinformation2d.hxx
index db54aac432fb..13d843aec15c 100644
--- a/include/drawinglayer/geometry/viewinformation2d.hxx
+++ b/include/drawinglayer/geometry/viewinformation2d.hxx
@@ -163,9 +163,14 @@ public:
     Color getAutoColor() const;
     void setAutoColor(Color aNew);
 
+    /// claim that in the view processed a TextEdit is active
     bool getTextEditActive() const;
     void setTextEditActive(bool bNew);
 
+    /// claim that the view processed is an EditView visualization
+    bool getEditViewActive() const;
+    void setEditViewActive(bool bNew);
+
     static void setGlobalAntiAliasing(bool bAntiAliasing, bool bTemporary);
     static bool getGlobalAntiAliasing();
     static void forwardPixelSnapHairline(bool bPixelSnapHairline);
diff --git a/include/drawinglayer/primitive2d/drawinglayer_primitivetypes2d.hxx b/include/drawinglayer/primitive2d/drawinglayer_primitivetypes2d.hxx
index e860476e7e80..f276caa8ec04 100644
--- a/include/drawinglayer/primitive2d/drawinglayer_primitivetypes2d.hxx
+++ b/include/drawinglayer/primitive2d/drawinglayer_primitivetypes2d.hxx
@@ -107,6 +107,7 @@
 #define PRIMITIVE2D_ID_LINERECTANGLEPRIMITIVE2D             (PRIMITIVE2D_ID_RANGE_DRAWINGLAYER| 73)
 #define PRIMITIVE2D_ID_FILLEDRECTANGLEPRIMITIVE2D           (PRIMITIVE2D_ID_RANGE_DRAWINGLAYER| 74)
 #define PRIMITIVE2D_ID_SINGLELINEPRIMITIVE2D                (PRIMITIVE2D_ID_RANGE_DRAWINGLAYER| 75)
+#define PRIMITIVE2D_ID_EXCLUSIVEEDITVIEWPRIMITIVE2D         (PRIMITIVE2D_ID_RANGE_DRAWINGLAYER| 76)
 // When you add a new primitive, please update the drawinglayer::primitive2d::idToString() function
 // in drawinglayer/source/primitive2d/Tools.cxx.
 
diff --git a/include/drawinglayer/primitive2d/exclusiveeditviewprimitive2d.hxx b/include/drawinglayer/primitive2d/exclusiveeditviewprimitive2d.hxx
new file mode 100644
index 000000000000..a919f9dc58da
--- /dev/null
+++ b/include/drawinglayer/primitive2d/exclusiveeditviewprimitive2d.hxx
@@ -0,0 +1,59 @@
+/* -*- 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 .
+ */
+
+#pragma once
+
+#include <drawinglayer/drawinglayerdllapi.h>
+
+#include <drawinglayer/primitive2d/groupprimitive2d.hxx>
+
+namespace drawinglayer::primitive2d
+{
+// This primitive is used to encapsulate geometry that is
+// to be visualized exclusively to the EditView visualization.
+// This is e.g. the case for presentation object placeholder
+// data like the placeholder text or placeholder bitmap, but
+// can and should be used for more content that should only
+// be visible in the EditViews (and not in the exports/SlideShow
+// and other usages). For that purpose it checks using the
+// information provided by ViewInformation2D in get2DDecomposition
+// and decides based on that if the sub-content will be used
+// (returned) or suppressed.
+class DRAWINGLAYER_DLLPUBLIC ExclusiveEditViewPrimitive2D final : public GroupPrimitive2D
+{
+public:
+    explicit ExclusiveEditViewPrimitive2D(Primitive2DContainer&& aChildren);
+
+    // despite returning an empty decomposition in some cases,
+    // range calculation is intended to use hidden geometry, so
+    // the local implementation will return the children's range
+    virtual basegfx::B2DRange
+    getB2DRange(const geometry::ViewInformation2D& rViewInformation) const override;
+
+    /// local decomposition
+    virtual void
+    get2DDecomposition(Primitive2DDecompositionVisitor& rVisitor,
+                       const geometry::ViewInformation2D& rViewInformation) const override;
+
+    // provide unique ID
+    virtual sal_uInt32 getPrimitive2DID() const override;
+};
+} // end of namespace drawinglayer::primitive2d
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/svx/source/sdr/contact/objectcontactofpageview.cxx b/svx/source/sdr/contact/objectcontactofpageview.cxx
index 2143b9ecf8d7..33e3c3a1a637 100644
--- a/svx/source/sdr/contact/objectcontactofpageview.cxx
+++ b/svx/source/sdr/contact/objectcontactofpageview.cxx
@@ -223,6 +223,10 @@ namespace sdr::contact
                 aNewViewInformation2D.setAutoColor(pViewShell->GetColorConfigColor(svtools::DOCCOLOR));
             if (static_cast<SdrPaintView&>(mrPageWindow.GetPageView().GetView()).IsTextEdit())
                 aNewViewInformation2D.setTextEditActive(true);
+
+            // this is the EditView repaint, provide that information
+            aNewViewInformation2D.setEditViewActive(true);
+
             updateViewInformation2D(aNewViewInformation2D);
 
             drawinglayer::primitive2d::Primitive2DContainer xPrimitiveSequence;
diff --git a/svx/source/sdr/contact/viewcontactofgraphic.cxx b/svx/source/sdr/contact/viewcontactofgraphic.cxx
index 1135bd48bc91..f3a18d8e6462 100644
--- a/svx/source/sdr/contact/viewcontactofgraphic.cxx
+++ b/svx/source/sdr/contact/viewcontactofgraphic.cxx
@@ -46,6 +46,7 @@
 #include <editeng/colritem.hxx>
 #include <basegfx/matrix/b2dhommatrixtools.hxx>
 #include <drawinglayer/primitive2d/sdrdecompositiontools2d.hxx>
+#include <drawinglayer/primitive2d/exclusiveeditviewprimitive2d.hxx>
 
 #include <bitmaps.hlst>
 
@@ -128,7 +129,13 @@ namespace sdr::contact
                     rGraphicObject,
                     aLocalGrafInfo));
 
-                xRetval.push_back(xReferenceB);
+                // embed it to a ExclusiveEditViewPrimitive2D to allow to decide in
+                // the primitive if to visualize or not
+                const drawinglayer::primitive2d::Primitive2DReference aEmbedded(
+                    new drawinglayer::primitive2d::ExclusiveEditViewPrimitive2D(
+                        drawinglayer::primitive2d::Primitive2DContainer { xReferenceB } ));
+
+                xRetval.push_back(aEmbedded);
             }
 
             return xRetval;