/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at
http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at
http://www.apache.org/licenses/LICENSE-2.0 .
*/
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 Collate 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 XPrintable.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 recommended.
Otherwise following actions (as e.g. closing the corresponding model) can fail.
*/
[optional, property] boolean Wait;
/** determines the duplex mode for the print job.
@see DuplexMode for more information about supported values
*/
[optional, property] short DuplexMode;
/** if set, specifies name of the printer to use.
*/
[optional, property] string PrinterName;
/** advises the printer to create a single print job for each copy.
*/
[optional, property] boolean SinglePrintJobs;
/** The job name which is sent to the printer (can be seen in the Printer job queue).
*
* If omitted, the document title will be used as default.
*
* @since LibreOffice 7.5
*/
[optional, property] boolean JobName;
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
