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

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