/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: PrintableState.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 09:22:54 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/
#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
