offapi/com/sun/star/view/RenderOptions.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: RenderOptions.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_RenderOptions_idl__
  31 #define __com_sun_star_view_RenderOptions_idl__
  32
  33 #ifndef __com_sun_star_awt_XDevice_idl__
  34 #include <com/sun/star/awt/XDevice.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module view {
  40
  41 //=============================================================================
  42
  43 /** describes the options for Render jobs.
  44
  45     @since OOo 1.1.2
  46  */
  47 published service RenderOptions
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     /** specifies the device the page should be rendered to
  52      */
  53     [property] com::sun::star::awt::XDevice RenderDevice;
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** indicates that the current page is the first page to be exported.
  58
  59         <p>Hyperlinks, notes, and outlines cannot be exported on a per
  60         page base. They have to be exported once *before* the first page
  61         is exported. Therefore the IsFirstPage property has been introduced.
  62         It is evaluated in the ::render function and indicates that the
  63         current page is the first page to be exported.
  64         </p>
  65
  66         @see XRenderable
  67      */
  68     [optional, property] boolean IsFirstPage;
  69     //-------------------------------------------------------------------------
  70
  71     /** indicates that the current page is the last page to be exported.
  72
  73         <p>Hyperlinks from the EditEngine have to be exported once *after*
  74         the last page has been processed. Therefore the IsLastPage property
  75         has been introduced. It is evaluated in the ::render function and
  76         indicates that the current page is the last page to be exported.
  77         </p>
  78
  79         @see XRenderable
  80      */
  81     [optional, property] boolean IsLastPage;
  82     //-------------------------------------------------------------------------
  83
  84     /** specifies if empty pages should be skipped.
  85
  86         <p>Tells the pdf export to skip empty pages. This flag also has
  87         to be passed to the ::render function, in order to calculate to
  88         correct page numbers during the export of hyperlinks, notes, and
  89         outlines.
  90         </p>
  91
  92         @see XRenderable
  93      */
  94     [optional, property] boolean IsSkipEmptyPages;
  95     //-------------------------------------------------------------------------
  96
  97     /** specifies the page ranges to be rendered.
  98
  99         <p>Tells the pdf export to skip empty pages. This flag also has
 100         to be passed to the ::render function, in order to calculate to
 101         correct page numbers during the export of hyperlinks, notes,
 102         and outlines.
 103         </p>
 104
 105         @see XRenderable
 106      */
 107     [optional, property] string PageRange;
 108 };
 109
 110 //=============================================================================
 111
 112 }; }; }; };
 113
 114
 115 #endif