oovbaapi/ooo/vba/excel/SheetObjects.idl

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 #ifndef __ooo_vba_excel_SheetObjects_idl__
  20 #define __ooo_vba_excel_SheetObjects_idl__
  21
  22 #include <ooo/vba/XCollection.idl>
  23 #include <ooo/vba/excel/XGraphicObjects.idl>
  24
  25 //=============================================================================
  26
  27 /*  Note: This file collects all compatibility interfaces for collections of
  28     drawing objects and drawing controls embedded in sheets. All these symbols
  29     are deprecated in VBA and kept for compatibility with old VBA scripts. */
  30
  31 //=============================================================================
  32
  33 module ooo {  module vba { module excel {
  34
  35 //=============================================================================
  36
  37 /** Collections that implement this interface provide access to a specific type
  38     of drawing objects in a single sheet.
  39
  40     <p>The following sheet symbols represent collections of line objects, and
  41     therefore implement this interface:</p>
  42     <ul><li>Arcs: arc objects, and</li>
  43     <li>Lines: straight line ojects.</li></ul>
  44
  45     <p>These symbols are now deprecated in VBA but kept for compatibility with
  46     old VBA scripts.</p>
  47  */
  48 interface XLineObjects : com::sun::star::uno::XInterface
  49 {
  50     /** Adds a new line object to the sheet this collection belongs to. The
  51         type of the object is determined by the type of the collection.
  52
  53         @param X1  Position of the first X coordinate in points (1/72 inch).
  54         @param Y1  Position of the first Y coordinate in points (1/72 inch).
  55         @param X2  Position of the last X coordinate in points (1/72 inch).
  56         @param Y2  Position of the last Y coordinate in points (1/72 inch).
  57
  58         @return  The created line object.
  59      */
  60     any Add( [in] any X1, [in] any Y1, [in] any X2, [in] any Y2 );
  61 };
  62
  63 //=============================================================================
  64
  65 /** A collection providing access to all polygon objects in a single sheet.
  66
  67     <p>This symbol is now deprecated in VBA but kept for compatibility with old
  68     VBA scripts.</p>
  69  */
  70 interface XDrawings : com::sun::star::uno::XInterface
  71 {
  72     /** Adds a new polygon object to the sheet this collection belongs to.
  73
  74         @param X1  Position of the first X coordinate in points (1/72 inch).
  75         @param Y1  Position of the first Y coordinate in points (1/72 inch).
  76         @param X2  Position of the last X coordinate in points (1/72 inch).
  77         @param Y2  Position of the last Y coordinate in points (1/72 inch).
  78         @param Closed  True = outline closed (last and first point connected).
  79
  80         @return  The created polygon object.
  81      */
  82     any Add( [in] any X1, [in] any Y1, [in] any X2, [in] any Y2, [in] any Closed );
  83 };
  84
  85 //=============================================================================
  86
  87 /** Represents the collection of drawing button controls in a spreadsheet. */
  88 service Buttons
  89 {
  90     interface ooo::vba::XCollection;
  91     interface XGraphicObjects;
  92 };
  93
  94 //=============================================================================
  95
  96 }; }; };
  97
  98 #endif