offapi/com/sun/star/chart2/Symbol.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef com_sun_star_chart2_Symbol_idl
  28 #define com_sun_star_chart2_Symbol_idl
  29
  30 #ifndef __com_sun_star_drawing_PolyPolygonBezierCoords_idl__
  31 #include <com/sun/star/drawing/PolyPolygonBezierCoords.idl>
  32 #endif
  33
  34 #include <com/sun/star/awt/Size.idl>
  35 #include <com/sun/star/graphic/XGraphic.idl>
  36
  37 #include <com/sun/star/chart2/SymbolStyle.idl>
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module chart2 {
  42
  43 //=============================================================================
  44
  45 /** properties that are used for DataSeries that display symbols.
  46  */
  47 struct Symbol
  48 {
  49     /** determines which of the following members determines the
  50         appearance of the symbol.
  51      */
  52     SymbolStyle                                         Style;
  53
  54     /** The given polygon is used as symbol.
  55      */
  56     com::sun::star::drawing::PolyPolygonBezierCoords    PolygonCoords;
  57
  58     /** Use the nth standard symbol, if <member>Style</member> is set
  59         to <member>SymbolStlye::STANDARD</member>.
  60
  61         <p>If n is the number of standard symbols available in an
  62         implementation, the symbol number is
  63         <member>StandardSymbol</member> modulo n.</p>
  64
  65         <p>The default implementation for example currently uses 8 different
  66         standard symbols that are matched to the numbers 0 to 7.
  67
  68         <table border=1 rules="groups">
  69         <thead>
  70         <tr><th>&nbsp;value StandardSymbol&nbsp;</th><th>&nbsp;visible Symbol&nbsp;</th></tr>
  71         </thead>
  72         <tbody>
  73         <tr><td><code>0</code></td><td>square</td></tr>
  74         <tr><td><code>1</code></td><td>diamond</td></tr>
  75         <tr><td><code>2</code></td><td>down arrow</td></tr>
  76         <tr><td><code>3</code></td><td>up arrow</td></tr>
  77         <tr><td><code>4</code></td><td>right arrow</td></tr>
  78         <tr><td><code>5</code></td><td>left arrow</td></tr>
  79         <tr><td><code>6</code></td><td>bowtie</td></tr>
  80         <tr><td><code>7</code></td><td>sandglass</td></tr>
  81         </tbody>
  82         </table>
  83
  84         </p>
  85      */
  86     long                                                StandardSymbol;
  87
  88     /** use this graphic as symbol
  89      */
  90     com::sun::star::graphic::XGraphic                   Graphic;
  91
  92     /** The size of the symbol in 100th of a mm.
  93
  94         @todo use a structure using doubles insted of longs
  95      */
  96     com::sun::star::awt::Size                           Size;
  97
  98     /** The color used for drawing the border of symbols.
  99
 100         <p>Only effective if <member>Style</member> is
 101         <member>SymbolStyle::AUTO</member>,
 102         <member>SymbolStyle::STANDARD</member> or
 103         <member>SymbolStyle::POLYGON</member>.</p>
 104      */
 105     long                                                BorderColor;
 106
 107     /** The color used for filling symbols that contain closed polygons.
 108
 109         <p>Only effective if <member>Style</member> is
 110         <member>SymbolStyle::AUTO</member>,
 111         <member>SymbolStyle::STANDARD</member> or
 112         <member>SymbolStyle::POLYGON</member>.</p>
 113      */
 114     long                                                FillColor;
 115 };
 116
 117 //=============================================================================
 118
 119 }; }; }; };
 120
 121 #endif
 122