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
- com::sun::star::ui::dialogs::FilePreviewImageFormats
|
- getTargetColorDepth
-  
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
-  
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 heigth 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
- com::sun::star::ui::dialogs::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 vaue 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.
|
Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.