summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/style/PageProperties.idl
diff options
context:
space:
mode:
authorTomaž Vajngerl <tomaz.vajngerl@collabora.co.uk>2018-04-26 22:04:27 +0900
committerTomaž Vajngerl <quikee@gmail.com>2018-05-07 16:30:35 +0200
commit7a8ed362eb163ac15a000ba1cfc74b58315800a1 (patch)
tree79c1543ac1edd99a7cf3fe7f26573828b4b2be1e /offapi/com/sun/star/style/PageProperties.idl
parent3e7bea5ece847dcd7234f7e7fd310b1daab0eec1 (diff)
[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>
Diffstat (limited to 'offapi/com/sun/star/style/PageProperties.idl')
-rw-r--r--offapi/com/sun/star/style/PageProperties.idl55
1 files changed, 44 insertions, 11 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;