adding public interface for preview

1 files changed, 35 insertions, 0 deletions

diff --git a/lib/public/ipreview.php b/lib/public/ipreview.php
new file mode 100644
index 00000000000..b01e7f5b539
--- /dev/null
+++ b/lib/public/ipreview.php
@@ -0,0 +1,35 @@
+<?php
+/**
+ * Copyright (c) 2013 Frank Karlitschek frank@owncloud.org
+ * Copyright (c) 2013 Georg Ehrke georg@ownCloud.com
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+namespace OCP;
+
+/**
+ * This class provides functions to render and show thumbnails and previews of files
+ */
+interface IPreview
+{
+
+	/**
+	 * @brief return a preview of a file
+	 * @param string $file The path to the file where you want a thumbnail from
+	 * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
+	 * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
+	 * @param boolean $scaleUp Scale smaller images up to the thumbnail size or not. Might look ugly
+	 * @return \OCP\Image
+	 */
+	function createPreview($file, $maxX = 100, $maxY = 75, $scaleUp = false);
+
+
+	/**
+	 * @brief returns true if the passed mime type is supported
+	 * @param string $mimeType
+	 * @return boolean
+	 */
+	function isMimeSupported($mimeType = '*');
+
+}