AOO410/main/offapi/com/sun/star/view/PrintableState.idl

/**************************************************************
 * 
 * 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_view_PrintableState_idl__ 
#define __com_sun_star_view_PrintableState_idl__ 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module view {  
 
//============================================================================= 
 
/** specifies the print progress of an <type>XPrintable</type>.

	<p>Printing consists of two abstract phases: rendering the document
	for the printer and then sending it to the printer (spooling).
	<type>PrintableState</type> describes which phase is currently
	progressing or has failed.</p>

	@see PrintableStateEvent
 */
published enum PrintableState
{
	/** printing (rendering the document) has begun
	 */
	JOB_STARTED,

	/** printing (rendering the document) has finished, spooling has begun
	 */
	JOB_COMPLETED,

	/** spooling has finished successfully. This is the only state
		that can be considered as "success" for a print job.
	*/
	JOB_SPOOLED,

	/**	printing was aborted (e.g., by the user) while either printing or spooling.
	 */
	JOB_ABORTED,

	/** printing ran into an error.
	 */
	JOB_FAILED,

	/** the document could be printed but not spooled.
	 */
	JOB_SPOOLING_FAILED
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif