<html> <head> <title>Interface XFilePreview</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XFilePreview-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">ui</a> :: <a href="module-ix.html" class="namechain">dialogs</a> :: </p> </td> </tr> <tr> <td class="title">interface XFilePreview</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>FilePicker that support the preview of various file formats should implement this interface. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getSupportedImageFormats">getSupportedImageFormats</a></td> <td class="imsum_right">The method returns all image formats that the preview supports. </td> </tr> <tr> <td class="imsum_left"><a href="#getTargetColorDepth">getTargetColorDepth</a></td> <td class="imsum_right">The method returns the supported color depth of the target device. </td> </tr> <tr> <td class="imsum_left"><a href="#getAvailableWidth">getAvailableWidth</a></td> <td class="imsum_right">The method returns the available width of the preview window even if the window is invisible or could not be created. If a service implementation doesn't support a file preview 0 will be returned. </td> </tr> <tr> <td class="imsum_left"><a href="#getAvailableHeight">getAvailableHeight</a></td> <td class="imsum_right">The method returns the available height of the preview window even if the window is invisible or could not be created. If a service implementation doesn't support a file preview 0 will be returned. </td> </tr> <tr> <td class="imsum_left"><a href="#setImage">setImage</a></td> <td class="imsum_right">Sets a new image. If the preview is currently hidden the image will be ignored. An empty any will clear the preview window. </td> </tr> <tr> <td class="imsum_left"><a href="#setShowState">setShowState</a></td> <td class="imsum_right">Optionally sets the current show state of the preview. It is possible that the preview implementation doesn't support hiding the preview. </td> </tr> <tr> <td class="imsum_left"><a href="#getShowState">getShowState</a></td> <td class="imsum_right">Returns the current show state of the preview. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getSupportedImageFormats" class="membertitle">getSupportedImageFormats</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< short ></td> </tr> <tr> <td valign="top"><b>getSupportedImageFormats</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>The method returns all image formats that the preview supports. </dd> <dt><b>Returns</b></dt> <dd>A sequence of all supported preview formats </dd> <dt><b>See also</b></dt> <dd><a href="FilePreviewImageFormats.html">FilePreviewImageFormats</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getTargetColorDepth" class="membertitle">getTargetColorDepth</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/Color.html">Color</a></td> </tr> <tr> <td valign="top"><b>getTargetColorDepth</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>The method returns the supported color depth of the target device. </dd> <dt><b>Returns</b></dt> <dd>The color depth in bit, e.g. 8 bit, 16 bit, 32 bit. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAvailableWidth" class="membertitle">getAvailableWidth</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getAvailableWidth</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>The method returns the available width of the preview window even if the window is invisible or could not be created. If a service implementation doesn't support a file preview 0 will be returned. </dd> <dt><b>Returns</b></dt> <dd>The width of the preview window in pixel. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAvailableHeight" class="membertitle">getAvailableHeight</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getAvailableHeight</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>The method returns the available height of the preview window even if the window is invisible or could not be created. If a service implementation doesn't support a file preview 0 will be returned. </dd> <dt><b>Returns</b></dt> <dd>The heigth of the preview window in pixel. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setImage" class="membertitle">setImage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setImage</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> aImageFormat,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> aImage )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Sets a new image. If the preview is currently hidden the image will be ignored. An empty any will clear the preview window. </dd> <dt><b>Parameter aImageFormat</b></dt> <dd>Specifies the format of the data that will be delivered </dd> <dt><b>Parameter aImage</b></dt> <dd>The image data, the image format defines how the image data have to be delivered </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException If the specified image format is invalid or not supported by the preview implementation </dd> <dt><b>See also</b></dt> <dd><a href="FilePreviewImageFormats.html">FilePreviewImageFormats</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setShowState" class="membertitle">setShowState</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>setShowState</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bShowState );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Optionally sets the current show state of the preview. It is possible that the preview implementation doesn't support hiding the preview. </dd> <dt><b>Parameter bShowState</b></dt> <dd>A value of <b>true</b> shows the preview window. <p>A value of <b>false</b> hides the preview window.</p> </dd> <dt><b>Returns</b></dt> <dd>A value of <b>true</b> on success. <p>A value of <b>false</b> if the operation fails for any reason or the preview implementation doesn't support hiding the preview.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getShowState" class="membertitle">getShowState</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>getShowState</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the current show state of the preview. </dd> <dt><b>Returns</b></dt> <dd>A value of <b>true</b> if the preview window is visible. <p>A value of <b>false</b> if the preview window is invisible.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
