xref: /aoo4110/main/offapi/com/sun/star/scanner/ScanError.idl (revision b1cdbd2c)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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