1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_scanner_XScannerManager_idl__
24#define __com_sun_star_scanner_XScannerManager_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_scanner_ScannerContext_idl__
31#include <com/sun/star/scanner/ScannerContext.idl>
32#endif
33
34#ifndef __com_sun_star_scanner_ScannerException_idl__
35#include <com/sun/star/scanner/ScannerException.idl>
36#endif
37
38#ifndef __com_sun_star_lang_XEventListener_idl__
39#include <com/sun/star/lang/XEventListener.idl>
40#endif
41
42#ifndef __com_sun_star_scanner_ScanError_idl__
43#include <com/sun/star/scanner/ScanError.idl>
44#endif
45
46#ifndef __com_sun_star_awt_XBitmap_idl__
47#include <com/sun/star/awt/XBitmap.idl>
48#endif
49
50
51//=============================================================================
52
53module com { module sun { module star { module scanner {
54
55//=============================================================================
56/**
57*/
58published interface XScannerManager: com::sun::star::uno::XInterface
59{
60	//-------------------------------------------------------------------------
61	// DOCUMENTATION CHANGED FOR XScannerManager::getAvailableScanners
62	/** returns all available scanner devices
63	 */
64	sequence<com::sun::star::scanner::ScannerContext> getAvailableScanners();
65
66	//-------------------------------------------------------------------------
67	/** produce some kind of User Interface to let the user have a preview,
68		configure the scan area, etc., it
69		returns FALSE if user cancelled this process
70	*/
71	boolean configureScanner( [inout] com::sun::star::scanner::ScannerContext scanner_context )
72			raises( com::sun::star::scanner::ScannerException );
73
74	//-------------------------------------------------------------------------
75	/**start the scanning process
76		listener will be called when scan is complete
77		the EventObject of the disposing call will contain
78		the ScannerManager if the scan was successful,
79		an empty interface otherwise
80	*/
81	void startScan( [in] com::sun::star::scanner::ScannerContext scanner_context,
82			 [in] com::sun::star::lang::XEventListener listener )
83			raises( com::sun::star::scanner::ScannerException );
84
85	//-------------------------------------------------------------------------
86	/**get the state of scanning after completion of scan
87	*/
88	com::sun::star::scanner::ScanError getError( [in] com::sun::star::scanner::ScannerContext scanner_context )
89			raises( com::sun::star::scanner::ScannerException );
90
91	//-------------------------------------------------------------------------
92	/**get the image after completion of scan
93	*/
94	com::sun::star::awt::XBitmap getBitmap( [in] com::sun::star::scanner::ScannerContext scanner_context )
95			raises( com::sun::star::scanner::ScannerException );
96
97};
98
99//=============================================================================
100
101}; }; }; };
102
103#endif
104