offapi/com/sun/star/text/PrintSettings.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_PrintSettings_idl__
  28 #define __com_sun_star_text_PrintSettings_idl__
  29
  30 #ifndef __com_sun_star_text_NotePrintMode_idl__
  31 #include <com/sun/star/text/NotePrintMode.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37  module com {  module sun {  module star {  module text {
  38
  39 //=============================================================================
  40
  41 // DocMerge from xml: service com::sun::star::text::PrintSettings
  42 /** These properties describe the printing of the content of a text document.
  43  */
  44 published service PrintSettings
  45 {
  46     //-------------------------------------------------------------------------
  47
  48     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintGraphics
  49     /** determines if graphic objects are printed
  50      */
  51     [property] boolean PrintGraphics;
  52
  53     //-------------------------------------------------------------------------
  54
  55     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintTables
  56     /** determines if text tables are printed.
  57      */
  58     [property] boolean PrintTables;
  59
  60     //-------------------------------------------------------------------------
  61
  62     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintDrawings
  63     /** determines if shapes are printed.
  64      */
  65     [property] boolean PrintDrawings;
  66
  67     //-------------------------------------------------------------------------
  68
  69     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintLeftPage
  70     /** determines if left pages are printed.
  71      */
  72     [property] boolean PrintLeftPages;
  73
  74     //-------------------------------------------------------------------------
  75
  76     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintRightPage
  77     /** determines if right pages are printed.
  78      */
  79     [property] boolean PrintRightPages;
  80
  81     //-------------------------------------------------------------------------
  82
  83     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintControls
  84     /** determines if control shapes are printed.
  85      */
  86     [property] boolean PrintControls;
  87
  88     //-------------------------------------------------------------------------
  89
  90     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintReverse
  91     /** determines if the pages are printed in the reverse order, starting with the last page.
  92      */
  93     [property] boolean PrintReversed;
  94
  95     //-------------------------------------------------------------------------
  96
  97     // DocMerge from xml: property com::sun::star::text::PrintSettings::PaperFromSetup
  98     /** specifies if the printer paper tray selection of the system
  99         printer is used.
 100
 101
 102
 103         <p>If <member scope="com::sun::star::view">PrintSettings::PaperFromSetup</member> is <FALSE/>,
 104         then the paper tray selection of the page styles is used.</p>
 105      */
 106     [property] boolean PrintPaperFromSetup;
 107
 108     //-------------------------------------------------------------------------
 109
 110     // DocMerge from xml: property com::sun::star::text::PrintSettings::FaxName
 111     /** contains the name of the fax.
 112      */
 113     [property] string PrintFaxName;
 114
 115     //-------------------------------------------------------------------------
 116
 117     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintNotes
 118     /** determines how notes are printed.@see NotePrintMode
 119      */
 120     [property] com::sun::star::text::NotePrintMode PrintAnnotationMode;
 121
 122     //-------------------------------------------------------------------------
 123
 124     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintProspect
 125     /** determines if prospect printing is used.
 126      */
 127     [property] boolean PrintProspect;
 128
 129     //-------------------------------------------------------------------------
 130
 131     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintBackground
 132     /** determines if the background color / background graphic of pages is printed.
 133      */
 134     [property] boolean PrintPageBackground;
 135
 136     //-------------------------------------------------------------------------
 137
 138     // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintBlackFont
 139     /** determines if characters are always printed in black.
 140      */
 141     [property] boolean PrintBlackFonts;
 142
 143         //-------------------------------------------------------------------------
 144
 145         /** determines if automatically inserted empty pages are printed.
 146          */
 147         [optional, property] boolean PrintEmptyPages;
 148 };
 149
 150 //=============================================================================
 151
 152 }; }; }; };
 153
 154 #endif