| LibreOffice
    LibreOffice 24.8 SDK API Reference | 
FilePicker that support the preview of various file formats should implement this interface. More...
import "XFilePreview.idl";
 
  
| Public Member Functions | |
| sequence< short > | getSupportedImageFormats () | 
| The method returns all image formats that the preview supports. | |
| com::sun::star::util::Color | getTargetColorDepth () | 
| The method returns the supported color depth of the target device. | |
| long | getAvailableWidth () | 
| The method returns the available width of the preview window even if the window is invisible or could not be created. | |
| long | getAvailableHeight () | 
| The method returns the available height of the preview window even if the window is invisible or could not be created. | |
| void | setImage ([in] short aImageFormat, [in] any aImage) raises ( ::com::sun::star::lang::IllegalArgumentException ) | 
| Sets a new image. | |
| boolean | setShowState ([in] boolean bShowState) | 
| Optionally sets the current show state of the preview. | |
| boolean | getShowState () | 
| Returns the current show state of the preview. | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) | 
| queries for a new interface to an existing UNO object. | |
| void | acquire () | 
| increases the reference counter by one. | |
| void | release () | 
| decreases the reference counter by one. | |
FilePicker that support the preview of various file formats should implement this interface.
| long 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.
| long 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.
| boolean getShowState | ( | ) | 
Returns the current show state of the preview.
A value of FALSE if the preview window is invisible.
| sequence< short > getSupportedImageFormats | ( | ) | 
The method returns all image formats that the preview supports.
| com::sun::star::util::Color getTargetColorDepth | ( | ) | 
The method returns the supported color depth of the target device.
| void setImage | ( | [in] short | aImageFormat, | |||
| [in] any | aImage ) | |||||
| raises | ( | ::com::sun::star::lang::IllegalArgumentException ) | ||||
Sets a new image.
If the preview is currently hidden the image will be ignored. An empty any will clear the preview window.
| aImageFormat | Specifies the format of the data that will be delivered | 
| aImage | The image data, the image format defines how the image data have to be delivered | 
| com::sun::star::lang::IllegalArgumentException | If the specified image format is invalid or not supported by the preview implementation | 
| boolean setShowState | ( | [in] boolean | bShowState | ) | 
Optionally sets the current show state of the preview.
It is possible that the preview implementation doesn't support hiding the preview.
| bShowState | A value of TRUE shows the preview window. | 
A value of FALSE hides the preview window.
A value of FALSE if the operation fails for any reason or the preview implementation doesn't support hiding the preview.