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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_view_RenderOptions_idl__
  29 #define __com_sun_star_view_RenderOptions_idl__
  30
  31 #include <com/sun/star/awt/XDevice.idl>
  32
  33 //=============================================================================
  34
  35 module com {  module sun {  module star {  module view {
  36
  37 //=============================================================================
  38
  39 /** describes the options for Render jobs.
  40
  41     @since OOo 1.1.2
  42  */
  43 published service RenderOptions
  44 {
  45     //-------------------------------------------------------------------------
  46
  47     /** specifies the device the page should be rendered to
  48      */
  49     [property] com::sun::star::awt::XDevice RenderDevice;
  50
  51     //-------------------------------------------------------------------------
  52
  53     /** indicates that the current page is the first page to be exported.
  54
  55         <p>Hyperlinks, notes, and outlines cannot be exported on a per
  56         page base. They have to be exported once *before* the first page
  57         is exported. Therefore the IsFirstPage property has been introduced.
  58         It is evaluated in the ::render function and indicates that the
  59         current page is the first page to be exported.
  60         </p>
  61
  62         @see XRenderable
  63      */
  64     [optional, property] boolean IsFirstPage;
  65     //-------------------------------------------------------------------------
  66
  67     /** indicates that the current page is the last page to be exported.
  68
  69         <p>Hyperlinks from the EditEngine have to be exported once *after*
  70         the last page has been processed. Therefore the IsLastPage property
  71         has been introduced. It is evaluated in the ::render function and
  72         indicates that the current page is the last page to be exported.
  73         </p>
  74
  75         @see XRenderable
  76      */
  77     [optional, property] boolean IsLastPage;
  78     //-------------------------------------------------------------------------
  79
  80     /** specifies if empty pages should be skipped.
  81
  82         <p>Tells the PDF export to skip empty pages. This flag also has
  83         to be passed to the ::render function, in order to calculate to
  84         correct page numbers during the export of hyperlinks, notes, and
  85         outlines.
  86         </p>
  87
  88         @see XRenderable
  89      */
  90     [optional, property] boolean IsSkipEmptyPages;
  91     //-------------------------------------------------------------------------
  92
  93     /** specifies the page ranges to be rendered.
  94
  95         <p>Tells the PDF export to skip empty pages. This flag also has
  96         to be passed to the ::render function, in order to calculate to
  97         correct page numbers during the export of hyperlinks, notes,
  98         and outlines.
  99         </p>
 100
 101         @see XRenderable
 102      */
 103     [optional, property] string PageRange;
 104 };
 105
 106 //=============================================================================
 107
 108 }; }; }; };
 109
 110
 111 #endif
 112
 113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */