[API CHANGE] revert and deprecate *BackGraphicURL add *BackGraphic

*BackGraphicURL include the following properties:
- BackGraphicURL
- FooterBackGraphicURL
- HeaderBackGraphicURL
- ParaBackGraphicURL

This were removed, but for backwards compatibility this commit
adds them back again and depreactes them in the UNO API. The
behaviour also changes as internal vnd.sun.star.GraphicObject
scheme URLs aren't supported so this properties can only be set
and only if a external URL is provided. If getting such a property
then a RuntimeException will be thrown.

[ Miklos Vajna: fixed up sw/qa and writerfilter bits. ]

Change-Id: If60011837da96197b576bfe2671ecafccad736c7
Reviewed-on: https://gerrit.libreoffice.org/53511
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Tomaž Vajngerl <quikee@gmail.com>

10 files changed, 188 insertions, 39 deletions

diff --git a/offapi/com/sun/star/style/PageProperties.idl b/offapi/com/sun/star/style/PageProperties.idl
index 7ae84806e1ba..627aa09cb952 100644
--- a/offapi/com/sun/star/style/PageProperties.idl
+++ b/offapi/com/sun/star/style/PageProperties.idl
@@ -29,10 +29,9 @@
 #include <com/sun/star/text/XTextColumns.idl>
 #include <com/sun/star/container/XNameContainer.idl>
 #include <com/sun/star/text/WritingMode2.idl>
+#include <com/sun/star/graphic/XGraphic.idl>
 
-
- module com {  module sun {  module star {  module style {
-
+module com {  module sun {  module star {  module style {
 
 /** describes the style of pages.
  */
@@ -42,14 +41,24 @@ published service PageProperties
      */
     [property] com::sun::star::util::Color BackColor;
 
-    /**
-     */
-    //[property] BackGraphic;
-
     /** contains the URL of the background graphic.
+
+        @deprecated as of LibreOffice 6.1 - use BackGraphic instead
+
+        Note the new behaviour since it this was deprecated:
+        This property can only be set and only external URLs are
+        supported (no more vnd.sun.star.GraphicObject scheme). When an
+        URL is set, then it will load the graphic and set the BackGraphic
+        property.
      */
     [property] string BackGraphicURL;
 
+    /** contains the graphic of the background.
+
+        @since LibreOffice 6.1
+     */
+    [property] com::sun::star::graphic::XGraphic BackGraphic;
+
     /** contains the filter name of the background graphic.
      */
     [property] string BackGraphicFilter;
@@ -169,14 +178,24 @@ published service PageProperties
      */
     [property, maybevoid] com::sun::star::util::Color HeaderBackColor;
 
-    /**
-     */
-    //[property, maybevoid] HeaderBackGraphic;
-
     /** contains the URL of the background graphic of the header.
+
+        @deprecated as of LibreOffice 6.1 - use HeaderBackGraphic instead
+
+        Note the new behaviour since it this was deprecated:
+        This property can only be set and only external URLs are
+        supported (no more vnd.sun.star.GraphicObject scheme). When an
+        URL is set, then it will load the graphic and set the HeaderBackGraphic
+        property.
      */
     [property, maybevoid] string HeaderBackGraphicURL;
 
+    /** contains the graphic of the background of the header.
+
+        @since LibreOffice 6.1
+     */
+    [property, maybevoid] com::sun::star::graphic::XGraphic HeaderBackGraphic;
+
     /** contains the filter name of the background graphic of the header.
      */
     [property, maybevoid] string HeaderBackGraphicFilter;
@@ -279,9 +298,23 @@ published service PageProperties
     [property, maybevoid] com::sun::star::util::Color FooterBackColor;
 
     /** contains the URL of the background graphic in the footer.
+
+        @deprecated as of LibreOffice 6.1 - use FooterBackGraphic
+
+        Note the new behaviour since it this was deprecated:
+        This property can only be set and only external URLs are
+        supported (no more vnd.sun.star.GraphicObject scheme). When an
+        URL is set, then it will load the graphic and set the FooterBackGraphic
+        property.
      */
     [property, maybevoid] string FooterBackGraphicURL;
 
+    /** contains the graphic of the background of the footer.
+
+        @since LibreOffice 6.1
+     */
+    [property, maybevoid] com::sun::star::graphic::XGraphic FooterBackGraphic;
+
     /** contains the filter name of the background graphic in the footer.
      */
     [property, maybevoid] string FooterBackGraphicFilter;
diff --git a/offapi/com/sun/star/style/ParagraphProperties.idl b/offapi/com/sun/star/style/ParagraphProperties.idl
index 2794265c7540..ba7f8b634c80 100644
--- a/offapi/com/sun/star/style/ParagraphProperties.idl
+++ b/offapi/com/sun/star/style/ParagraphProperties.idl
@@ -31,10 +31,9 @@
 #include <com/sun/star/style/BreakType.idl>
 #include <com/sun/star/container/XNameContainer.idl>
 #include <com/sun/star/beans/PropertyValue.idl>
+#include <com/sun/star/graphic/XGraphic.idl>
 
-
- module com {  module sun {  module star {  module style {
-
+module com {  module sun {  module star {  module style {
 
 /** describes the style of paragraphs.
  */
@@ -63,10 +62,17 @@ published service ParagraphProperties
 
 
     /** contains the value of a link for the background graphic of a paragraph.
+
+        @deprecated as of LibreOffice 6.1 - use ParaBackGraphic instead
+
+        Note the new behaviour since it this was deprecated:
+        This property can only be set and only external URLs are
+        supported (no more vnd.sun.star.GraphicObject scheme). When an
+        URL is set, then it will load the graphic and set the ParaBackGraphic
+        property.
      */
     [optional, property] string ParaBackGraphicURL;
 
-
     /** contains the name of the graphic filter for the background graphic of a paragraph.
      */
     [optional, property] string ParaBackGraphicFilter;
@@ -379,6 +385,12 @@ published service ParagraphProperties
             <p>Values [1..10] indicates that the paragraph belongs to the corresponding outline level.</p>
          */
         [optional, property] short OutlineLevel;
+
+        /** contains the graphic for the background of a paragraph.
+
+            @since LibreOffice 6.1
+         */
+        [optional, property] com::sun::star::graphic::XGraphic ParaBackGraphic;
 };
 
 
diff --git a/offapi/com/sun/star/text/BaseFrameProperties.idl b/offapi/com/sun/star/text/BaseFrameProperties.idl
index c441343258f2..677826aec1e7 100644
--- a/offapi/com/sun/star/text/BaseFrameProperties.idl
+++ b/offapi/com/sun/star/text/BaseFrameProperties.idl
@@ -30,10 +30,9 @@
 #include <com/sun/star/drawing/FillStyle.idl>
 #include <com/sun/star/awt/Gradient.idl>
 #include <com/sun/star/drawing/TextVerticalAdjust.hpp>
+#include <com/sun/star/graphic/XGraphic.idl>
 
-
- module com {  module sun {  module star {  module text {
-
+module com {  module sun {  module star {  module text {
 
 /** specifies the properties that are provided by all text frames, graphic objects, embedded objects
  and frame styles.
@@ -56,13 +55,29 @@ published service BaseFrameProperties
         AnchorType is TextContentAnchorType::AT_FRAME.</p>
      */
     [property] com::sun::star::text::XTextFrame AnchorFrame;
+
     /** contains the color of the background of the object.
      */
     [property] com::sun::star::util::Color BackColor;
+
     /** contains the URL for the background graphic.
+
+        @deprecated as of LibreOffice 6.1 - use BackGraphic instead
+
+        Note the new behaviour since it this was deprecated:
+        This property can only be set and only external URLs are
+        supported (no more vnd.sun.star.GraphicObject scheme). When an
+        URL is set, then it will load the graphic and set the BackGraphic
+        property.
      */
     [property] string BackGraphicURL;
 
+    /** contains the graphic for the background.
+
+        @since LibreOffice 6.1
+    */
+    [property] com::sun::star::graphic::XGraphic BackGraphic;
+
     /** contains the name of the file filter for the background graphic.
      */
     [property] string BackGraphicFilter;
diff --git a/offapi/com/sun/star/text/BaseIndex.idl b/offapi/com/sun/star/text/BaseIndex.idl
index 9e75ee555216..39baa42eb935 100644
--- a/offapi/com/sun/star/text/BaseIndex.idl
+++ b/offapi/com/sun/star/text/BaseIndex.idl
@@ -17,7 +17,6 @@
  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  */
 
-
 #ifndef __com_sun_star_text_BaseIndex_idl__
 #define __com_sun_star_text_BaseIndex_idl__
 
@@ -29,9 +28,9 @@
 #include <com/sun/star/style/GraphicLocation.idl>
 #include <com/sun/star/lang/Locale.idl>
 #include <com/sun/star/text/XTextSection.idl>
+#include <com/sun/star/graphic/XGraphic.idl>
 
-
- module com {  module sun {  module star {  module text {
+module com {  module sun {  module star {  module text {
 
 /** specifies the basic service of different indexes within a document.@see com::sun::star::text::DocumentIndex
         @see com::sun::star::text::ContentIndex
@@ -77,8 +76,25 @@ published service BaseIndex
     [optional, property] string ParaStyleSeparator;
     /** contains the column interface.*/
     [property] XTextColumns TextColumns;
-    /** contains the URL of a graphic file that is displayed as background graphic*/
+
+    /** contains the URL of a graphic file that is displayed as background graphic
+
+        @deprecated as of LibreOffice 6.1 - use BackGraphic instead
+
+        Note the new behaviour since it this was deprecated:
+        This property can only be set and only external URLs are
+        supported (no more vnd.sun.star.GraphicObject scheme). When an
+        URL is set, then it will load the graphic and set the BackGraphic
+        property.
+    */
     [property] string BackGraphicURL;
+
+    /** contains the graphic object that is displayed as background graphic.
+
+        @since LibreOffice 6.1
+    */
+    [property] com::sun::star::graphic::XGraphic BackGraphic;
+
     /** contains the name of the filter of the graphic file that is
          displayed as background graphic*/
     [property] string BackGraphicFilter;
diff --git a/offapi/com/sun/star/text/CellProperties.idl b/offapi/com/sun/star/text/CellProperties.idl
index 6144d9fc8530..8e7f0ae35ca0 100644
--- a/offapi/com/sun/star/text/CellProperties.idl
+++ b/offapi/com/sun/star/text/CellProperties.idl
@@ -16,6 +16,7 @@
  *   except in compliance with the License. You may obtain a copy of
  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  */
+
 #ifndef __com_sun_star_text_CellProperties_idl__
 #define __com_sun_star_text_CellProperties_idl__
 
@@ -26,11 +27,9 @@
 #include <com/sun/star/table/BorderLine.idl>
 #include <com/sun/star/container/XNameContainer.idl>
 #include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
+#include <com/sun/star/graphic/XGraphic.idl>
 
-
-
- module com {  module sun {  module star {  module text {
-
+module com {  module sun {  module star {  module text {
 
 /** service that holds all cell properties of a text table cell in a text document.
 
@@ -58,9 +57,23 @@ published service CellProperties
     [property] com::sun::star::util::Color BackColor;
 
     /** contains the URL to the background graphic.
+
+        @deprecated as of LibreOffice 6.1 - use BackGraphic instead
+
+        Note the new behaviour since it this was deprecated:
+        This property can only be set and only external URLs are
+        supported (no more vnd.sun.star.GraphicObject scheme). When an
+        URL is set, then it will load the graphic and set the BackGraphic
+        property.
      */
     [property] string BackGraphicURL;
 
+    /** contains the graphic object that is displayed as background graphic.
+
+        @since LibreOffice 6.1
+     */
+    [property] com::sun::star::graphic::XGraphic BackGraphic;
+
     /** contains the name of the graphic filter of the background graphic.
      */
     [property] string BackGraphicFilter;
diff --git a/offapi/com/sun/star/text/CellRange.idl b/offapi/com/sun/star/text/CellRange.idl
index e99f32b6f14a..161b3452f2f0 100644
--- a/offapi/com/sun/star/text/CellRange.idl
+++ b/offapi/com/sun/star/text/CellRange.idl
@@ -16,6 +16,7 @@
  *   except in compliance with the License. You may obtain a copy of
  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  */
+
 #ifndef __com_sun_star_text_CellRange_idl__
 #define __com_sun_star_text_CellRange_idl__
 
@@ -31,11 +32,10 @@
 #include <com/sun/star/style/CharacterProperties.idl>
 #include <com/sun/star/style/GraphicLocation.idl>
 #include <com/sun/star/chart/XChartDataArray.idl>
-
+#include <com/sun/star/graphic/XGraphic.idl>
 
 module com {  module sun {  module star {  module text {
 
-
 /** area of cells within a text table.
 
     @see com::sun::star::text::TextTable
@@ -77,9 +77,22 @@ published service CellRange
 
 
     /** contains the URL of the background graphic.
+
+        @deprecated as of LibreOffice 6.1 - use BackGraphic instead
+
+        Note the new behaviour since it this was deprecated:
+        This property can only be set and only external URLs are
+        supported (no more vnd.sun.star.GraphicObject scheme). When an
+        URL is set, then it will load the graphic and set the BackGraphic
+        property.
      */
     [property] string BackGraphicURL;
 
+    /** contains the graphic of the background.
+
+        @since LibreOffice 6.1
+     */
+    [property] com::sun::star::graphic::XGraphic BackGraphic;
 
     /** determines if the background color is transparent.
      */
diff --git a/offapi/com/sun/star/text/TextSection.idl b/offapi/com/sun/star/text/TextSection.idl
index 5394f7229930..d6baa829c633 100644
--- a/offapi/com/sun/star/text/TextSection.idl
+++ b/offapi/com/sun/star/text/TextSection.idl
@@ -28,8 +28,7 @@
 #include <com/sun/star/style/GraphicLocation.idl>
 #include <com/sun/star/text/XTextColumns.idl>
 #include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
-
-
+#include <com/sun/star/graphic/XGraphic.idl>
 
 module com { module sun { module star { module text {
 
@@ -101,10 +100,24 @@ published service TextSection
     */
     [property] string DDECommandElement;
 
-    /**  contains the URL for the background graphic.
+    /** contains the URL for the background graphic.
+
+        @deprecated as of LibreOffice 6.1 - use BackGraphic instead
+
+        Note the new behaviour since it this was deprecated:
+        This property can only be set and only external URLs are
+        supported (no more vnd.sun.star.GraphicObject scheme). When an
+        URL is set, then it will load the graphic and set the BackGraphic
+        property.
     */
     [property] string BackGraphicURL;
 
+    /** contains the graphic of the background.
+
+        @since LibreOffice 6.1
+     */
+    [property] com::sun::star::graphic::XGraphic BackGraphic;
+
     /**  contains the name of the file filter for the background graphic.
     */
     [property] string BackGraphicFilter;
diff --git a/offapi/com/sun/star/text/TextTable.idl b/offapi/com/sun/star/text/TextTable.idl
index e47ad56c4aee..ee6fc85f4eb9 100644
--- a/offapi/com/sun/star/text/TextTable.idl
+++ b/offapi/com/sun/star/text/TextTable.idl
@@ -16,6 +16,7 @@
  *   except in compliance with the License. You may obtain a copy of
  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  */
+
 #ifndef __com_sun_star_text_TextTable_idl__
 #define __com_sun_star_text_TextTable_idl__
 
@@ -35,11 +36,9 @@
 #include <com/sun/star/util/XSortable.idl>
 #include <com/sun/star/sheet/XCellRangeData.idl>
 #include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
+#include <com/sun/star/graphic/XGraphic.idl>
 
-
-
- module com {  module sun {  module star {  module text {
-
+module com {  module sun {  module star {  module text {
 
 /** is a table of text cells which is anchored to a surrounding text.
 
@@ -192,9 +191,22 @@ published service TextTable
     [property] com::sun::star::util::Color BackColor;
 
     /** contains the URL for the background graphic.
+
+        @deprecated as of LibreOffice 6.1 - use BackGraphic instead
+
+        Note the new behaviour since it this was deprecated:
+        This property can only be set and only external URLs are
+        supported (no more vnd.sun.star.GraphicObject scheme). When an
+        URL is set, then it will load the graphic and set the BackGraphic
+        property.
      */
     [property] string BackGraphicURL;
 
+    /** contains the graphic for the background.
+
+        @since LibreOffice 6.1
+     */
+    [property] com::sun::star::graphic::XGraphic BackGraphic;
 
     /** contains the name of the file filter for the background graphic.
      */
diff --git a/offapi/com/sun/star/text/TextTableRow.idl b/offapi/com/sun/star/text/TextTableRow.idl
index 1755068cdd0e..42198943af34 100644
--- a/offapi/com/sun/star/text/TextTableRow.idl
+++ b/offapi/com/sun/star/text/TextTableRow.idl
@@ -23,11 +23,9 @@
 #include <com/sun/star/util/Color.idl>
 #include <com/sun/star/style/GraphicLocation.idl>
 #include <com/sun/star/text/TableColumnSeparator.idl>
+#include <com/sun/star/graphic/XGraphic.idl>
 
-
-
- module com {  module sun {  module star {  module text {
-
+module com {  module sun {  module star {  module text {
 
 /** specifies the properties of a text table row.
 
@@ -49,9 +47,22 @@ published service TextTableRow
 
 
     /** contains the URL of a background graphic.
+
+        @deprecated as of LibreOffice 6.1 - use BackGraphic instead
+
+        Note the new behaviour since it this was deprecated:
+        This property can only be set and only external URLs are
+        supported (no more vnd.sun.star.GraphicObject scheme). When an
+        URL is set, then it will load the graphic and set the BackGraphic
+        property.
      */
     [property] string BackGraphicURL;
 
+    /** contains the graphic of a background.
+
+        @since LibreOffice 6.1
+     */
+    [property] com::sun::star::graphic::XGraphic BackGraphic;
 
     /** contains the name of the file filter of a background graphic.
      */
diff --git a/offapi/type_reference/offapi.idl b/offapi/type_reference/offapi.idl
index 337a45812b29..f49b0267ed48 100644
--- a/offapi/type_reference/offapi.idl
+++ b/offapi/type_reference/offapi.idl
@@ -3643,6 +3643,7 @@ module com {
      [property, maybevoid, optional] boolean ParaIsConnectBorder;
      [property, optional] string ListId;
      [property, optional] short OutlineLevel;
+     [property, optional] ::com::sun::star::graphic::XGraphic ParaBackGraphic;
     };
    };
    module util {
@@ -13134,6 +13135,7 @@ module com {
     published service PageProperties {
      [property] ::com::sun::star::util::Color BackColor;
      [property] string BackGraphicURL;
+     [property] ::com::sun::star::graphic::XGraphic BackGraphic;
      [property] string BackGraphicFilter;
      [property] ::com::sun::star::style::GraphicLocation BackGraphicLocation;
      [property] boolean BackTransparent;
@@ -13163,6 +13165,7 @@ module com {
      [property] ::com::sun::star::container::XNameContainer UserDefinedAttributes;
      [property, maybevoid] ::com::sun::star::util::Color HeaderBackColor;
      [property, maybevoid] string HeaderBackGraphicURL;
+     [property, maybevoid] ::com::sun::star::graphic::XGraphic HeaderBackGraphic;
      [property, maybevoid] string HeaderBackGraphicFilter;
      [property, maybevoid] ::com::sun::star::style::GraphicLocation HeaderBackGraphicLocation;
      [property, maybevoid] long HeaderLeftMargin;
@@ -13188,6 +13191,7 @@ module com {
      [property, maybevoid, optional] ::com::sun::star::text::XText HeaderTextRight;
      [property, maybevoid] ::com::sun::star::util::Color FooterBackColor;
      [property, maybevoid] string FooterBackGraphicURL;
+     [property, maybevoid] ::com::sun::star::graphic::XGraphic FooterBackGraphic;
      [property, maybevoid] string FooterBackGraphicFilter;
      [property, maybevoid] ::com::sun::star::style::GraphicLocation FooterBackGraphicLocation;
      [property, maybevoid] long FooterLeftMargin;
@@ -13837,6 +13841,7 @@ module com {
      [property] ::com::sun::star::text::XTextFrame AnchorFrame;
      [property] ::com::sun::star::util::Color BackColor;
      [property] string BackGraphicURL;
+     [property] ::com::sun::star::graphic::XGraphic BackGraphic;
      [property] string BackGraphicFilter;
      [property] ::com::sun::star::style::GraphicLocation BackGraphicLocation;
      [property] ::com::sun::star::table::BorderLine LeftBorder;
@@ -13925,6 +13930,7 @@ module com {
      [property, optional] string ParaStyleSeparator;
      [property] ::com::sun::star::text::XTextColumns TextColumns;
      [property] string BackGraphicURL;
+     [property] ::com::sun::star::graphic::XGraphic BackGraphic;
      [property] string BackGraphicFilter;
      [property] ::com::sun::star::style::GraphicLocation BackGraphicLocation;
      [property] ::com::sun::star::util::Color BackColor;
@@ -14015,6 +14021,7 @@ module com {
      [property] string CellName;
      [property] ::com::sun::star::util::Color BackColor;
      [property] string BackGraphicURL;
+     [property] ::com::sun::star::graphic::XGraphic BackGraphic;
      [property] string BackGraphicFilter;
      [property] ::com::sun::star::style::GraphicLocation BackGraphicLocation;
      [property] long NumberFormat;
@@ -14045,6 +14052,7 @@ module com {
      [property] string BackGraphicFilter;
      [property] ::com::sun::star::style::GraphicLocation BackGraphicLocation;
      [property] string BackGraphicURL;
+     [property] ::com::sun::star::graphic::XGraphic BackGraphic;
      [property] boolean BackTransparent;
      [property] boolean ChartColumnAsLabel;
      [property] boolean ChartRowAsLabel;
@@ -14631,6 +14639,7 @@ module com {
      [property] short TableColumnRelativeSum;
      [property] ::com::sun::star::util::Color BackColor;
      [property] string BackGraphicURL;
+     [property] ::com::sun::star::graphic::XGraphic BackGraphic;
      [property] string BackGraphicFilter;
      [property] ::com::sun::star::style::GraphicLocation BackGraphicLocation;
      [property, optional] boolean CollapsingBorders;
@@ -15042,6 +15051,7 @@ module com {
      [property] string DDECommandFile;
      [property] string DDECommandElement;
      [property] string BackGraphicURL;
+     [property] ::com::sun::star::graphic::XGraphic BackGraphic;
      [property] string BackGraphicFilter;
      [property] ::com::sun::star::style::GraphicLocation BackGraphicLocation;
      [property] boolean FootnoteIsCollectAtTextEnd;
@@ -15116,6 +15126,7 @@ module com {
      [property] ::com::sun::star::util::Color BackColor;
      [property] boolean BackTransparent;
      [property] string BackGraphicURL;
+     [property] ::com::sun::star::graphic::XGraphic BackGraphic;
      [property] string BackGraphicFilter;
      [property] ::com::sun::star::style::GraphicLocation BackGraphicLocation;
      [property] sequence< ::com::sun::star::text::TableColumnSeparator > TableColumnSeparators;