Watermark: Insert watermark command

* added new command .uno:Watermark
* if no arguments are provided the dialog
  is opened where user can enter the text
* with provided Text argument the watermark
  is created
* created SfxWatermarkItem to transfer
  watermark properties
* dialog loads current setings
* SetClassification use SetWatermark

Change-Id: Ifc1319f5aa7c11bb141f8e4b5b9a5088613021c2
Reviewed-on: https://gerrit.libreoffice.org/37599
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Szymon Kłos <szymon.klos@collabora.com>

1 files changed, 189 insertions, 121 deletions

diff --git a/sw/source/core/edit/edfcol.cxx b/sw/source/core/edit/edfcol.cxx
index 5277af00a11b..029eb57be727 100644
--- a/sw/source/core/edit/edfcol.cxx
+++ b/sw/source/core/edit/edfcol.cxx
@@ -58,6 +58,7 @@
 #include <unoprnms.hxx>
 #include <rootfrm.hxx>
 #include <pagefrm.hxx>
+#include <sfx2/watermarkitem.hxx>
 
 namespace
 {
@@ -228,127 +229,7 @@ void SwEditShell::SetClassification(const OUString& rName, SfxClassificationPoli
                 }
             }
 
-            if (bWatermarkIsNeeded || bHadWatermark)
-            {
-                OUString aShapeServiceName = "com.sun.star.drawing.CustomShape";
-                static const OUString sWatermark = SfxClassificationHelper::PROP_PREFIX_INTELLECTUALPROPERTY() + SfxClassificationHelper::PROP_DOCWATERMARK();
-                uno::Reference<drawing::XShape> xWatermark = lcl_getWatermark(xHeaderText, aShapeServiceName, sWatermark);
-
-                bool bDeleteWatermark = bHadWatermark && !bWatermarkIsNeeded;
-                if (xWatermark.is())
-                {
-                    // If the header already contains a watermark, see if it its text is up to date.
-                    uno::Reference<text::XTextRange> xTextRange(xWatermark, uno::UNO_QUERY);
-                    if (xTextRange->getString() != aWatermark || bDeleteWatermark)
-                    {
-                        // No: delete it and we'll insert a replacement.
-                        uno::Reference<lang::XComponent> xComponent(xWatermark, uno::UNO_QUERY);
-                        xComponent->dispose();
-                        xWatermark.clear();
-                    }
-                }
-
-                if (!xWatermark.is() && bWatermarkIsNeeded)
-                {
-                    // Calc the ratio.
-                    double fRatio = 0;
-                    OutputDevice* pOut = Application::GetDefaultDevice();
-                    vcl::Font aFont(pOut->GetFont());
-                    fRatio = aFont.GetFontSize().Height();
-                    fRatio /= pOut->GetTextWidth(aWatermark);
-
-                    // Calc the size.
-                    sal_Int32 nWidth = 0;
-                    awt::Size aSize;
-                    xPageStyle->getPropertyValue(UNO_NAME_SIZE) >>= aSize;
-                    if (aSize.Width < aSize.Height)
-                    {
-                        // Portrait.
-                        sal_Int32 nLeftMargin = 0;
-                        xPageStyle->getPropertyValue(UNO_NAME_LEFT_MARGIN) >>= nLeftMargin;
-                        sal_Int32 nRightMargin = 0;
-                        xPageStyle->getPropertyValue(UNO_NAME_RIGHT_MARGIN) >>= nRightMargin;
-                        nWidth = aSize.Width - nLeftMargin - nRightMargin;
-                    }
-                    else
-                    {
-                        // Landscape.
-                        sal_Int32 nTopMargin = 0;
-                        xPageStyle->getPropertyValue(UNO_NAME_TOP_MARGIN) >>= nTopMargin;
-                        sal_Int32 nBottomMargin = 0;
-                        xPageStyle->getPropertyValue(UNO_NAME_BOTTOM_MARGIN) >>= nBottomMargin;
-                        nWidth = aSize.Height - nTopMargin - nBottomMargin;
-                    }
-                    sal_Int32 nHeight = nWidth * fRatio;
-
-                    // Create and insert the shape.
-                    uno::Reference<drawing::XShape> xShape(xMultiServiceFactory->createInstance(aShapeServiceName), uno::UNO_QUERY);
-                    basegfx::B2DHomMatrix aTransformation;
-                    aTransformation.identity();
-                    aTransformation.scale(nWidth, nHeight);
-                    aTransformation.rotate(F_PI180 * -45);
-                    drawing::HomogenMatrix3 aMatrix;
-                    aMatrix.Line1.Column1 = aTransformation.get(0, 0);
-                    aMatrix.Line1.Column2 = aTransformation.get(0, 1);
-                    aMatrix.Line1.Column3 = aTransformation.get(0, 2);
-                    aMatrix.Line2.Column1 = aTransformation.get(1, 0);
-                    aMatrix.Line2.Column2 = aTransformation.get(1, 1);
-                    aMatrix.Line2.Column3 = aTransformation.get(1, 2);
-                    aMatrix.Line3.Column1 = aTransformation.get(2, 0);
-                    aMatrix.Line3.Column2 = aTransformation.get(2, 1);
-                    aMatrix.Line3.Column3 = aTransformation.get(2, 2);
-                    uno::Reference<beans::XPropertySet> xPropertySet(xShape, uno::UNO_QUERY);
-                    xPropertySet->setPropertyValue(UNO_NAME_ANCHOR_TYPE, uno::makeAny(text::TextContentAnchorType_AT_CHARACTER));
-                    uno::Reference<text::XTextContent> xTextContent(xShape, uno::UNO_QUERY);
-                    xHeaderText->insertTextContent(xHeaderText->getEnd(), xTextContent, false);
-
-                    // The remaining properties have to be set after the shape is inserted: do that in one batch to avoid flickering.
-                    uno::Reference<document::XActionLockable> xLockable(xShape, uno::UNO_QUERY);
-                    xLockable->addActionLock();
-                    xPropertySet->setPropertyValue(UNO_NAME_FILLCOLOR, uno::makeAny(static_cast<sal_Int32>(0xc0c0c0)));
-                    xPropertySet->setPropertyValue(UNO_NAME_FILLSTYLE, uno::makeAny(drawing::FillStyle_SOLID));
-                    xPropertySet->setPropertyValue(UNO_NAME_FILL_TRANSPARENCE, uno::makeAny(static_cast<sal_Int16>(50)));
-                    xPropertySet->setPropertyValue(UNO_NAME_HORI_ORIENT_RELATION, uno::makeAny(static_cast<sal_Int16>(text::RelOrientation::PAGE_PRINT_AREA)));
-                    xPropertySet->setPropertyValue(UNO_NAME_LINESTYLE, uno::makeAny(drawing::LineStyle_NONE));
-                    xPropertySet->setPropertyValue(UNO_NAME_OPAQUE, uno::makeAny(false));
-                    xPropertySet->setPropertyValue(UNO_NAME_TEXT_AUTOGROWHEIGHT, uno::makeAny(false));
-                    xPropertySet->setPropertyValue(UNO_NAME_TEXT_AUTOGROWWIDTH, uno::makeAny(false));
-                    xPropertySet->setPropertyValue(UNO_NAME_TEXT_MINFRAMEHEIGHT, uno::makeAny(nHeight));
-                    xPropertySet->setPropertyValue(UNO_NAME_TEXT_MINFRAMEWIDTH, uno::makeAny(nWidth));
-                    xPropertySet->setPropertyValue(UNO_NAME_TEXT_WRAP, uno::makeAny(text::WrapTextMode_THROUGHT));
-                    xPropertySet->setPropertyValue(UNO_NAME_VERT_ORIENT_RELATION, uno::makeAny(static_cast<sal_Int16>(text::RelOrientation::PAGE_PRINT_AREA)));
-                    xPropertySet->setPropertyValue(UNO_NAME_CHAR_FONT_NAME, uno::makeAny(OUString("Liberation Sans")));
-                    xPropertySet->setPropertyValue("Transformation", uno::makeAny(aMatrix));
-                    xPropertySet->setPropertyValue(UNO_NAME_HORI_ORIENT, uno::makeAny(static_cast<sal_Int16>(text::HoriOrientation::CENTER)));
-                    xPropertySet->setPropertyValue(UNO_NAME_VERT_ORIENT, uno::makeAny(static_cast<sal_Int16>(text::VertOrientation::CENTER)));
-
-                    uno::Reference<text::XTextRange> xTextRange(xShape, uno::UNO_QUERY);
-                    xTextRange->setString(aWatermark);
-
-                    uno::Reference<drawing::XEnhancedCustomShapeDefaulter> xDefaulter(xShape, uno::UNO_QUERY);
-                    xDefaulter->createCustomShapeDefaults("fontwork-plain-text");
-
-                    auto aGeomPropSeq = xPropertySet->getPropertyValue("CustomShapeGeometry").get< uno::Sequence<beans::PropertyValue> >();
-                    auto aGeomPropVec = comphelper::sequenceToContainer< std::vector<beans::PropertyValue> >(aGeomPropSeq);
-                    uno::Sequence<beans::PropertyValue> aPropertyValues(comphelper::InitPropertySequence(
-                    {
-                        {"TextPath", uno::makeAny(true)},
-                    }));
-                    auto it = std::find_if(aGeomPropVec.begin(), aGeomPropVec.end(), [](const beans::PropertyValue& rValue)
-                    {
-                        return rValue.Name == "TextPath";
-                    });
-                    if (it == aGeomPropVec.end())
-                        aGeomPropVec.push_back(comphelper::makePropertyValue("TextPath", aPropertyValues));
-                    else
-                        it->Value <<= aPropertyValues;
-                    xPropertySet->setPropertyValue("CustomShapeGeometry", uno::makeAny(comphelper::containerToSequence(aGeomPropVec)));
-
-                    uno::Reference<container::XNamed> xNamed(xShape, uno::UNO_QUERY);
-                    xNamed->setName(SfxClassificationHelper::PROP_PREFIX_INTELLECTUALPROPERTY() + SfxClassificationHelper::PROP_DOCWATERMARK());
-                    xLockable->removeActionLock();
-                }
-            }
+            SetWatermark(aWatermark);
         }
 
         if (bFooterIsNeeded)
@@ -375,6 +256,193 @@ void SwEditShell::SetClassification(const OUString& rName, SfxClassificationPoli
     }
 }
 
+SfxWatermarkItem SwEditShell::GetWatermark()
+{
+    SwDocShell* pDocShell = GetDoc()->GetDocShell();
+    if (!pDocShell)
+        return SfxWatermarkItem(SID_WATERMARK, "");
+
+    uno::Reference<frame::XModel> xModel = pDocShell->GetBaseModel();
+    uno::Reference<style::XStyleFamiliesSupplier> xStyleFamiliesSupplier(xModel, uno::UNO_QUERY);
+    uno::Reference<container::XNameAccess> xStyleFamilies(xStyleFamiliesSupplier->getStyleFamilies(), uno::UNO_QUERY);
+    uno::Reference<container::XNameAccess> xStyleFamily(xStyleFamilies->getByName("PageStyles"), uno::UNO_QUERY);
+    std::set<OUString> aUsedPageStyles = lcl_getUsedPageStyles(this);
+    for (const OUString& rPageStyleName : aUsedPageStyles)
+    {
+        uno::Reference<beans::XPropertySet> xPageStyle(xStyleFamily->getByName(rPageStyleName), uno::UNO_QUERY);
+        uno::Reference<lang::XMultiServiceFactory> xMultiServiceFactory(xModel, uno::UNO_QUERY);
+
+        bool bHeaderIsOn = false;
+        xPageStyle->getPropertyValue(UNO_NAME_HEADER_IS_ON) >>= bHeaderIsOn;
+        if (!bHeaderIsOn)
+            xPageStyle->setPropertyValue(UNO_NAME_HEADER_IS_ON, uno::makeAny(true));
+
+        uno::Reference<text::XText> xHeaderText;
+        xPageStyle->getPropertyValue(UNO_NAME_HEADER_TEXT) >>= xHeaderText;
+
+        OUString aShapeServiceName = "com.sun.star.drawing.CustomShape";
+        static const OUString sWatermark = SfxClassificationHelper::PROP_PREFIX_INTELLECTUALPROPERTY() + SfxClassificationHelper::PROP_DOCWATERMARK();
+        uno::Reference<drawing::XShape> xWatermark = lcl_getWatermark(xHeaderText, aShapeServiceName, sWatermark);
+
+        if (xWatermark.is())
+        {
+            uno::Reference<text::XTextRange> xTextRange(xWatermark, uno::UNO_QUERY);
+            return SfxWatermarkItem(SID_WATERMARK, xTextRange->getString());
+        }
+    }
+    return SfxWatermarkItem(SID_WATERMARK, "");
+}
+
+void SwEditShell::SetWatermark(const OUString& rWatermark)
+{
+    SwDocShell* pDocShell = GetDoc()->GetDocShell();
+    if (!pDocShell)
+        return;
+
+    SfxClassificationHelper aHelper(pDocShell->getDocProperties());
+
+    uno::Reference<frame::XModel> xModel = pDocShell->GetBaseModel();
+    uno::Reference<style::XStyleFamiliesSupplier> xStyleFamiliesSupplier(xModel, uno::UNO_QUERY);
+    uno::Reference<container::XNameAccess> xStyleFamilies(xStyleFamiliesSupplier->getStyleFamilies(), uno::UNO_QUERY);
+    uno::Reference<container::XNameAccess> xStyleFamily(xStyleFamilies->getByName("PageStyles"), uno::UNO_QUERY);
+
+    std::set<OUString> aUsedPageStyles = lcl_getUsedPageStyles(this);
+    for (const OUString& rPageStyleName : aUsedPageStyles)
+    {
+        uno::Reference<beans::XPropertySet> xPageStyle(xStyleFamily->getByName(rPageStyleName), uno::UNO_QUERY);
+        uno::Reference<lang::XMultiServiceFactory> xMultiServiceFactory(xModel, uno::UNO_QUERY);
+
+        // If the header is off, turn it on.
+        bool bHeaderIsOn = false;
+        xPageStyle->getPropertyValue(UNO_NAME_HEADER_IS_ON) >>= bHeaderIsOn;
+        if (!bHeaderIsOn)
+            xPageStyle->setPropertyValue(UNO_NAME_HEADER_IS_ON, uno::makeAny(true));
+
+        // If the header already contains a document header field, no need to do anything.
+        uno::Reference<text::XText> xHeaderText;
+        xPageStyle->getPropertyValue(UNO_NAME_HEADER_TEXT) >>= xHeaderText;
+
+        OUString aShapeServiceName = "com.sun.star.drawing.CustomShape";
+        static const OUString sWatermark = SfxClassificationHelper::PROP_PREFIX_INTELLECTUALPROPERTY() + SfxClassificationHelper::PROP_DOCWATERMARK();
+        uno::Reference<drawing::XShape> xWatermark = lcl_getWatermark(xHeaderText, aShapeServiceName, sWatermark);
+
+        bool bDeleteWatermark = rWatermark.isEmpty();
+        if (xWatermark.is())
+        {
+            // If the header already contains a watermark, see if it its text is up to date.
+            uno::Reference<text::XTextRange> xTextRange(xWatermark, uno::UNO_QUERY);
+            if (xTextRange->getString() != rWatermark || bDeleteWatermark)
+            {
+                // No: delete it and we'll insert a replacement.
+                uno::Reference<lang::XComponent> xComponent(xWatermark, uno::UNO_QUERY);
+                xComponent->dispose();
+                xWatermark.clear();
+            }
+        }
+
+        if (!xWatermark.is() && !bDeleteWatermark)
+        {
+            // Calc the ratio.
+            double fRatio = 0;
+            OutputDevice* pOut = Application::GetDefaultDevice();
+            vcl::Font aFont(pOut->GetFont());
+            fRatio = aFont.GetFontSize().Height();
+            fRatio /= pOut->GetTextWidth(rWatermark);
+
+            // Calc the size.
+            sal_Int32 nWidth = 0;
+            awt::Size aSize;
+            xPageStyle->getPropertyValue(UNO_NAME_SIZE) >>= aSize;
+            if (aSize.Width < aSize.Height)
+            {
+                // Portrait.
+                sal_Int32 nLeftMargin = 0;
+                xPageStyle->getPropertyValue(UNO_NAME_LEFT_MARGIN) >>= nLeftMargin;
+                sal_Int32 nRightMargin = 0;
+                xPageStyle->getPropertyValue(UNO_NAME_RIGHT_MARGIN) >>= nRightMargin;
+                nWidth = aSize.Width - nLeftMargin - nRightMargin;
+            }
+            else
+            {
+                // Landscape.
+                sal_Int32 nTopMargin = 0;
+                xPageStyle->getPropertyValue(UNO_NAME_TOP_MARGIN) >>= nTopMargin;
+                sal_Int32 nBottomMargin = 0;
+                xPageStyle->getPropertyValue(UNO_NAME_BOTTOM_MARGIN) >>= nBottomMargin;
+                nWidth = aSize.Height - nTopMargin - nBottomMargin;
+            }
+            sal_Int32 nHeight = nWidth * fRatio;
+
+            // Create and insert the shape.
+            uno::Reference<drawing::XShape> xShape(xMultiServiceFactory->createInstance(aShapeServiceName), uno::UNO_QUERY);
+            basegfx::B2DHomMatrix aTransformation;
+            aTransformation.identity();
+            aTransformation.scale(nWidth, nHeight);
+            aTransformation.rotate(F_PI180 * -45);
+            drawing::HomogenMatrix3 aMatrix;
+            aMatrix.Line1.Column1 = aTransformation.get(0, 0);
+            aMatrix.Line1.Column2 = aTransformation.get(0, 1);
+            aMatrix.Line1.Column3 = aTransformation.get(0, 2);
+            aMatrix.Line2.Column1 = aTransformation.get(1, 0);
+            aMatrix.Line2.Column2 = aTransformation.get(1, 1);
+            aMatrix.Line2.Column3 = aTransformation.get(1, 2);
+            aMatrix.Line3.Column1 = aTransformation.get(2, 0);
+            aMatrix.Line3.Column2 = aTransformation.get(2, 1);
+            aMatrix.Line3.Column3 = aTransformation.get(2, 2);
+            uno::Reference<beans::XPropertySet> xPropertySet(xShape, uno::UNO_QUERY);
+            xPropertySet->setPropertyValue(UNO_NAME_ANCHOR_TYPE, uno::makeAny(text::TextContentAnchorType_AT_CHARACTER));
+            uno::Reference<text::XTextContent> xTextContent(xShape, uno::UNO_QUERY);
+            xHeaderText->insertTextContent(xHeaderText->getEnd(), xTextContent, false);
+
+            // The remaining properties have to be set after the shape is inserted: do that in one batch to avoid flickering.
+            uno::Reference<document::XActionLockable> xLockable(xShape, uno::UNO_QUERY);
+            xLockable->addActionLock();
+            xPropertySet->setPropertyValue(UNO_NAME_FILLCOLOR, uno::makeAny(static_cast<sal_Int32>(0xc0c0c0)));
+            xPropertySet->setPropertyValue(UNO_NAME_FILLSTYLE, uno::makeAny(drawing::FillStyle_SOLID));
+            xPropertySet->setPropertyValue(UNO_NAME_FILL_TRANSPARENCE, uno::makeAny(static_cast<sal_Int16>(50)));
+            xPropertySet->setPropertyValue(UNO_NAME_HORI_ORIENT_RELATION, uno::makeAny(static_cast<sal_Int16>(text::RelOrientation::PAGE_PRINT_AREA)));
+            xPropertySet->setPropertyValue(UNO_NAME_LINESTYLE, uno::makeAny(drawing::LineStyle_NONE));
+            xPropertySet->setPropertyValue(UNO_NAME_OPAQUE, uno::makeAny(false));
+            xPropertySet->setPropertyValue(UNO_NAME_TEXT_AUTOGROWHEIGHT, uno::makeAny(false));
+            xPropertySet->setPropertyValue(UNO_NAME_TEXT_AUTOGROWWIDTH, uno::makeAny(false));
+            xPropertySet->setPropertyValue(UNO_NAME_TEXT_MINFRAMEHEIGHT, uno::makeAny(nHeight));
+            xPropertySet->setPropertyValue(UNO_NAME_TEXT_MINFRAMEWIDTH, uno::makeAny(nWidth));
+            xPropertySet->setPropertyValue(UNO_NAME_TEXT_WRAP, uno::makeAny(text::WrapTextMode_THROUGH));
+            xPropertySet->setPropertyValue(UNO_NAME_VERT_ORIENT_RELATION, uno::makeAny(static_cast<sal_Int16>(text::RelOrientation::PAGE_PRINT_AREA)));
+            xPropertySet->setPropertyValue(UNO_NAME_CHAR_FONT_NAME, uno::makeAny(OUString("Liberation Sans")));
+            xPropertySet->setPropertyValue("Transformation", uno::makeAny(aMatrix));
+            xPropertySet->setPropertyValue(UNO_NAME_HORI_ORIENT, uno::makeAny(static_cast<sal_Int16>(text::HoriOrientation::CENTER)));
+            xPropertySet->setPropertyValue(UNO_NAME_VERT_ORIENT, uno::makeAny(static_cast<sal_Int16>(text::VertOrientation::CENTER)));
+
+            uno::Reference<text::XTextRange> xTextRange(xShape, uno::UNO_QUERY);
+            xTextRange->setString(rWatermark);
+
+            uno::Reference<drawing::XEnhancedCustomShapeDefaulter> xDefaulter(xShape, uno::UNO_QUERY);
+            xDefaulter->createCustomShapeDefaults("fontwork-plain-text");
+
+            auto aGeomPropSeq = xPropertySet->getPropertyValue("CustomShapeGeometry").get< uno::Sequence<beans::PropertyValue> >();
+            auto aGeomPropVec = comphelper::sequenceToContainer< std::vector<beans::PropertyValue> >(aGeomPropSeq);
+            uno::Sequence<beans::PropertyValue> aPropertyValues(comphelper::InitPropertySequence(
+            {
+                {"TextPath", uno::makeAny(true)},
+            }));
+            auto it = std::find_if(aGeomPropVec.begin(), aGeomPropVec.end(), [](const beans::PropertyValue& rValue)
+            {
+                return rValue.Name == "TextPath";
+            });
+            if (it == aGeomPropVec.end())
+                aGeomPropVec.push_back(comphelper::makePropertyValue("TextPath", aPropertyValues));
+            else
+                it->Value <<= aPropertyValues;
+            xPropertySet->setPropertyValue("CustomShapeGeometry", uno::makeAny(comphelper::containerToSequence(aGeomPropVec)));
+
+            uno::Reference<container::XNamed> xNamed(xShape, uno::UNO_QUERY);
+            xNamed->setName(SfxClassificationHelper::PROP_PREFIX_INTELLECTUALPROPERTY() + SfxClassificationHelper::PROP_DOCWATERMARK());
+            xLockable->removeActionLock();
+        }
+    }
+}
+
 // #i62675#
 void SwEditShell::SetTextFormatColl(SwTextFormatColl *pFormat,
                                 const bool bResetListAttrs)