xref: /core/offapi/com/sun/star/view/PrintableState.idl (revision 2b383d19)
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 *   Licensed to the Apache Software Foundation (ASF) under one or more
12 *   contributor license agreements. See the NOTICE file distributed
13 *   with this work for additional information regarding copyright
14 *   ownership. The ASF licenses this file to you under the Apache
15 *   License, Version 2.0 (the "License"); you may not use this file
16 *   except in compliance with the License. You may obtain a copy of
17 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef __com_sun_star_view_PrintableState_idl__
20#define __com_sun_star_view_PrintableState_idl__
21
22
23
24module com {  module sun {  module star {  module view {
25
26
27/** specifies the print progress of an XPrintable.
28
29    <p>Printing consists of two abstract phases: rendering the document
30    for the printer and then sending it to the printer (spooling).
31    PrintableState describes which phase is currently
32    progressing or has failed.</p>
33
34    @see PrintableStateEvent
35 */
36published enum PrintableState
37{
38    /** printing (rendering the document) has begun
39     */
40    JOB_STARTED,
41
42    /** printing (rendering the document) has finished, spooling has begun
43     */
44    JOB_COMPLETED,
45
46    /** spooling has finished successfully. This is the only state
47        that can be considered as "success" for a print job.
48    */
49    JOB_SPOOLED,
50
51    /** printing was aborted (e.g., by the user) while either printing or spooling.
52     */
53    JOB_ABORTED,
54
55    /** printing ran into an error.
56     */
57    JOB_FAILED,
58
59    /** the document could be printed but not spooled.
60     */
61    JOB_SPOOLING_FAILED
62};
63
64
65}; }; }; };
66
67#endif
68
69/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
70