summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/scanner
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/scanner
parentInitial commit. (diff)
downloadlibreoffice-upstream/4%7.4.7.tar.xz
libreoffice-upstream/4%7.4.7.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/scanner/ScanError.idl68
-rw-r--r--offapi/com/sun/star/scanner/ScannerContext.idl47
-rw-r--r--offapi/com/sun/star/scanner/ScannerException.idl46
-rw-r--r--offapi/com/sun/star/scanner/ScannerManager.idl40
-rw-r--r--offapi/com/sun/star/scanner/XScannerManager.idl74
-rw-r--r--offapi/com/sun/star/scanner/XScannerManager2.idl41
6 files changed, 316 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 000000000..614cffe9a
--- /dev/null
+++ b/offapi/com/sun/star/scanner/ScanError.idl
@@ -0,0 +1,68 @@
+/* -*- 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 .
+ */
+#ifndef __com_sun_star_scanner_ScanError_idl__
+#define __com_sun_star_scanner_ScanError_idl__
+
+
+
+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
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* 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 000000000..1104e8c0b
--- /dev/null
+++ b/offapi/com/sun/star/scanner/ScannerContext.idl
@@ -0,0 +1,47 @@
+/* -*- 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 .
+ */
+#ifndef __com_sun_star_scanner_ScannerContext_idl__
+#define __com_sun_star_scanner_ScannerContext_idl__
+
+
+
+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;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* 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 000000000..8f1a8d836
--- /dev/null
+++ b/offapi/com/sun/star/scanner/ScannerException.idl
@@ -0,0 +1,46 @@
+/* -*- 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 .
+ */
+#ifndef __com_sun_star_scanner_ScannerException_idl__
+#define __com_sun_star_scanner_ScannerException_idl__
+
+#include <com/sun/star/uno/Exception.idl>
+#include <com/sun/star/scanner/ScanError.idl>
+
+
+
+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;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* 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 000000000..c774ea674
--- /dev/null
+++ b/offapi/com/sun/star/scanner/ScannerManager.idl
@@ -0,0 +1,40 @@
+/* -*- 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 .
+ */
+
+
+#ifndef __com_sun_star_scanner_ScannerManager_idl__
+#define __com_sun_star_scanner_ScannerManager_idl__
+
+#include <com/sun/star/scanner/XScannerManager2.idl>
+
+
+
+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;
+
+
+}; }; }; };
+
+#endif
+
+/* 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 000000000..c261b345a
--- /dev/null
+++ b/offapi/com/sun/star/scanner/XScannerManager.idl
@@ -0,0 +1,74 @@
+/* -*- 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 .
+ */
+#ifndef __com_sun_star_scanner_XScannerManager_idl__
+#define __com_sun_star_scanner_XScannerManager_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/scanner/ScannerContext.idl>
+#include <com/sun/star/scanner/ScannerException.idl>
+#include <com/sun/star/lang/XEventListener.idl>
+#include <com/sun/star/scanner/ScanError.idl>
+#include <com/sun/star/awt/XBitmap.idl>
+
+
+
+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 );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* 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 000000000..8272b461a
--- /dev/null
+++ b/offapi/com/sun/star/scanner/XScannerManager2.idl
@@ -0,0 +1,41 @@
+/* -*- 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/.
+ */
+
+#ifndef __com_sun_star_scanner_XScannerManager2_idl__
+#define __com_sun_star_scanner_XScannerManager2_idl__
+
+#include <com/sun/star/scanner/XScannerManager.idl>
+
+
+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 );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */