offapi/com/sun/star/sheet/SpreadsheetDrawPage.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_sheet_SpreadsheetDrawPage_idl__
  20 #define __com_sun_star_sheet_SpreadsheetDrawPage_idl__
  21
  22 #include <com/sun/star/drawing/XDrawPage.idl>
  23 #include <com/sun/star/drawing/XShapeGrouper.idl>
  24
  25
  26  module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** This abstract service is implemented by every page of a
  30     SpreadsheetDocument.
  31
  32     Example: create and insert a couple of com::sun::star::drawing::LineShapes:
  33
  34     @code{.bas}
  35     xPage = xDoc.DrawPages(0)
  36     for x% = 0 to 200
  37     xShape = xProv.createInstance( "com.sun.star.drawing.LineShape" )
  38     xShape.LineColor = rgb( 255, 0, n%+20 )
  39     xShape.LineWidth = 20
  40     xShape.Position = Point( x%, 2*x% )
  41     xShape.Size = Size( 300-x%, 20 )
  42     xPage.add( xShape )
  43     next x%
  44     @endcode
  45
  46     @since OOo 1.1.2
  47  */
  48 published service SpreadsheetDrawPage
  49 {
  50
  51
  52     /** manages the com::sun::star::drawing::Shapes of this page.
  53
  54                 <p>It also lets you add new com::sun::star::drawing::Shapes. The program currently
  55                 requires that these com::sun::star::drawing::Shapes be created by the factory of
  56                 the document.
  57
  58                 @see SpreadsheetDocument
  59      */
  60     interface com::sun::star::drawing::XDrawPage;
  61
  62
  63     /** With this interface you can group/ungroup a collection of
  64                 com::sun::star::drawing::Shapes.
  65      */
  66     interface com::sun::star::drawing::XShapeGrouper;
  67
  68 };
  69
  70
  71 }; }; }; };
  72
  73 #endif
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */