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

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