offapi/com/sun/star/view/PrintOptions.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: PrintOptions.idl,v $
  10  * $Revision: 1.11 $
  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_PrintOptions_idl__
  31 #define __com_sun_star_view_PrintOptions_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module view {
  37
  38 //=============================================================================
  39
  40 /** describes the options for print jobs.
  41
  42     <p>These options are only valid for a single print job. They do not
  43     change layout or formatting of the document.
  44  */
  45 published service PrintOptions
  46 {
  47     //-------------------------------------------------------------------------
  48     /** specifies the number of copies to print.
  49      */
  50     [property] short CopyCount;
  51
  52     //-------------------------------------------------------------------------
  53     /** if set, specifies the name of a file to print to.
  54      */
  55     [property] string FileName;
  56
  57     //-------------------------------------------------------------------------
  58     /** advises the printer to collate the pages of the copies.
  59      */
  60     [property] boolean Collate;
  61
  62     //-------------------------------------------------------------------------
  63     /** advises the printer to sort the pages of the copies.
  64
  65         @deprecated
  66             Use <member>Collate</member> instead.
  67      */
  68     [property] boolean Sort;
  69
  70     //-------------------------------------------------------------------------
  71     /** specifies which pages to print.
  72
  73         <p>This range is given as at the user interface. For example: "1-4;10"
  74         to print the pages 1 to 4 and 10. </p>
  75      */
  76     [property] string Pages;
  77
  78     //-------------------------------------------------------------------------
  79     /** if set to TRUE, the corresponding <type>XPrintable</type>.print() request will
  80         be executed synchronous.
  81
  82             <p>Default is the asynchronous print mode.</p>
  83
  84         @attention      Using of this property with TRUE as value is highly reommended.
  85                 Otherwhise following actions (as e.g. closing the corresponding model) can fail.
  86      */
  87     [optional, property] boolean Wait;
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 #endif