summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/view/PrinterDescriptor.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/view/PrinterDescriptor.idl')
-rw-r--r--offapi/com/sun/star/view/PrinterDescriptor.idl117
1 files changed, 117 insertions, 0 deletions
diff --git a/offapi/com/sun/star/view/PrinterDescriptor.idl b/offapi/com/sun/star/view/PrinterDescriptor.idl
new file mode 100644
index 000000000000..006e1969fedb
--- /dev/null
+++ b/offapi/com/sun/star/view/PrinterDescriptor.idl
@@ -0,0 +1,117 @@
+/*************************************************************************
+ *
+ * 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_PrinterDescriptor_idl__
+#define __com_sun_star_view_PrinterDescriptor_idl__
+
+#ifndef __com_sun_star_view_PaperOrientation_idl__
+#include <com/sun/star/view/PaperOrientation.idl>
+#endif
+
+#ifndef __com_sun_star_view_PaperFormat_idl__
+#include <com/sun/star/view/PaperFormat.idl>
+#endif
+
+#ifndef __com_sun_star_awt_Size_idl__
+#include <com/sun/star/awt/Size.idl>
+#endif
+
+
+//=============================================================================
+
+module com { module sun { module star { module view {
+
+//=============================================================================
+
+/** describes a printer by specifying the queue name and some settings.
+
+ <p>This service may be represented by a <type scope="com::sun::star::beans" dim="[]">PropertyValue</type>.
+
+ @see com::sun::star::beans::PropertyValue
+ */
+published service PrinterDescriptor
+{
+ //-------------------------------------------------------------------------
+ /** specifies the name of the printer queue to be used.
+
+ <p>Which printer queues are available, can be figured out with the
+ system library of the used programming language/environment.
+ */
+ [property] string Name;
+
+ //-------------------------------------------------------------------------
+ /** specifies the orientation of the paper.
+ */
+ [property] com::sun::star::view::PaperOrientation PaperOrientation;
+
+ //-------------------------------------------------------------------------
+ /** specifies a predefined paper size or if the paper size
+ is a user-defined size.
+
+ <p>Setting this property may change the value of
+ <member>PrinterDescriptor</member>PaperSize</member.</p>
+ */
+ [property] com::sun::star::view::PaperFormat PaperFormat;
+
+ //-------------------------------------------------------------------------
+ /** specifies the size of the paper in 100th mm.
+
+ <p>Setting this property may change the value of
+ <member>PrinterDescriptor</member>PaperFormat</member.</p>
+ */
+ [property] com::sun::star::awt::Size PaperSize;
+
+ //-------------------------------------------------------------------------
+ /** indicates, whether the printer is busy or not.
+ */
+ [readonly, property] boolean IsBusy;
+
+ //-------------------------------------------------------------------------
+ /** indicates, whether the printer allows changes to
+ <member>PrinterDescriptor::PaperOrientation</member>.
+ */
+ [readonly, property] boolean CanSetPaperOrientation;
+
+ //-------------------------------------------------------------------------
+ /** indicates, whether the printer allows changes to
+ <member>PrinterDescriptor::PaperFormat</member>.
+ */
+ [readonly, property] boolean CanSetPaperFormat;
+
+ //-------------------------------------------------------------------------
+
+ /** indicates if the printer allows changes to
+ <member>PrinterDescriptor::PaperSize</member>.
+ */
+ [readonly, property] boolean CanSetPaperSize;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif