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