oovbaapi/ooo/vba/excel/XGraphicObjects.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 /*  Note: This is a compatibility interface for drawing objects and drawing
  20     controls embedded in sheets. All these symbols are deprecated
  21     in VBA and kept for compatibility with old VBA scripts. */
  22
  23 #ifndef __ooo_vba_excel_XGraphicObjects_idl__
  24 #define __ooo_vba_excel_XGraphicObjects_idl__
  25
  26 #include <ooo/vba/XCollection.idl>
  27
  28 //=============================================================================
  29
  30 /*  Note: This file collects all compatibility interfaces for collections of
  31     drawing objects and drawing controls embedded in sheets. All these symbols
  32     are deprecated in VBA and kept for compatibility with old VBA scripts. */
  33
  34 //=============================================================================
  35
  36 module ooo {  module vba { module excel {
  37
  38 //=============================================================================
  39
  40 /** Collections that implement this interface provide access to a specific type
  41     of drawing objects in a single sheet.
  42
  43     <p>The following sheet symbols represent collections of graphic objects,
  44     and therefore implement this interface:</p>
  45     <ul><li>Buttons: push button (command button) controls,</li>
  46     <li>ChartObjects: chart objects embedded in the sheet,</li>
  47     <li>CheckBoxes: check box controls,</li>
  48     <li>DropDowns: drop-down listbox controls,</li>
  49     <li>EditBoxes: text edit controls (dialog sheets only),</li>
  50     <li>GroupBoxes: group frame controls,</li>
  51     <li>GroupObjects: group objects containing other child objects,</li>
  52     <li>Labels: fixed text controls,</li>
  53     <li>ListBoxes: plain listbox controls,</li>
  54     <li>OptionButtons: option button (radio button) controls,</li>
  55     <li>Ovals: simple ovals and circles,</li>
  56     <li>Pictures: picture objects,</li>
  57     <li>Rectangles: simple rectangle objects,</li>
  58     <li>ScrollBars: scrollbar controls,</li>
  59     <li>Spinners: spinner (spin button) controls,</li>
  60     <li>TextBoxes: rectangle objects with embedded text.</li></ul>
  61
  62     <p>These symbols are now deprecated in VBA but kept for compatibility with
  63     old VBA scripts. All symbols representing collections of form controls do
  64     NOT belong to ActiveX form controls but to the old-style drawing controls.
  65     </p>
  66  */
  67 interface XGraphicObjects : com::sun::star::uno::XInterface
  68 {
  69     /** Adds a new graphic object to the sheet this collection belongs to. The
  70         type of the object is determined by the type of the collection.
  71
  72         @param Left  Position of the left border in points (1/72 inch).
  73         @param Top  Position of the top border in points (1/72 inch).
  74         @param Width  Width of the object in points (1/72 inch).
  75         @param Height  Height of the object in points (1/72 inch).
  76
  77         @return  The created graphic object.
  78      */
  79     any Add( [in] any Left, [in] any Top, [in] any Width, [in] any Height );
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; };
  85
  86 #endif