offapi/com/sun/star/view/PrinterDescriptor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: PrinterDescriptor.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_view_PrinterDescriptor_idl__
  31 #define __com_sun_star_view_PrinterDescriptor_idl__
  32
  33 #ifndef __com_sun_star_view_PaperOrientation_idl__
  34 #include <com/sun/star/view/PaperOrientation.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_view_PaperFormat_idl__
  38 #include <com/sun/star/view/PaperFormat.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_Size_idl__
  42 #include <com/sun/star/awt/Size.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module view {
  49
  50 //=============================================================================
  51
  52 /** describes a printer by specifying the queue name and some settings.
  53
  54     <p>This service may be represented by a <type scope="com::sun::star::beans" dim="[]">PropertyValue</type>.
  55
  56     @see com::sun::star::beans::PropertyValue
  57  */
  58 published service PrinterDescriptor
  59 {
  60     //-------------------------------------------------------------------------
  61     /** specifies the name of the printer queue to be used.
  62
  63         <p>Which printer queues are available, can be figured out with the
  64         system library of the used programming language/environment.
  65      */
  66     [property] string Name;
  67
  68     //-------------------------------------------------------------------------
  69     /** specifies the orientation of the paper.
  70      */
  71     [property] com::sun::star::view::PaperOrientation PaperOrientation;
  72
  73     //-------------------------------------------------------------------------
  74     /** specifies a predefined paper size or if the paper size
  75         is a user-defined size.
  76
  77         <p>Setting this property may change the value of
  78         <member>PrinterDescriptor</member>PaperSize</member.</p>
  79      */
  80     [property] com::sun::star::view::PaperFormat PaperFormat;
  81
  82     //-------------------------------------------------------------------------
  83     /** specifies the size of the paper in 100th mm.
  84
  85         <p>Setting this property may change the value of
  86         <member>PrinterDescriptor</member>PaperFormat</member.</p>
  87      */
  88     [property] com::sun::star::awt::Size PaperSize;
  89
  90     //-------------------------------------------------------------------------
  91     /** indicates, whether the printer is busy or not.
  92      */
  93     [readonly, property] boolean IsBusy;
  94
  95     //-------------------------------------------------------------------------
  96     /** indicates, whether the printer allows changes to
  97         <member>PrinterDescriptor::PaperOrientation</member>.
  98      */
  99     [readonly, property] boolean CanSetPaperOrientation;
 100
 101     //-------------------------------------------------------------------------
 102     /** indicates, whether the printer allows changes to
 103         <member>PrinterDescriptor::PaperFormat</member>.
 104      */
 105     [readonly, property] boolean CanSetPaperFormat;
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** indicates if the printer allows changes to
 110         <member>PrinterDescriptor::PaperSize</member>.
 111      */
 112     [readonly, property] boolean CanSetPaperSize;
 113
 114 };
 115
 116 //=============================================================================
 117
 118 }; }; }; };
 119
 120 #endif