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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com { module sun { module star { module scanner {
  23
  24 published interface XScannerManager: com::sun::star::uno::XInterface
  25 {
  26     // DOCUMENTATION CHANGED FOR XScannerManager::getAvailableScanners
  27     /** returns all available scanner devices
  28      */
  29     sequence<com::sun::star::scanner::ScannerContext> getAvailableScanners();
  30
  31     /** produce some kind of User Interface to let the user have a preview,
  32         configure the scan area, etc., it
  33         returns FALSE if user cancelled this process
  34     */
  35     boolean configureScanner( [inout] com::sun::star::scanner::ScannerContext scannerContext )
  36             raises( com::sun::star::scanner::ScannerException );
  37
  38     /**start the scanning process
  39         listener will be called when scan is complete
  40         the EventObject of the disposing call will contain
  41         the ScannerManager if the scan was successful,
  42         an empty interface otherwise
  43     */
  44     void startScan( [in] com::sun::star::scanner::ScannerContext scannerContext,
  45              [in] com::sun::star::lang::XEventListener listener )
  46             raises( com::sun::star::scanner::ScannerException );
  47
  48     /**get the state of scanning after completion of scan
  49     */
  50     com::sun::star::scanner::ScanError getError( [in] com::sun::star::scanner::ScannerContext scannerContext )
  51             raises( com::sun::star::scanner::ScannerException );
  52
  53     /**get the image after completion of scan
  54     */
  55     com::sun::star::awt::XBitmap getBitmap( [in] com::sun::star::scanner::ScannerContext scannerContext )
  56             raises( com::sun::star::scanner::ScannerException );
  57
  58 };
  59
  60
  61 }; }; }; };
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */