offapi/com/sun/star/scanner/XScannerManager.idl

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