offapi/com/sun/star/view/PrintSettings.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: PrintSettings.idl,v $
  10  * $Revision: 1.8 $
  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_PrintSettings_idl__
  31 #define __com_sun_star_view_PrintSettings_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module view {
  37
  38 //=============================================================================
  39
  40 /** provides access to the settings for printing documents.
  41
  42     <p>These settings are printer independet but affect the rendering of
  43     the document.
  44  */
  45 published service PrintSettings
  46 {
  47     //-------------------------------------------------------------------------
  48     /** If <TRUE/>, all characters are printed in black.
  49
  50         <p>It is useful for printing colored text on a b/w printer.</p>
  51      */
  52     [property] boolean PrintBlackFonts;
  53
  54     //-------------------------------------------------------------------------
  55     /** If <TRUE/>, control shapes are included in printing.
  56      */
  57     [property] boolean PrintControls;
  58
  59     //-------------------------------------------------------------------------
  60     /** If <TRUE/>, drawing objects (shapes)  are included in printing.
  61      */
  62     [property] boolean PrintDrawings;
  63
  64     //-------------------------------------------------------------------------
  65     /** If <TRUE/>, graphic objects are included in printing.
  66      */
  67     [property] boolean PrintGraphics;
  68
  69     //-------------------------------------------------------------------------
  70     /** If <TRUE/>, left pages are included in printing.
  71      */
  72     [property] boolean PrintLeftPages;
  73
  74     //-------------------------------------------------------------------------
  75     /** If <TRUE/>, right pages are included in printing.
  76      */
  77     [property] boolean PrintRightPages;
  78
  79     //-------------------------------------------------------------------------
  80     /** If <TRUE/>, tables are included in printing.
  81      */
  82     [property] boolean PrintTables;
  83
  84     //-------------------------------------------------------------------------
  85     /** If <TRUE/>, the pages are printed in reverse order.
  86
  87         <p>The last page is printed first.</p>
  88      */
  89     [property] boolean PrintReversed;
  90
  91     //-------------------------------------------------------------------------
  92     /** If <TRUE/>, the pages are printed in the order of prospects.
  93      */
  94     [property] boolean PrintProspect;
  95
  96     //-------------------------------------------------------------------------
  97     /** If <TRUE/>, the background of the page is printed.
  98      */
  99     [property] boolean PrintPageBackground;
 100
 101     //-------------------------------------------------------------------------
 102     /** determines how annotations are printed.
 103
 104         @see NotePrintMode
 105      */
 106     [property] short PrintAnnotationMode;
 107
 108 };
 109
 110 //=============================================================================
 111
 112 }; }; }; };
 113
 114 #endif