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