Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: ui :: dialogs ::
interface XFilePreview
Description FilePicker that support the preview of various file formats should implement this interface.

Methods' Summary
getSupportedImageFormats | The method returns all image formats that the preview supports.
getTargetColorDepth | The method returns the supported color depth of the target device.
getAvailableWidth | 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.
getAvailableHeight | 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.
setImage | Sets a new image. If the preview is currently hidden the image will be ignored. An empty any will clear the preview window.
setShowState | Optionally sets the current show state of the preview. It is possible that the preview implementation doesn't support hiding the preview.
getShowState | Returns the current show state of the preview.

Methods' Details
getSupportedImageFormats
sequence< short >
getSupportedImageFormats();
Description The method returns all image formats that the preview supports. Returns A sequence of all supported preview formats See also FilePreviewImageFormats
getTargetColorDepth
::com::sun::star::util::Color
getTargetColorDepth();
Description The method returns the supported color depth of the target device. Returns The color depth in bit, e.g. 8 bit, 16 bit, 32 bit.
getAvailableWidth
long
getAvailableWidth();
Description 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. Returns The width of the preview window in pixel.
getAvailableHeight
long
getAvailableHeight();
Description 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. Returns The height of the preview window in pixel.
setImage
void
setImage( | [in] short | aImageFormat,
| [in] any | aImage )
raises( | ::com::sun::star::lang::IllegalArgumentException );
Description Sets a new image. If the preview is currently hidden the image will be ignored. An empty any will clear the preview window. Parameter aImageFormat Specifies the format of the data that will be delivered Parameter aImage The image data, the image format defines how the image data have to be delivered Throws com::sun::star::lang::IllegalArgumentException If the specified image format is invalid or not supported by the preview implementation See also FilePreviewImageFormats
setShowState
boolean
setShowState( | [in] boolean | bShowState );
Description Optionally sets the current show state of the preview. It is possible that the preview implementation doesn't support hiding the preview. Parameter bShowState A value of true shows the preview window. A value of false hides the preview window. Returns A value of true on success. A value of false if the operation fails for any reason or the preview implementation doesn't support hiding the preview.
getShowState
boolean
getShowState();
Description Returns the current show state of the preview. Returns A value of true if the preview window is visible. A value of false if the preview window is invisible.

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "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 trademark policy.