summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/view/PrintOptions.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/view/PrintOptions.idl')
-rw-r--r--offapi/com/sun/star/view/PrintOptions.idl98
1 files changed, 98 insertions, 0 deletions
diff --git a/offapi/com/sun/star/view/PrintOptions.idl b/offapi/com/sun/star/view/PrintOptions.idl
new file mode 100644
index 000000000000..3bad70f490e7
--- /dev/null
+++ b/offapi/com/sun/star/view/PrintOptions.idl
@@ -0,0 +1,98 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_view_PrintOptions_idl__
+#define __com_sun_star_view_PrintOptions_idl__
+
+
+//=============================================================================
+
+module com { module sun { module star { module view {
+
+//=============================================================================
+
+/** describes the options for print jobs.
+
+ <p>These options are only valid for a single print job. They do not
+ change layout or formatting of the document.
+ */
+published service PrintOptions
+{
+ //-------------------------------------------------------------------------
+ /** specifies the number of copies to print.
+ */
+ [property] short CopyCount;
+
+ //-------------------------------------------------------------------------
+ /** if set, specifies the name of a file to print to.
+ */
+ [property] string FileName;
+
+ //-------------------------------------------------------------------------
+ /** advises the printer to collate the pages of the copies.
+ */
+ [property] boolean Collate;
+
+ //-------------------------------------------------------------------------
+ /** advises the printer to sort the pages of the copies.
+
+ @deprecated
+ Use <member>Collate</member> instead.
+ */
+ [property] boolean Sort;
+
+ //-------------------------------------------------------------------------
+ /** specifies which pages to print.
+
+ <p>This range is given as at the user interface. For example: "1-4;10"
+ to print the pages 1 to 4 and 10. </p>
+ */
+ [property] string Pages;
+
+ //-------------------------------------------------------------------------
+ /** if set to TRUE, the corresponding <type>XPrintable</type>.print() request will
+ be executed synchronous.
+
+ <p>Default is the asynchronous print mode.</p>
+
+ @attention Using of this property with TRUE as value is highly reommended.
+ Otherwhise following actions (as e.g. closing the corresponding model) can fail.
+ */
+ [optional, property] boolean Wait;
+
+ //-------------------------------------------------------------------------
+ /** determines the duplex mode for the print job.
+
+ @see <type>DuplexMode</type> for more information about supported values
+ */
+ [optional, property] short DuplexMode;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif