summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/awt/XImageProducer.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/awt/XImageProducer.idl')
-rw-r--r--offapi/com/sun/star/awt/XImageProducer.idl75
1 files changed, 75 insertions, 0 deletions
diff --git a/offapi/com/sun/star/awt/XImageProducer.idl b/offapi/com/sun/star/awt/XImageProducer.idl
new file mode 100644
index 000000000..d81a90013
--- /dev/null
+++ b/offapi/com/sun/star/awt/XImageProducer.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_awt_XImageProducer_idl__
+#define __com_sun_star_awt_XImageProducer_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+#include <com/sun/star/awt/XImageConsumer.idl>
+
+
+
+ module com { module sun { module star { module awt {
+
+
+/** specifies a source for an image.
+ */
+published interface XImageProducer: com::sun::star::uno::XInterface
+{
+
+ /** registers an image consumer with the image producer for accessing
+ the image data during a later reconstruction of the image.
+
+ <p>The image producer may, at its discretion, start delivering the
+ image data to the consumer using the XImageConsumer
+ interface immediately, or when the next available image reconstruction
+ is triggered by a call to the startProduction method.</p>
+ */
+ void addConsumer( [in] com::sun::star::awt::XImageConsumer xConsumer );
+
+
+ /** removes the given com::sun::star::awt::XImageConsumer
+ callback from the list of consumers currently registered to receive
+ image data.
+
+ <p>It is not considered an error to remove a consumer that is not
+ currently registered. The image producer should stop sending data
+ to this consumer as soon as it is feasible.</p>
+ */
+ void removeConsumer( [in] com::sun::star::awt::XImageConsumer xConsumer );
+
+
+ /** registers the given image consumer as a consumer
+ and starts an immediate reconstruction of the image data.
+
+ <p>The image data will then be delivered to this consumer and any other
+ consumer which may have already been registered with the producer.
+ This method differs from the addConsumer method in that a reproduction of
+ the image data should be triggered as soon as possible.</p>
+ */
+ void startProduction();
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */