offapi/com/sun/star/drawing/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.6 $
  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_drawing_DocumentSettings_idl__
  31 #define __com_sun_star_drawing_DocumentSettings_idl__
  32
  33 #ifndef __com_sun_star_document_Settings_idl__
  34 #include <com/sun/star/document/Settings.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_document_HeaderFooterSettings_idl__
  38 #include <com/sun/star/document/HeaderFooterSettings.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {  module sun {  module star {  module drawing {
  44
  45 //=============================================================================
  46
  47 /** describes properties that apply to the whole drawing document.
  48  */
  49 published service DocumentSettings
  50 {
  51     service com::sun::star::document::Settings;
  52
  53     //-------------------------------------------------------------------------
  54     /** This service configures the header and footer settings during print
  55      */
  56     [optional] service com::sun::star::document::HeaderFooterSettings;
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** provides access to the properties.
  61      */
  62     interface com::sun::star::beans::XPropertySet;
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** This is the default logical measure unit that is used for string
  67         formatings inside the document, f.e. the measure text
  68      */
  69     [optional, property] short MeasureUnit;
  70
  71     /** is the numerator for the logical scale of the document
  72      */
  73     [optional, property] long ScaleNumerator;
  74
  75     /** is the denominator for the logical scale of the document
  76      */
  77     [optional, property] long ScaleDenominator;
  78
  79     // Note: the following properties exist also in
  80     // css::presentation::DocumentSettings
  81
  82     // ------------------------------------------------------------
  83
  84     /** enables or disables the fitting of the page to the printable
  85         area during print
  86      */
  87     [optional, property] boolean IsPrintFitPage;
  88
  89     /** if this is true and the paper size for printing is larger than
  90         the paper size of the printer than the content is tiled over
  91         multiple pages.
  92      */
  93     [optional, property] boolean IsPrintTilePage;
  94
  95     /** is the number format used for page number fields
  96      */
  97     [optional, property] long PageNumberFormat;
  98
  99     /** If this is true, the distance between two paragraphs is
 100         the sum of ParaTopMargin of the previous and ParaBottomMargin of
 101         the next paragraph. If false, only the greater of the two is
 102         choosen.
 103      */
 104     [optional, property] boolean ParagraphSummation;
 105
 106 };
 107
 108 //=============================================================================
 109
 110 }; }; }; };
 111
 112 #endif