offapi/com/sun/star/presentation/DocumentSettings.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_presentation_DocumentSettings_idl__
  29 #define __com_sun_star_presentation_DocumentSettings_idl__
  30
  31 #include <com/sun/star/document/HeaderFooterSettings.idl>
  32 #include <com/sun/star/document/Settings.idl>
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module presentation {
  37
  38 //=============================================================================
  39
  40 /** describes properties that apply to the whole presentation document.
  41  */
  42 published service DocumentSettings
  43 {
  44     /** This service documents the common properties of an office document
  45      */
  46     service com::sun::star::document::Settings;
  47
  48     //-------------------------------------------------------------------------
  49
  50     /** This service configures the header and footer settings during print
  51      */
  52     [optional] service com::sun::star::document::HeaderFooterSettings;
  53
  54     //-------------------------------------------------------------------------
  55
  56     /** provides access to the properties.
  57      */
  58     interface com::sun::star::beans::XPropertySet;
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** enables or disables the printing of the drawing pages
  63      */
  64     [optional, property] boolean IsPrintDrawing;
  65
  66     /** enables or disables the printing of the notes pages
  67      */
  68     [optional, property] boolean IsPrintNotes;
  69
  70     /** enables or disables the printing of the handout pages
  71      */
  72     [optional, property] boolean IsPrintHandout;
  73
  74     /** enables or disables the printing of the outline pages
  75      */
  76     [optional, property] boolean IsPrintOutline;
  77
  78     /** enables or disables the printing of draw pages that
  79         are marked hidden
  80      */
  81     [optional, property] boolean IsPrintHiddenPages;
  82
  83     // Note: the following properties exist also in
  84     // css::drawing::DocumentSettings
  85
  86     // ------------------------------------------------------------
  87
  88     /** enables or disables the fitting of the page to the printable
  89         area during print
  90      */
  91     [optional, property] boolean IsPrintFitPage;
  92
  93     /** if this is true and the paper size for printing is larger than
  94         the paper size of the printer than the content is tiled over
  95         multiple pages.
  96      */
  97     [optional, property] boolean IsPrintTilePage;
  98
  99     /** is the number format used for page number fields
 100      */
 101     [optional, property] long PageNumberFormat;
 102
 103     /** If this is true, the distance between two paragraphs is
 104         the sum of ParaTopMargin of the previous and ParaBottomMargin of
 105         the next paragraph. If false, only the greater of the two is
 106         chosen.
 107      */
 108     [optional, property] boolean ParagraphSummation;
 109
 110 };
 111
 112 //=============================================================================
 113
 114 }; }; }; };
 115
 116 #endif
 117
 118 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */