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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: PrintableState.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_view_PrintableState_idl__
  31 #define __com_sun_star_view_PrintableState_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module view {
  37
  38 //=============================================================================
  39
  40 /** specifies the print progress of an <type>XPrintable</type>.
  41
  42     <p>Printing consists of two abstract phases: rendering the document
  43     for the printer and then sending it to the printer (spooling).
  44     <type>PrintableState</type> describes which phase is currently
  45     progressing or has failed.</p>
  46
  47     @see PrintableStateEvent
  48  */
  49 published enum PrintableState
  50 {
  51     /** printing (rendering the document) has begun
  52      */
  53     JOB_STARTED,
  54
  55     /** printing (rendering the document) has finished, spooling has begun
  56      */
  57     JOB_COMPLETED,
  58
  59     /** spooling has finished successfully. This is the only state
  60         that can be considered as "success" for a print job.
  61     */
  62     JOB_SPOOLED,
  63
  64     /** printing was aborted (e.g., by the user) while either printing or spooling.
  65      */
  66     JOB_ABORTED,
  67
  68     /** printing ran into an error.
  69      */
  70     JOB_FAILED,
  71
  72     /** the document could be printed but not spooled.
  73      */
  74     JOB_SPOOLING_FAILED
  75 };
  76
  77 //=============================================================================
  78
  79 }; }; }; };
  80
  81 #endif