1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_scanner_XScannerManager_idl__
28#define __com_sun_star_scanner_XScannerManager_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_scanner_ScannerContext_idl__
35#include <com/sun/star/scanner/ScannerContext.idl>
36#endif
37
38#ifndef __com_sun_star_scanner_ScannerException_idl__
39#include <com/sun/star/scanner/ScannerException.idl>
40#endif
41
42#ifndef __com_sun_star_lang_XEventListener_idl__
43#include <com/sun/star/lang/XEventListener.idl>
44#endif
45
46#ifndef __com_sun_star_scanner_ScanError_idl__
47#include <com/sun/star/scanner/ScanError.idl>
48#endif
49
50#ifndef __com_sun_star_awt_XBitmap_idl__
51#include <com/sun/star/awt/XBitmap.idl>
52#endif
53
54
55//=============================================================================
56
57module com { module sun { module star { module scanner {
58
59//=============================================================================
60/**
61*/
62published interface XScannerManager: com::sun::star::uno::XInterface
63{
64	//-------------------------------------------------------------------------
65	// DOCUMENTATION CHANGED FOR XScannerManager::getAvailableScanners
66	/** returns all avilable scanner devices
67	 */
68	sequence<com::sun::star::scanner::ScannerContext> getAvailableScanners();
69
70	//-------------------------------------------------------------------------
71	/** produce some kind of User Interface to let the user have a preview,
72		configure the scan area, etc., it
73		returns FALSE if user cancelled this process
74	*/
75	boolean configureScanner( [inout] com::sun::star::scanner::ScannerContext scanner_context )
76			raises( com::sun::star::scanner::ScannerException );
77
78	//-------------------------------------------------------------------------
79	/**start the scanning process
80		listener will be called when scan is complete
81		the EventObject of the disposing call will contain
82		the ScannerManager if the scan was successfull,
83		an empty interface otherwise
84	*/
85	void startScan( [in] com::sun::star::scanner::ScannerContext scanner_context,
86			 [in] com::sun::star::lang::XEventListener listener )
87			raises( com::sun::star::scanner::ScannerException );
88
89	//-------------------------------------------------------------------------
90	/**get the state of scanning after completion of scan
91	*/
92	com::sun::star::scanner::ScanError getError( [in] com::sun::star::scanner::ScannerContext scanner_context )
93			raises( com::sun::star::scanner::ScannerException );
94
95	//-------------------------------------------------------------------------
96	/**get the image after completion of scan
97	*/
98	com::sun::star::awt::XBitmap getBitmap( [in] com::sun::star::scanner::ScannerContext scanner_context )
99			raises( com::sun::star::scanner::ScannerException );
100
101};
102
103//=============================================================================
104
105}; }; }; };
106
107#endif
108