1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/*************************************************************************
*
* $RCSfile: XFilePreview.idl,v $
*
* $Revision: 1.1 $
*
* last change: $Author: tra $ $Date: 2001-08-30 10:21:07 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_ui_dialogs_XFilePreview_idl__
#define __com_sun_star_ui_dialogs_XFilePreview_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
//=============================================================================
module com { module sun { module star { module ui { module dialogs {
//=============================================================================
/**
*/
interface XFilePreview: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** The method returns all image formats that the preview supports.
@returns
a sequence of all supported preview formats
@see ::com::sun::star::ui::dialogs::PreviewImageFormats
*/
sequence< short > getSupportedImageFormats( );
//-------------------------------------------------------------------------
/** 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
*/
long getTargetColorDepth( );
//-------------------------------------------------------------------------
/** 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
*/
long getAvailableWidth( );
//-------------------------------------------------------------------------
/** 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.
@param
the heigth of the preview window in pixel
*/
long getAvailableHeight( );
//-------------------------------------------------------------------------
/** Sets a new image. If the preview is currently hidden the
image will be ignored. An empty any will clear the preview window.
@param aImageFormat
specifies the format of the data that will be delivered
@param 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 ::com::sun::star::ui::dialogs::PreviewImageFormats
*/
void setImage( [in] short aImageFormat, [in] any aImage )
raises( ::com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** Optionally sets the current show state of the preview. It is possible
that the preview implementation doesn't support hiding the preview.
@param bShowState
True shows the preview window.
False hides the preview window.
@returns
True on success.
False if the operation fails for any reason or the preview
implementation doesn't support hiding the preview.
*/
boolean setShowState( [in] boolean bShowState );
//-------------------------------------------------------------------------
/** Returns the current show state of the preview.
@returns
True if the preview window is visible.
False if the preview window is invisible.
*/
boolean getShowState( );
};
//=============================================================================
}; }; }; }; };
#endif
|
