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

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