diff options
author | Michael Hönnig <mi@openoffice.org> | 2000-11-06 08:23:00 +0000 |
---|---|---|
committer | Michael Hönnig <mi@openoffice.org> | 2000-11-06 08:23:00 +0000 |
commit | 88c437c597b604524d50f450506285a594bd03a5 (patch) | |
tree | 3c12c7a1422fc0fc7d6e9b6433b55b91aa3a80a8 /offapi/com/sun/star/scanner | |
parent | 09ec45ba551bfaa33e4538dc5eb8bbfe6b114fed (diff) |
moved from api
Diffstat (limited to 'offapi/com/sun/star/scanner')
-rw-r--r-- | offapi/com/sun/star/scanner/ScanError.idl | 117 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/ScannerContext.idl | 92 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/ScannerException.idl | 95 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/ScannerManager.idl | 90 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/XScannerManager.idl | 142 | ||||
-rw-r--r-- | offapi/com/sun/star/scanner/makefile.mk | 85 |
6 files changed, 621 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..e9ccee3865f4 --- /dev/null +++ b/offapi/com/sun/star/scanner/ScanError.idl @@ -0,0 +1,117 @@ +/************************************************************************* + * + * $RCSfile: ScanError.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:54 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#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 +*/ +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 action 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..825492342e0a --- /dev/null +++ b/offapi/com/sun/star/scanner/ScannerContext.idl @@ -0,0 +1,92 @@ +/************************************************************************* + * + * $RCSfile: ScannerContext.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:54 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#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 +*/ +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..8a0558c71b1e --- /dev/null +++ b/offapi/com/sun/star/scanner/ScannerException.idl @@ -0,0 +1,95 @@ +/************************************************************************* + * + * $RCSfile: ScannerException.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:54 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#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. +*/ +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..f6ea5c9f7c08 --- /dev/null +++ b/offapi/com/sun/star/scanner/ScannerManager.idl @@ -0,0 +1,90 @@ +/************************************************************************* + * + * $RCSfile: ScannerManager.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:54 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + + +#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) +*/ +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..9225e276c4af --- /dev/null +++ b/offapi/com/sun/star/scanner/XScannerManager.idl @@ -0,0 +1,142 @@ +/************************************************************************* + * + * $RCSfile: XScannerManager.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:54 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library 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 for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#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 { + +//============================================================================= +/** +*/ +[ uik(E9743C70-1D8E-11D3-AB050060-97DA5617), ident( "XScannerManager", 1.0 ) ] +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 UI to let the user have a preview, + configure the scan area, whatever + 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..015c1b228a32 --- /dev/null +++ b/offapi/com/sun/star/scanner/makefile.mk @@ -0,0 +1,85 @@ +#************************************************************************* +# +# $RCSfile: makefile.mk,v $ +# +# $Revision: 1.1 $ +# +# last change: $Author: mi $ $Date: 2000-11-06 09:21:54 $ +# +# The Contents of this file are made available subject to the terms of +# either of the following licenses +# +# - GNU Lesser General Public License Version 2.1 +# - Sun Industry Standards Source License Version 1.1 +# +# Sun Microsystems Inc., October, 2000 +# +# GNU Lesser General Public License Version 2.1 +# ============================================= +# Copyright 2000 by Sun Microsystems, Inc. +# 901 San Antonio Road, Palo Alto, CA 94303, USA +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License version 2.1, as published by the Free Software Foundation. +# +# This library 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 for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, +# MA 02111-1307 USA +# +# +# Sun Industry Standards Source License Version 1.1 +# ================================================= +# The contents of this file are subject to the Sun Industry Standards +# Source License Version 1.1 (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.openoffice.org/license.html. +# +# Software provided under this License is provided on an "AS IS" basis, +# WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, +# WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, +# MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. +# See the License for the specific provisions governing your rights and +# obligations concerning the Software. +# +# The Initial Developer of the Original Code is: Sun Microsystems, Inc. +# +# Copyright: 2000 by Sun Microsystems, Inc. +# +# All Rights Reserved. +# +# Contributor(s): _______________________________________ +# +# +# +#************************************************************************* + +PRJ=..$/..$/..$/.. + +PRJNAME=api + +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 |