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

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