offapi/com/sun/star/text/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.12 $
  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_text_PrintSettings_idl__
  31 #define __com_sun_star_text_PrintSettings_idl__
  32
  33 #ifndef __com_sun_star_text_NotePrintMode_idl__
  34 #include <com/sun/star/text/NotePrintMode.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module text {
  41
  42 //=============================================================================
  43
  44 // DocMerge from xml: service com::sun::star::text::PrintSettings
  45 /** These properties describe the printing of the content of a text document.
  46  */
  47 published service PrintSettings
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintGraphics
  52     /** determines if graphic objects are printed
  53      */
  54     [property] boolean PrintGraphics;
  55
  56     //-------------------------------------------------------------------------
  57
  58     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintTables
  59     /** determines if text tables are printed.
  60      */
  61     [property] boolean PrintTables;
  62
  63     //-------------------------------------------------------------------------
  64
  65     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintDrawings
  66     /** determines if shapes are printed.
  67      */
  68     [property] boolean PrintDrawings;
  69
  70     //-------------------------------------------------------------------------
  71
  72     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintLeftPage
  73     /** determines if left pages are printed.
  74      */
  75     [property] boolean PrintLeftPages;
  76
  77     //-------------------------------------------------------------------------
  78
  79     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintRightPage
  80     /** determines if right pages are printed.
  81      */
  82     [property] boolean PrintRightPages;
  83
  84     //-------------------------------------------------------------------------
  85
  86     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintControls
  87     /** determines if control shapes are printed.
  88      */
  89     [property] boolean PrintControls;
  90
  91     //-------------------------------------------------------------------------
  92
  93     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintReverse
  94     /** determines if the pages are printed in the reverse order, starting with the last page.
  95      */
  96     [property] boolean PrintReversed;
  97
  98     //-------------------------------------------------------------------------
  99
 100     // DocMerge from xml: property com::sun::star::text::PrintSettings::PaperFromSetup
 101     /** specifies if the printer paper tray selection of the system
 102         printer is used.
 103
 104
 105
 106         <p>If <member scope="com::sun::star::view">PrintSettings::PaperFromSetup</member> is <FALSE/>,
 107         then the paper tray selection of the page styles is used.</p>
 108      */
 109     [property] boolean PrintPaperFromSetup;
 110
 111     //-------------------------------------------------------------------------
 112
 113     // DocMerge from xml: property com::sun::star::text::PrintSettings::FaxName
 114     /** contains the name of the fax.
 115      */
 116     [property] string PrintFaxName;
 117
 118     //-------------------------------------------------------------------------
 119
 120     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintNotes
 121     /** determines how notes are printed.@see NotePrintMode
 122      */
 123     [property] com::sun::star::text::NotePrintMode PrintAnnotationMode;
 124
 125     //-------------------------------------------------------------------------
 126
 127     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintProspect
 128     /** determines if prospect printing is used.
 129      */
 130     [property] boolean PrintProspect;
 131
 132     //-------------------------------------------------------------------------
 133
 134     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintBackground
 135     /** determines if the background color / background graphic of pages is printed.
 136      */
 137     [property] boolean PrintPageBackground;
 138
 139     //-------------------------------------------------------------------------
 140
 141     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintBlackFont
 142     /** determines if characters are always printed in black.
 143      */
 144     [property] boolean PrintBlackFonts;
 145
 146         //-------------------------------------------------------------------------
 147
 148         /** determines if automatically inserted empty pages are printed.
 149          */
 150         [optional, property] boolean PrintEmptyPages;
 151 };
 152
 153 //=============================================================================
 154
 155 }; }; }; };
 156
 157 #endif