/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: PrintOptions.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 09:22:11 $
 *
 *  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_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;
};

//=============================================================================

}; }; }; };

#endif
