diff options
Diffstat (limited to 'offapi/com/sun/star/scanner')
-rw-r--r-- | offapi/com/sun/star/scanner/ScanError.idl | 83 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/ScannerContext.idl | 58 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/ScannerException.idl | 61 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/ScannerManager.idl | 56 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/XScannerManager.idl | 107 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/makefile.mk | 50 |
6 files changed, 415 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 000000000000..ecb9544df3a4 --- /dev/null +++ b/offapi/com/sun/star/scanner/ScanError.idl @@ -0,0 +1,83 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#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 occured + */ + ScanErrorNone, + + //------------------------------------------------------------------------- + // DOCUMENTATION CHANGED FOR ScanError:: ScannerNotAvailable, + /** ScannerNotAvailable: the requested device could not be opened + */ + ScannerNotAvailable, + + //------------------------------------------------------------------------- + // DOCUMENTATION CHANGED FOR ScanError:: ScanFailed, + /** ScanFailed: an error occured 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 diff --git a/offapi/com/sun/star/scanner/ScannerContext.idl b/offapi/com/sun/star/scanner/ScannerContext.idl new file mode 100644 index 000000000000..41f1c8e1aacb --- /dev/null +++ b/offapi/com/sun/star/scanner/ScannerContext.idl @@ -0,0 +1,58 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#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 diff --git a/offapi/com/sun/star/scanner/ScannerException.idl b/offapi/com/sun/star/scanner/ScannerException.idl new file mode 100644 index 000000000000..a3b78111ca8d --- /dev/null +++ b/offapi/com/sun/star/scanner/ScannerException.idl @@ -0,0 +1,61 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_scanner_ScannerException_idl__ +#define __com_sun_star_scanner_ScannerException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +#ifndef __com_sun_star_scanner_ScanError_idl__ +#include <com/sun/star/scanner/ScanError.idl> +#endif + + +//============================================================================= + +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 diff --git a/offapi/com/sun/star/scanner/ScannerManager.idl b/offapi/com/sun/star/scanner/ScannerManager.idl new file mode 100644 index 000000000000..950b0c8dcb0d --- /dev/null +++ b/offapi/com/sun/star/scanner/ScannerManager.idl @@ -0,0 +1,56 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + + +#ifndef __com_sun_star_scanner_ScannerManager_idl__ +#define __com_sun_star_scanner_ScannerManager_idl__ + +#ifndef __com_sun_star_scanner_XScannerManager_idl__ +#include <com/sun/star/scanner/XScannerManager.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module scanner { + +//============================================================================= +// DOCUMENTATION CHANGED FOR ScannerManager +/** ScannerManager provides a simple method to access scanner devices + (or other image producing devices) +*/ +published service ScannerManager +{ + interface com::sun::star::scanner::XScannerManager; + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/scanner/XScannerManager.idl b/offapi/com/sun/star/scanner/XScannerManager.idl new file mode 100644 index 000000000000..ac933dd3cbb5 --- /dev/null +++ b/offapi/com/sun/star/scanner/XScannerManager.idl @@ -0,0 +1,107 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_scanner_XScannerManager_idl__ +#define __com_sun_star_scanner_XScannerManager_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_scanner_ScannerContext_idl__ +#include <com/sun/star/scanner/ScannerContext.idl> +#endif + +#ifndef __com_sun_star_scanner_ScannerException_idl__ +#include <com/sun/star/scanner/ScannerException.idl> +#endif + +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include <com/sun/star/lang/XEventListener.idl> +#endif + +#ifndef __com_sun_star_scanner_ScanError_idl__ +#include <com/sun/star/scanner/ScanError.idl> +#endif + +#ifndef __com_sun_star_awt_XBitmap_idl__ +#include <com/sun/star/awt/XBitmap.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module scanner { + +//============================================================================= +/** +*/ +published interface XScannerManager: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + // DOCUMENTATION CHANGED FOR XScannerManager::getAvailableScanners + /** returns all avilable 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 scanner_context ) + 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 successfull, + an empty interface otherwise + */ + void startScan( [in] com::sun::star::scanner::ScannerContext scanner_context, + [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 scanner_context ) + 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 scanner_context ) + raises( com::sun::star::scanner::ScannerException ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/scanner/makefile.mk b/offapi/com/sun/star/scanner/makefile.mk new file mode 100644 index 000000000000..b4214c20563d --- /dev/null +++ b/offapi/com/sun/star/scanner/makefile.mk @@ -0,0 +1,50 @@ +#************************************************************************* +# +# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +# +# Copyright 2000, 2010 Oracle and/or its affiliates. +# +# OpenOffice.org - a multi-platform office productivity suite +# +# This file is part of OpenOffice.org. +# +# OpenOffice.org is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License version 3 +# only, as published by the Free Software Foundation. +# +# OpenOffice.org is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser General Public License version 3 for more details +# (a copy is included in the LICENSE file that accompanied this code). +# +# You should have received a copy of the GNU Lesser General Public License +# version 3 along with OpenOffice.org. If not, see +# <http://www.openoffice.org/license.html> +# for a copy of the LGPLv3 License. +# +#************************************************************************* + +PRJ=..$/..$/..$/.. + +PRJNAME=offapi + +TARGET=cssscanner +PACKAGE=com$/sun$/star$/scanner + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + ScanError.idl\ + ScannerContext.idl\ + ScannerException.idl\ + ScannerManager.idl\ + XScannerManager.idl\ + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk |