offapi/com/sun/star/chart2/Symbol.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
  20
  21 module com {  module sun {  module star {  module chart2 {
  22
  23
  24 /** properties that are used for DataSeries that display symbols.
  25  */
  26 struct Symbol
  27 {
  28     /** determines which of the following members determines the
  29         appearance of the symbol.
  30      */
  31     SymbolStyle                                         Style;
  32
  33     /** The given polygon is used as symbol.
  34      */
  35     com::sun::star::drawing::PolyPolygonBezierCoords    PolygonCoords;
  36
  37     /** Use the nth standard symbol, if #Style is set
  38         to SymbolStyle::STANDARD.
  39
  40         <p>If n is the number of standard symbols available in an
  41         implementation, the symbol number is
  42         #StandardSymbol modulo n.</p>
  43
  44         <p>The default implementation for example currently uses 8 different
  45         standard symbols that are matched to the numbers 0 to 7.
  46
  47         <table border=1>
  48         <tr><th>&nbsp;value StandardSymbol&nbsp;</th><th>&nbsp;visible Symbol&nbsp;</th></tr>
  49         <tr><td><code>0</code></td><td>square</td></tr>
  50         <tr><td><code>1</code></td><td>diamond</td></tr>
  51         <tr><td><code>2</code></td><td>down arrow</td></tr>
  52         <tr><td><code>3</code></td><td>up arrow</td></tr>
  53         <tr><td><code>4</code></td><td>right arrow</td></tr>
  54         <tr><td><code>5</code></td><td>left arrow</td></tr>
  55         <tr><td><code>6</code></td><td>bowtie</td></tr>
  56         <tr><td><code>7</code></td><td>sandglass</td></tr>
  57         </table>
  58
  59         </p>
  60      */
  61     long                                                StandardSymbol;
  62
  63     /** use this graphic as symbol
  64      */
  65     com::sun::star::graphic::XGraphic                   Graphic;
  66
  67     /** The size of the symbol in 100th of a mm.
  68
  69         @todo use a structure using doubles instead of longs
  70      */
  71     com::sun::star::awt::Size                           Size;
  72
  73     /** The color used for drawing the border of symbols.
  74
  75         <p>Only effective if #Style is
  76         SymbolStyle::AUTO,
  77         SymbolStyle::STANDARD or
  78         SymbolStyle::POLYGON.</p>
  79      */
  80     long                                                BorderColor;
  81
  82     /** The color used for filling symbols that contain closed polygons.
  83
  84         <p>Only effective if #Style is
  85         SymbolStyle::AUTO,
  86         SymbolStyle::STANDARD or
  87         SymbolStyle::POLYGON.</p>
  88      */
  89     long                                                FillColor;
  90 };
  91
  92
  93 }; }; }; };
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */