offapi/com/sun/star/view/RenderOptions.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 module com {  module sun {  module star {  module view {
  22
  23
  24 /** describes the options for Render jobs.
  25
  26     @since OOo 1.1.2
  27  */
  28 published service RenderOptions
  29 {
  30
  31     /** specifies the device the page should be rendered to
  32      */
  33     [property] com::sun::star::awt::XDevice RenderDevice;
  34
  35
  36     /** indicates that the current page is the first page to be exported.
  37
  38         <p>Hyperlinks, notes, and outlines cannot be exported on a per
  39         page base. They have to be exported once *before* the first page
  40         is exported. Therefore the IsFirstPage property has been introduced.
  41         It is evaluated in the render function and indicates that the
  42         current page is the first page to be exported.
  43         </p>
  44
  45         @see XRenderable
  46      */
  47     [optional, property] boolean IsFirstPage;
  48
  49     /** indicates that the current page is the last page to be exported.
  50
  51         <p>Hyperlinks from the EditEngine have to be exported once *after*
  52         the last page has been processed. Therefore the IsLastPage property
  53         has been introduced. It is evaluated in the render function and
  54         indicates that the current page is the last page to be exported.
  55         </p>
  56
  57         @see XRenderable
  58      */
  59     [optional, property] boolean IsLastPage;
  60
  61     /** specifies if empty pages should be skipped.
  62
  63         <p>Tells the PDF export to skip empty pages. This flag also has
  64         to be passed to the render function, in order to calculate to
  65         correct page numbers during the export of hyperlinks, notes, and
  66         outlines.
  67         </p>
  68
  69         @see XRenderable
  70      */
  71     [optional, property] boolean IsSkipEmptyPages;
  72
  73     /** specifies the page ranges to be rendered.
  74
  75         <p>Tells the PDF export to skip empty pages. This flag also has
  76         to be passed to the render function, in order to calculate to
  77         correct page numbers during the export of hyperlinks, notes,
  78         and outlines.
  79         </p>
  80
  81         @see XRenderable
  82      */
  83     [optional, property] string PageRange;
  84 };
  85
  86
  87 }; }; }; };
  88
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */