offapi/com/sun/star/drawing/MasterPage.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: MasterPage.idl,v $
  10  * $Revision: 1.8 $
  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_MasterPage_idl__
  31 #define __com_sun_star_drawing_MasterPage_idl__
  32
  33 #ifndef __com_sun_star_drawing_GenericDrawPage_idl__
  34 #include <com/sun/star/drawing/GenericDrawPage.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module drawing {
  41
  42 //=============================================================================
  43
  44 // DocMerge from xml: service com::sun::star::drawing::MasterPage
  45 /** This service is a single master page inside a drawing document.
  46
  47
  48     <p>It serves as a background page for zero or more <type>DrawPage</type>s.
  49     Since this service is derived from the service <type>GenericDrawPage</type>,
  50     it can be used as a draw page with three differences:
  51     </p>
  52     <ol>
  53     <li>It is not linked to any other <type>MasterPage</type>.
  54     </li>
  55     <li>It cannot be removed from a document as long as one or
  56     more instances of <type>DrawPage</type> are linked to it.
  57     </li>
  58     <li>Modifications to a <type>MasterPage</type> are instantly visible on
  59     every <type>DrawPage</type> that is linked to it.
  60     </li>
  61     </ol>
  62  */
  63 published service MasterPage
  64 {
  65
  66
  67     // DocMerge from xml: service com::sun::star::drawing::MasterPage: service com::sun::star::drawing::GenericDrawPage
  68     /** This service describes the base functionality that every
  69                 draw/master page has.
  70      */
  71     service com::sun::star::drawing::GenericDrawPage;
  72
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif
  80