1 files changed, 104 insertions, 0 deletions
diff --git a/offapi/com/sun/star/drawing/XSlideRenderer.idl b/offapi/com/sun/star/drawing/XSlideRenderer.idl
new file mode 100644
index 000000000..d5f051602
--- /dev/null
+++ b/offapi/com/sun/star/drawing/XSlideRenderer.idl
@@ -0,0 +1,104 @@
+/* -*- 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_drawing_XSlideRenderer_idl__
+#define __com_sun_star_drawing_XSlideRenderer_idl__
+
+#include <com/sun/star/awt/XBitmap.idl>
+#include <com/sun/star/drawing/XDrawPage.idl>
+#include <com/sun/star/rendering/XBitmap.idl>
+#include <com/sun/star/rendering/XSpriteCanvas.idl>
+
+
+module com { module sun { module star { module drawing {
+
+/** Create preview bitmaps for single slides.
+*/
+interface XSlideRenderer
+{
+    /** Create a preview for the given slide that has the same aspect ratio
+        as the page and is as large as possible but not larger than the
+        specified size.
+
+        The reason for not using the given size directly as preview size and
+        thus possibly changing the aspect ratio is that
+        a) a different aspect ratio is not used often, and
+        b) leaving the adaptation of the actual preview size (according to the
+        aspect ratio of the slide) to the slide renderer is more convenient
+        to the caller than having to this himself.
+
+        @param xSlide
+            The slide for which a preview will be created.
+        @param aMaximumPreviewPixelSize
+            The maximum size of the preview measured in pixels.  When the
+            aspect ratios of this size and of the given slide differ, then
+            resulting preview will either have the width or the height of
+            this size.
+        @param nSuperSampleFactor
+            When larger than the default 1 then internally a larger preview
+            is created which, before it is returned, is scaled down to the
+            requested size.  The intermediate size is nSuperSampleFactor
+            times the original size.  Values larger than 1 result in higher
+            memory consumption and longer runtime.
+            This value is an attempt to provide some antialiasing and so to
+            provide more readable slide previews.  May become obsolete in
+            the future when true antialiasing support will be integrated.
+    */
+    com::sun::star::awt::XBitmap createPreview (
+        [in] XDrawPage xSlide,
+        [in] com::sun::star::awt::Size aMaximumPreviewPixelSize,
+        [in] short nSuperSampleFactor);
+
+    /** Exactly the same functionality as createPreview(),
+        only a different return type:
+        com::sun::star::rendering::XBitmap instead
+        of com::sun::star::awt::XBitmap.
+        @see createPreview
+        @param xSlide
+            See description in #createPreview.
+        @param aMaximumPreviewPixelSize
+            See description in #createPreview.
+        @param nSuperSampleFactor
+            See description in #createPreview.
+        @param xCanvas
+            This canvas is used create a canvas specific bitmap.
+    */
+    com::sun::star::rendering::XBitmap createPreviewForCanvas (
+        [in] XDrawPage xSlide,
+        [in] com::sun::star::awt::Size aMaximumPreviewPixelSize,
+        [in] short nSuperSampleFactor,
+        [in] com::sun::star::rendering::XCanvas xCanvas);
+
+    /** Return a size that has the given aspect ratio and shares either the
+        width or the height with the given maximum size.
+        @param nSlideAspectRatio
+            The aspect ratio must not be 0.
+        @param aMaximumPreviewPixelSize
+            The maximum size of the returned preview size.
+    */
+    com::sun::star::awt::Size calculatePreviewSize (
+        [in] double nSlideAspectRatio,
+        [in] com::sun::star::awt::Size aMaximumPreviewPixelSize);
+};
+
+}; }; }; }; // ::com::sun::star::drawing
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */