interface XFilePreview in module com::sun::star::ui::dialogs::

(Global Index)

Syntax

interface XFilePreview : com::sun::star::uno::XInterface ;

Description

FilePicker that support the preview of various file formats should implement this interface.

Method 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.

Known Services Which Export this Interface

com::sun::star::ui::dialogs::FilePicker

Method Details



getSupportedImageFormats

Syntax

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

Syntax

long 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

Syntax

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

Syntax

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 heigth of the preview window in pixel.

setImage

Syntax

void setImage (
short aImageFormat,
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

Syntax

boolean setShowState (
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 vaue of false if the operation fails for any reason or the preview implementation doesn't support hiding the preview.


getShowState

Syntax

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