Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: scanner ::

interface XScannerManager

Base Interface
com::sun::star::uno::XInterface

Description


Known Services which Export this Interface

com::sun::star::scanner::ScannerManager ScannerManager provides a simple method to access scanner devices (or other image producing devices)

Methods' Summary

getAvailableScanners returns all avilable scanner devices
configureScanner produce some kind of User Interface to let the user have a preview, configure the scan area, etc., it returns FALSE if user cancelled this process
startScan start the scanning process listener will be called when scan is complete the EventObject of the disposing call will contain the ScannerManager if the scan was successfull, an empty interface otherwise
getError get the state of scanning after completion of scan
getBitmap get the image after completion of scan

Methods' Details

getAvailableScanners
 
sequence< com::sun::star::scanner::ScannerContext >
getAvailableScanners();
Description
returns all avilable scanner devices
configureScanner
 
boolean
configureScanner(
[ inout ] com::sun::star::scanner::ScannerContext scanner_context )
raises ( com::sun::star::scanner::ScannerException );

Description
produce some kind of User Interface to let the user have a preview, configure the scan area, etc., it returns FALSE if user cancelled this process
startScan
 
void
startScan(
[ in ] com::sun::star::scanner::ScannerContext scanner_context,
[ in ] com::sun::star::lang::XEventListener listener )
raises ( com::sun::star::scanner::ScannerException );

Description
start the scanning process listener will be called when scan is complete the EventObject of the disposing call will contain the ScannerManager if the scan was successfull, an empty interface otherwise
getError
 
com::sun::star::scanner::ScanError
getError(
[ in ] com::sun::star::scanner::ScannerContext scanner_context )
raises ( com::sun::star::scanner::ScannerException );

Description
get the state of scanning after completion of scan
getBitmap
 
com::sun::star::awt::XBitmap
getBitmap(
[ in ] com::sun::star::scanner::ScannerContext scanner_context )
raises ( com::sun::star::scanner::ScannerException );

Description
get the image after completion of scan

Top of Page