summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/view/PrintableState.idl
blob: b687d8174805f8c9950e9c45899cf7085a942ac8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_view_PrintableState_idl__
#define __com_sun_star_view_PrintableState_idl__



module com {  module sun {  module star {  module view {


/** specifies the print progress of an XPrintable.

    <p>Printing consists of two abstract phases: rendering the document
    for the printer and then sending it to the printer (spooling).
    PrintableState describes which phase is currently
    progressing or has failed.</p>

    @see PrintableStateEvent
 */
published enum PrintableState
{
    /** printing (rendering the document) has begun
     */
    JOB_STARTED,

    /** printing (rendering the document) has finished, spooling has begun
     */
    JOB_COMPLETED,

    /** spooling has finished successfully. This is the only state
        that can be considered as "success" for a print job.
    */
    JOB_SPOOLED,

    /** printing was aborted (e.g., by the user) while either printing or spooling.
     */
    JOB_ABORTED,

    /** printing ran into an error.
     */
    JOB_FAILED,

    /** the document could be printed but not spooled.
     */
    JOB_SPOOLING_FAILED
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */