offapi/com/sun/star/drawing/PageShape.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: PageShape.idl,v $
  10  * $Revision: 1.7 $
  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_PageShape_idl__
  31 #define __com_sun_star_drawing_PageShape_idl__
  32
  33 #ifndef __com_sun_star_drawing_Shape_idl__
  34 #include <com/sun/star/drawing/Shape.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::PageShape
  45 /** This service is for a page shape.
  46     A page shape displays a preview of another page. These shapes
  47     are used inside notes pages to preview the corresponding
  48     drawing page. Theyre also used in the handout page to preview
  49     the printing position and order of pages
  50  */
  51 published service PageShape
  52 {
  53     // DocMerge: empty anyway
  54     service com::sun::star::drawing::Shape;
  55
  56     /** this is the page number that is used for the preview.
  57         For page shapes on notes pages, this can't be changed.
  58         For page shapes on handout pages, this value only
  59         describes the relative order of the different page
  60         shapes on the page.
  61     */
  62     [optional, property] long PageNumber;
  63 };
  64
  65 //=============================================================================
  66
  67 }; }; }; };
  68
  69 #endif
  70