|
LibreOffice
LibreOffice 24.2 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. More... | |
| com::sun::star::util::Color | getTargetColorDepth () |
| The method returns the supported color depth of the target device. More... | |
| long | getAvailableWidth () |
| The method returns the available width of the preview window even if the window is invisible or could not be created. More... | |
| long | getAvailableHeight () |
| The method returns the available height of the preview window even if the window is invisible or could not be created. More... | |
| void | setImage ([in] short aImageFormat, [in] any aImage) raises ( ::com::sun::star::lang::IllegalArgumentException ) |
| Sets a new image. More... | |
| boolean | setShowState ([in] boolean bShowState) |
| Optionally sets the current show state of the preview. More... | |
| boolean | getShowState () |
| Returns the current show state of the preview. More... | |
Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More... | |
| void | acquire () |
| increases the reference counter by one. More... | |
| void | release () |
| decreases the reference counter by one. More... | |
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.
TRUE if the preview window is visible. 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.
TRUE on success. A value of FALSE if the operation fails for any reason or the preview implementation doesn't support hiding the preview.
1.8.14