offapi/com/sun/star/presentation/DocumentSettings.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: DocumentSettings.idl,v $
  10  * $Revision: 1.4 $
  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_presentation_DocumentSettings_idl__
  31 #define __com_sun_star_presentation_DocumentSettings_idl__
  32
  33 #ifndef __com_sun_star_document_HeaderFooterSettings_idl__
  34 #include <com/sun/star/document/HeaderFooterSettings.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_document_Settings_idl__
  38 #include <com/sun/star/document/Settings.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {  module sun {  module star {  module presentation {
  44
  45 //=============================================================================
  46
  47 /** describes properties that apply to the whole presentation document.
  48  */
  49 published service DocumentSettings
  50 {
  51     /** This service documents the common properties of an office document
  52      */
  53     service com::sun::star::document::Settings;
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** This service configures the header and footer settings during print
  58      */
  59     [optional] service com::sun::star::document::HeaderFooterSettings;
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** provides access to the properties.
  64      */
  65     interface com::sun::star::beans::XPropertySet;
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** enables or disables the printing of the drawing pages
  70      */
  71     [optional, property] boolean IsPrintDrawing;
  72
  73     /** enables or disables the printing of the notes pages
  74      */
  75     [optional, property] boolean IsPrintNotes;
  76
  77     /** enables or disables the printing of the handout pages
  78      */
  79     [optional, property] boolean IsPrintHandout;
  80
  81     /** enables or disables the printing of the outline pages
  82      */
  83     [optional, property] boolean IsPrintOutline;
  84
  85     /** enables or disables the printing of draw pages that
  86         are marked hidden
  87      */
  88     [optional, property] boolean IsPrintHiddenPages;
  89
  90     // Note: the following properties exist also in
  91     // css::drawing::DocumentSettings
  92
  93     // ------------------------------------------------------------
  94
  95     /** enables or disables the fitting of the page to the printable
  96         area during print
  97      */
  98     [optional, property] boolean IsPrintFitPage;
  99
 100     /** if this is true and the paper size for printing is larger than
 101         the paper size of the printer than the content is tiled over
 102         multiple pages.
 103      */
 104     [optional, property] boolean IsPrintTilePage;
 105
 106     /** is the number format used for page number fields
 107      */
 108     [optional, property] long PageNumberFormat;
 109
 110     /** If this is true, the distance between two paragraphs is
 111         the sum of ParaTopMargin of the previous and ParaBottomMargin of
 112         the next paragraph. If false, only the greater of the two is
 113         choosen.
 114      */
 115     [optional, property] boolean ParagraphSummation;
 116
 117 };
 118
 119 //=============================================================================
 120
 121 }; }; }; };
 122
 123 #endif