summaryrefslogtreecommitdiff
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.idl92
1 files changed, 92 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 000000000000..48c18cb0b864
--- /dev/null
+++ b/offapi/com/sun/star/report/XImageControl.idl
@@ -0,0 +1,92 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_report_XImageControl_idl__
+#define __com_sun_star_report_XImageControl_idl__
+
+#ifndef __com_sun_star_report_XReportControlModel_idl__
+#include <com/sun/star/report/XReportControlModel.idl>
+#endif
+#ifndef __com_sun_star_form_XImageProducerSupplier_idl__
+#include <com/sun/star/form/XImageProducerSupplier.idl>
+#endif
+
+//=============================================================================
+
+ module com { module sun { module star { module report {
+
+//=============================================================================
+interface XImageControl
+{
+ interface XReportControlModel;
+
+ /** supplies the caller with an <type scope="com::sun::star::awt">XImageProducer</type>.
+
+ <p>Other components can register as <type scope="com::sun::star::awt">XImageConsumer</type>
+ at this producer. Then they will be notified of any change in the image to be displayed.</p>
+
+ <p>Whenever the <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member>
+ property is changed, the model loads the specified image, and sets it as image source
+ at its <type scope="com::sun::star::awt">XImageProducer</type>. Then, all
+ <type scope="com::sun::star::awt">XImageConsumer</type>s are notified and supplied with
+ the binary data of the image.<br/>
+ Usually, controls acting for an <type>ImageControl</type> model are consumers, and use the
+ data stream to display the image</p>
+ */
+ interface com::sun::star::form::XImageProducerSupplier;
+
+ /** specifies an 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 <member>ScaleImage</member> property.</p>
+
+ <p>The value of this property is one of the <type scope="com::sun::star::awt">ImageScaleMode</type> 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;
+};
+
+service ImageControl : XImageControl;
+//=============================================================================
+
+}; }; }; };
+
+/*=============================================================================
+
+=============================================================================*/
+#endif