/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: PrinterDescriptor.idl,v $
 *
 *  $Revision: 1.11 $
 *
 *  last change: $Author: rt $ $Date: 2005-12-14 11:31:15 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#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
