xref: /AOO41X/main/offapi/com/sun/star/view/PrintableState.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_view_PrintableState_idl__
24#define __com_sun_star_view_PrintableState_idl__
25
26
27//=============================================================================
28
29module com {  module sun {  module star {  module view {
30
31//=============================================================================
32
33/** specifies the print progress of an <type>XPrintable</type>.
34
35    <p>Printing consists of two abstract phases: rendering the document
36    for the printer and then sending it to the printer (spooling).
37    <type>PrintableState</type> describes which phase is currently
38    progressing or has failed.</p>
39
40    @see PrintableStateEvent
41 */
42published enum PrintableState
43{
44    /** printing (rendering the document) has begun
45     */
46    JOB_STARTED,
47
48    /** printing (rendering the document) has finished, spooling has begun
49     */
50    JOB_COMPLETED,
51
52    /** spooling has finished successfully. This is the only state
53        that can be considered as "success" for a print job.
54    */
55    JOB_SPOOLED,
56
57    /** printing was aborted (e.g., by the user) while either printing or spooling.
58     */
59    JOB_ABORTED,
60
61    /** printing ran into an error.
62     */
63    JOB_FAILED,
64
65    /** the document could be printed but not spooled.
66     */
67    JOB_SPOOLING_FAILED
68};
69
70//=============================================================================
71
72}; }; }; };
73
74#endif
75