offapi/com/sun/star/document/HeaderFooterSettings.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: HeaderFooterSettings.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_document_HeaderFooterSettings_idl__
  31 #define __com_sun_star_document_HeaderFooterSettings_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {   module sun {   module star {   module document {
  40
  41 //=============================================================================
  42
  43 // Note: Where is the distinction between header and footer ?
  44 /** describes properties that control the formatting of headers and
  45     footers for documents that do not allow individual settings for
  46     individual parts like pages or slides.
  47  */
  48 published service HeaderFooterSettings
  49 {
  50     /** gives access to the properties implemented by this service.
  51      */
  52     interface com::sun::star::beans::XPropertySet;
  53
  54     //-------------------------------------------------------------------------
  55
  56     /** enables or disables the printing of the page name in the
  57         header or footer
  58      */
  59     [optional, property] boolean IsPrintPageName;
  60
  61     /** enables or disables the printing of the date in the
  62         header or footer
  63      */
  64     [optional, property] boolean IsPrintDate;
  65
  66     /** enables or disables the printinge of the current time in the
  67         header or footer
  68      */
  69     [optional, property] boolean IsPrintTime;
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif