offapi/com/sun/star/sheet/SpreadsheetDrawPage.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: SpreadsheetDrawPage.idl,v $
  10  * $Revision: 1.11 $
  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_sheet_SpreadsheetDrawPage_idl__
  31 #define __com_sun_star_sheet_SpreadsheetDrawPage_idl__
  32
  33 #ifndef __com_sun_star_drawing_XDrawPage_idl__
  34 #include <com/sun/star/drawing/XDrawPage.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_drawing_XShapeGrouper_idl__
  38 #include <com/sun/star/drawing/XShapeGrouper.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_XServiceInfo_idl__
  42 #include <com/sun/star/lang/XServiceInfo.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module sheet {
  48
  49 //=============================================================================
  50
  51 /** This abstract service is implemented by every page of a
  52     <type>SpreadsheetDocument</type>.
  53
  54     @example create and insert a couple of <type scope="com::sun::star::drawing">LineShape</type>s:
  55
  56     <listing>
  57     xPage = xDoc.DrawPages(0)
  58     for x% = 0 to 200
  59     xShape = xProv.createInstance( "com.sun.star.drawing.LineShape" )
  60     xShape.LineColor = rgb( 255, 0, n%+20 )
  61     xShape.LineWidth = 20
  62     xShape.Position = Point( x%, 2*x% )
  63     xShape.Size = Size( 300-x%, 20 )
  64     xPage.add( xShape )
  65     next x%
  66     </listing>
  67
  68     @since OOo 1.1.2
  69  */
  70 published service SpreadsheetDrawPage
  71 {
  72
  73
  74     /** manages the <type scope="com::sun::star::drawing">Shape</type>s of this page.
  75
  76                 <p>It also lets you add new <type scope="com::sun::star::drawing">Shape</type>s. The program currently
  77                 requires that these <type scope="com::sun::star::drawing">Shape</type>s be created by the factory of
  78                 the     document.
  79
  80                 @see SpreadsheetDocument
  81      */
  82     interface com::sun::star::drawing::XDrawPage;
  83
  84
  85     /** With this interface you can group/ungroup a collection of
  86                 <type scope="com::sun::star::drawing">Shape</type>s.
  87      */
  88     interface com::sun::star::drawing::XShapeGrouper;
  89
  90
  91     /** returns the services implemented by this instance.
  92      */
  93     interface com::sun::star::lang::XServiceInfo;
  94 };
  95
  96 //=============================================================================
  97
  98 }; }; }; };
  99
 100 #endif