diff options
Diffstat (limited to 'offapi/com/sun/star/scanner')
-rw-r--r-- | offapi/com/sun/star/scanner/ScanError.idl | 64 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/ScannerContext.idl | 43 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/ScannerException.idl | 39 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/ScannerManager.idl | 33 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/XScannerManager.idl | 63 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/XScannerManager2.idl | 34 |
6 files changed, 276 insertions, 0 deletions
diff --git a/offapi/com/sun/star/scanner/ScanError.idl b/offapi/com/sun/star/scanner/ScanError.idl new file mode 100644 index 0000000000..b115703576 --- /dev/null +++ b/offapi/com/sun/star/scanner/ScanError.idl @@ -0,0 +1,64 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + + + +module com { module sun { module star { module scanner { + +/** enum ScanError describes error codes of scanner component +*/ +published enum ScanError +{ + // DOCUMENTATION CHANGED FOR ScanError:: ScanErrorNone, + /** ScanErrorNone: no error occurred + */ + ScanErrorNone, + + // DOCUMENTATION CHANGED FOR ScanError:: ScannerNotAvailable, + /** ScannerNotAvailable: the requested device could not be opened + */ + ScannerNotAvailable, + + // DOCUMENTATION CHANGED FOR ScanError:: ScanFailed, + /** ScanFailed: an error occurred during scanning + */ + ScanFailed, + + // DOCUMENTATION CHANGED FOR ScanError:: ScanInProgress, + /** ScanInProgress: a scan is already in progress on this device that has + to end before a new one can be started + */ + ScanInProgress, + + // DOCUMENTATION CHANGED FOR ScanError:: ScanCanceled, + /** ScanCanceled: the scan was canceled by the user + */ + ScanCanceled, + + // DOCUMENTATION CHANGED FOR ScanError:: InvalidContext + /** InvalidContext: a device was requested that does not exist + */ + InvalidContext + +}; + + +}; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/scanner/ScannerContext.idl b/offapi/com/sun/star/scanner/ScannerContext.idl new file mode 100644 index 0000000000..644a68d8b8 --- /dev/null +++ b/offapi/com/sun/star/scanner/ScannerContext.idl @@ -0,0 +1,43 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + + + +module com { module sun { module star { module scanner { + +/** a scanner context is an identifier for a specific scanner device +*/ +published struct ScannerContext +{ + // DOCUMENTATION CHANGED FOR ScannerContext::ScannerName + /** ScannerName contains a user readable identification + */ + string ScannerName; + + // DOCUMENTATION CHANGED FOR ScannerContext::InternalData + /** InternalData contains service private data and must not be changed + */ + long InternalData; + +}; + + +}; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/scanner/ScannerException.idl b/offapi/com/sun/star/scanner/ScannerException.idl new file mode 100644 index 0000000000..c716d3412f --- /dev/null +++ b/offapi/com/sun/star/scanner/ScannerException.idl @@ -0,0 +1,39 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + + + +module com { module sun { module star { module scanner { + +/** A ScannerException gets thrown if an object of type XScannerManager + could not complete a specific action. +*/ +published exception ScannerException: com::sun::star::uno::Exception +{ + // DOCUMENTATION CHANGED FOR ScannerException::Error + /** Error: contains the specific reason for failure + */ + com::sun::star::scanner::ScanError Error; + +}; + + +}; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/scanner/ScannerManager.idl b/offapi/com/sun/star/scanner/ScannerManager.idl new file mode 100644 index 0000000000..d37f1bcc76 --- /dev/null +++ b/offapi/com/sun/star/scanner/ScannerManager.idl @@ -0,0 +1,33 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + + + + +module com { module sun { module star { module scanner { + +/** ScannerManager provides a simple method to access scanner devices + (or other image producing devices) +*/ +published service ScannerManager : XScannerManager2; + + +}; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/scanner/XScannerManager.idl b/offapi/com/sun/star/scanner/XScannerManager.idl new file mode 100644 index 0000000000..082a76ad7f --- /dev/null +++ b/offapi/com/sun/star/scanner/XScannerManager.idl @@ -0,0 +1,63 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + + + +module com { module sun { module star { module scanner { + +published interface XScannerManager: com::sun::star::uno::XInterface +{ + // DOCUMENTATION CHANGED FOR XScannerManager::getAvailableScanners + /** returns all available scanner devices + */ + sequence<com::sun::star::scanner::ScannerContext> getAvailableScanners(); + + /** 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 + */ + boolean configureScanner( [inout] com::sun::star::scanner::ScannerContext scannerContext ) + raises( com::sun::star::scanner::ScannerException ); + + /**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 successful, + an empty interface otherwise + */ + void startScan( [in] com::sun::star::scanner::ScannerContext scannerContext, + [in] com::sun::star::lang::XEventListener listener ) + raises( com::sun::star::scanner::ScannerException ); + + /**get the state of scanning after completion of scan + */ + com::sun::star::scanner::ScanError getError( [in] com::sun::star::scanner::ScannerContext scannerContext ) + raises( com::sun::star::scanner::ScannerException ); + + /**get the image after completion of scan + */ + com::sun::star::awt::XBitmap getBitmap( [in] com::sun::star::scanner::ScannerContext scannerContext ) + raises( com::sun::star::scanner::ScannerException ); + +}; + + +}; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/scanner/XScannerManager2.idl b/offapi/com/sun/star/scanner/XScannerManager2.idl new file mode 100644 index 0000000000..42f565c1b4 --- /dev/null +++ b/offapi/com/sun/star/scanner/XScannerManager2.idl @@ -0,0 +1,34 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +module com { module sun { module star { module scanner { + + +/** + Extension of XScannerManager. + + @since LibreOffice 3.5 +*/ +published interface XScannerManager2: com::sun::star::scanner::XScannerManager +{ + /** produce some kind of User Interface to let the user have a preview, + configure the scan area, etc., it, and scan it + returns FALSE if user cancelled this process + */ + boolean configureScannerAndScan( [inout] com::sun::star::scanner::ScannerContext scannerContext, + [in] com::sun::star::lang::XEventListener listener ) + raises( com::sun::star::scanner::ScannerException ); + +}; + + +}; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |