LibreOffice LibreOffice 26.2 SDK API Reference

XScannerManager.idl
Go to the documentation of this file.
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
22module com { module sun { module star { module scanner {
23
24published interface XScannerManager: com::sun::star::uno::XInterface
25{
26 // DOCUMENTATION CHANGED FOR XScannerManager::getAvailableScanners
29 sequence<com::sun::star::scanner::ScannerContext> getAvailableScanners();
30
35 boolean configureScanner( [inout] com::sun::star::scanner::ScannerContext scannerContext )
36 raises( com::sun::star::scanner::ScannerException );
37
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
50 com::sun::star::scanner::ScanError getError( [in] com::sun::star::scanner::ScannerContext scannerContext )
51 raises( com::sun::star::scanner::ScannerException );
52
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: */
com::sun::star::scanner::ScannerException
A ScannerException gets thrown if an object of type XScannerManager could not complete a specific act...
Definition: ScannerException.idl:28
com::sun::star::awt::XBitmap
provides a bitmap in the Microsoft DIB format.
Definition: XBitmap.idl:28
com::sun::star::lang::XEventListener
base interface for all event listeners interfaces.
Definition: XEventListener.idl:27
com::sun::star::scanner::XScannerManager
Definition: XScannerManager.idl:25
com::sun::star::scanner::XScannerManager::configureScanner
boolean configureScanner([inout] com::sun::star::scanner::ScannerContext scannerContext)
produce some kind of User Interface to let the user have a preview, configure the scan area,...
com::sun::star::scanner::XScannerManager::getAvailableScanners
sequence< com::sun::star::scanner::ScannerContext > getAvailableScanners()
returns all available scanner devices
com::sun::star::scanner::XScannerManager::getError
com::sun::star::scanner::ScanError getError([in] com::sun::star::scanner::ScannerContext scannerContext)
get the state of scanning after completion of scan
com::sun::star::scanner::XScannerManager::getBitmap
com::sun::star::awt::XBitmap getBitmap([in] com::sun::star::scanner::ScannerContext scannerContext)
get the image after completion of scan
com::sun::star::scanner::XScannerManager::startScan
void startScan([in] com::sun::star::scanner::ScannerContext scannerContext, [in] com::sun::star::lang::XEventListener listener)
start the scanning process listener will be called when scan is complete the EventObject of the dispo...
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com::sun::star::scanner::ScanError
ScanError
enum ScanError describes error codes of scanner component
Definition: ScanError.idl:27
com
Definition: Ambiguous.idl:20
com::sun::star::scanner::ScannerContext
a scanner context is an identifier for a specific scanner device
Definition: ScannerContext.idl:27