summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/view/PrintableState.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/view/PrintableState.idl')
-rw-r--r--offapi/com/sun/star/view/PrintableState.idl69
1 files changed, 69 insertions, 0 deletions
diff --git a/offapi/com/sun/star/view/PrintableState.idl b/offapi/com/sun/star/view/PrintableState.idl
new file mode 100644
index 000000000..b687d8174
--- /dev/null
+++ b/offapi/com/sun/star/view/PrintableState.idl
@@ -0,0 +1,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: */