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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com {  module sun {  module star {  module view {
  23
  24
  25 /** describes the options for print jobs.
  26
  27     <p>These options are only valid for a single print job. They do not
  28     change layout or formatting of the document.
  29  */
  30 published service PrintOptions
  31 {
  32     /** specifies the number of copies to print.
  33      */
  34     [property] short CopyCount;
  35
  36     /** if set, specifies the name of a file to print to.
  37      */
  38     [property] string FileName;
  39
  40     /** advises the printer to collate the pages of the copies.
  41      */
  42     [property] boolean Collate;
  43
  44     /** advises the printer to sort the pages of the copies.
  45
  46         @deprecated
  47             Use Collate instead.
  48      */
  49     [property] boolean Sort;
  50
  51     /** specifies which pages to print.
  52
  53         <p>This range is given as at the user interface. For example: "1-4;10"
  54         to print the pages 1 to 4 and 10. </p>
  55      */
  56     [property] string Pages;
  57
  58     /** if set to TRUE, the corresponding XPrintable.print() request will
  59         be executed synchronous.
  60
  61             <p>Default is the asynchronous print mode.</p>
  62
  63         @attention  Using of this property with TRUE as value is highly recommended.
  64                 Otherwise following actions (as e.g. closing the corresponding model) can fail.
  65      */
  66     [optional, property] boolean Wait;
  67
  68     /** determines the duplex mode for the print job.
  69
  70         @see DuplexMode for more information about supported values
  71      */
  72     [optional, property] short DuplexMode;
  73
  74     /** if set, specifies name of the printer to use.
  75      */
  76     [optional, property] string PrinterName;
  77
  78     /** advises the printer to create a single print job for each copy.
  79      */
  80     [optional, property] boolean SinglePrintJobs;
  81
  82     /** The job name which is sent to the printer (can be seen in the Printer job queue).
  83      *
  84      *  If omitted, the document title will be used as default.
  85      *
  86      *  @since LibreOffice 7.5
  87      */
  88     [optional, property] boolean JobName;
  89 };
  90
  91
  92 }; }; }; };
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */