1d1766043SAndrew Rist/**************************************************************
2*c754630cSmseidel *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*c754630cSmseidel *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*c754630cSmseidel *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19*c754630cSmseidel *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_ui_dialogs_XFilePreview_idl__
25cdf0e10cSrcweir#define __com_sun_star_ui_dialogs_XFilePreview_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir#ifndef __com_sun_star_util_Color_idl__
32cdf0e10cSrcweir#include <com/sun/star/util/Color.idl>
33cdf0e10cSrcweir#endif
34cdf0e10cSrcweir
35cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
36cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
37cdf0e10cSrcweir#endif
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweirmodule com { module sun { module star { module ui { module dialogs {
42cdf0e10cSrcweir
43cdf0e10cSrcweir//=============================================================================
44cdf0e10cSrcweir/** FilePicker that support the preview of various file formats should implement
45cdf0e10cSrcweir	this interface.
46cdf0e10cSrcweir*/
47cdf0e10cSrcweir
48cdf0e10cSrcweirpublished interface XFilePreview: com::sun::star::uno::XInterface
49cdf0e10cSrcweir{
50cdf0e10cSrcweir	//-------------------------------------------------------------------------
51cdf0e10cSrcweir	/** The method returns all image formats that the preview supports.
52cdf0e10cSrcweir
53*c754630cSmseidel		@returns
54cdf0e10cSrcweir		A sequence of all supported preview formats
55*c754630cSmseidel
56cdf0e10cSrcweir		@see com::sun::star::ui::dialogs::FilePreviewImageFormats
57*c754630cSmseidel	*/
58cdf0e10cSrcweir	sequence< short > getSupportedImageFormats( );
59cdf0e10cSrcweir
60cdf0e10cSrcweir	//-------------------------------------------------------------------------
61cdf0e10cSrcweir	/** The method returns the supported color depth of the target device.
62*c754630cSmseidel
63cdf0e10cSrcweir		@returns
64cdf0e10cSrcweir		The color depth in bit, e.g. 8 bit, 16 bit, 32 bit.
65cdf0e10cSrcweir	*/
66cdf0e10cSrcweir	com::sun::star::util::Color getTargetColorDepth( );
67cdf0e10cSrcweir
68cdf0e10cSrcweir	//-------------------------------------------------------------------------
69cdf0e10cSrcweir	/** The method returns the available width of the preview window
70cdf0e10cSrcweir		even if the window is invisible or could not be created.
71cdf0e10cSrcweir		If a service implementation doesn't support a file preview
72cdf0e10cSrcweir		0 will be returned.
73cdf0e10cSrcweir
74cdf0e10cSrcweir		@returns
75cdf0e10cSrcweir		The width of the preview window in pixel.
76cdf0e10cSrcweir	*/
77cdf0e10cSrcweir	long getAvailableWidth( );
78cdf0e10cSrcweir
79cdf0e10cSrcweir	//-------------------------------------------------------------------------
80cdf0e10cSrcweir	/** The method returns the available height of the preview window
81cdf0e10cSrcweir		even if the window is invisible or could not be created.
82cdf0e10cSrcweir		If a service implementation doesn't support a file preview
83cdf0e10cSrcweir		0 will be returned.
84cdf0e10cSrcweir
85cdf0e10cSrcweir		@returns
86*c754630cSmseidel		The height of the preview window in pixel.
87cdf0e10cSrcweir	*/
88cdf0e10cSrcweir	long getAvailableHeight( );
89cdf0e10cSrcweir
90cdf0e10cSrcweir	//-------------------------------------------------------------------------
91*c754630cSmseidel	/** Sets a new image. If the preview is currently hidden the
92cdf0e10cSrcweir		image will be ignored. An empty any will clear the preview window.
93cdf0e10cSrcweir
94cdf0e10cSrcweir		@param aImageFormat
95cdf0e10cSrcweir		Specifies the format of the data that will be delivered
96*c754630cSmseidel
97cdf0e10cSrcweir		@param aImage
98cdf0e10cSrcweir		The image data, the image format defines how
99cdf0e10cSrcweir		the image data have to be delivered
100cdf0e10cSrcweir
101cdf0e10cSrcweir		@throws com::sun::star::lang::IllegalArgumentException
102cdf0e10cSrcweir		If the specified image format is invalid or not
103cdf0e10cSrcweir		supported by the preview implementation
104cdf0e10cSrcweir
105*c754630cSmseidel		@see com::sun::star::ui::dialogs::FilePreviewImageFormats
106cdf0e10cSrcweir	*/
107cdf0e10cSrcweir	void setImage( [in] short aImageFormat, [in] any aImage )
108cdf0e10cSrcweir		raises( ::com::sun::star::lang::IllegalArgumentException );
109cdf0e10cSrcweir
110cdf0e10cSrcweir	//-------------------------------------------------------------------------
111cdf0e10cSrcweir	/** Optionally sets the current show state of the preview. It is possible
112cdf0e10cSrcweir		that the preview implementation doesn't support hiding the preview.
113cdf0e10cSrcweir
114cdf0e10cSrcweir		@param bShowState
115cdf0e10cSrcweir		A value of <TRUE/> shows the preview window.
116cdf0e10cSrcweir		<p>A value of <FALSE/> hides the preview window.</p>
117cdf0e10cSrcweir
118cdf0e10cSrcweir		@returns
119cdf0e10cSrcweir		A value of <TRUE/> on success.
120*c754630cSmseidel		<p>A value of <FALSE/> if the operation fails for any reason or the preview
121cdf0e10cSrcweir		implementation doesn't support hiding the preview.</p>
122cdf0e10cSrcweir	*/
123cdf0e10cSrcweir	boolean setShowState( [in] boolean bShowState );
124cdf0e10cSrcweir
125cdf0e10cSrcweir	//-------------------------------------------------------------------------
126cdf0e10cSrcweir	/** Returns the current show state of the preview.
127cdf0e10cSrcweir
128cdf0e10cSrcweir		@returns
129cdf0e10cSrcweir		A value of <TRUE/> if the preview window is visible.
130cdf0e10cSrcweir		<p>A value of <FALSE/> if the preview window is invisible.</p>
131cdf0e10cSrcweir	*/
132cdf0e10cSrcweir	boolean getShowState( );
133cdf0e10cSrcweir};
134cdf0e10cSrcweir
135cdf0e10cSrcweir//=============================================================================
136cdf0e10cSrcweir
137cdf0e10cSrcweir}; }; }; }; };
138cdf0e10cSrcweir
139cdf0e10cSrcweir#endif
140