summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/report/XImageControl.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/report/XImageControl.idl')
-rw-r--r--offapi/com/sun/star/report/XImageControl.idl75
1 files changed, 75 insertions, 0 deletions
diff --git a/offapi/com/sun/star/report/XImageControl.idl b/offapi/com/sun/star/report/XImageControl.idl
new file mode 100644
index 000000000..6701aa86b
--- /dev/null
+++ b/offapi/com/sun/star/report/XImageControl.idl
@@ -0,0 +1,75 @@
+/* -*- 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 .
+ */
+#ifndef __com_sun_star_report_XImageControl_idl__
+#define __com_sun_star_report_XImageControl_idl__
+
+#include <com/sun/star/report/XReportControlModel.idl>
+#include <com/sun/star/form/XImageProducerSupplier.idl>
+
+
+ module com { module sun { module star { module report {
+
+interface XImageControl
+{
+ interface XReportControlModel;
+
+ /** supplies the caller with a com::sun::star::awt::XImageProducer.
+
+ <p>Other components can register as com::sun::star::awt::XImageConsumer
+ at this producer. Then they will be notified of any change in the image to be displayed.</p>
+
+ <p>Whenever the com::sun::star::awt::UnoControlImageControlModel::ImageURL
+ property is changed, the model loads the specified image, and sets it as image source
+ at its com::sun::star::awt::XImageProducer. Then, all
+ com::sun::star::awt::XImageConsumers are notified and supplied with
+ the binary data of the image.<br/>
+ Usually, controls acting for an ImageControl model are consumers, and use the
+ data stream to display the image</p>
+ */
+ interface com::sun::star::form::XImageProducerSupplier;
+
+ /** specifies a URL to an image to use for the control.
+ */
+ [attribute,bound] string ImageURL;
+
+ /** defines how to scale the image
+
+ <p>If this property is present, it supersedes the ScaleImage property.</p>
+
+ <p>The value of this property is one of the com::sun::star::awt::ImageScaleMode constants.</p>
+
+ @since OOo 3.2
+ */
+ [attribute,bound] short ScaleMode
+ {
+ set raises (com::sun::star::lang::IllegalArgumentException);
+ };
+
+ /** Specifies that the IRI given in the data field should be preserved, otherwise the content will be inserted in the resulting report document.
+ If the data field contains something different as string then this attribute will be ignored.
+ */
+ [attribute,bound] boolean PreserveIRI;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */