offapi/com/sun/star/chart/ChartLegend.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: ChartLegend.idl,v $
  10  * $Revision: 1.14.94.1 $
  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_chart_ChartLegend_idl__
  31 #define __com_sun_star_chart_ChartLegend_idl__
  32
  33 #ifndef __com_sun_star_drawing_Shape_idl__
  34 #include <com/sun/star/drawing/Shape.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_style_CharacterProperties_idl__
  38 #include <com/sun/star/style/CharacterProperties.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_chart_ChartLegendPosition_idl__
  42 #include <com/sun/star/chart/ChartLegendPosition.idl>
  43 #endif
  44
  45 #ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
  46 #include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module chart {
  53
  54 //=============================================================================
  55
  56 /** specifies the legend of a chart.
  57
  58
  59
  60     <p>The text/font properties which are specified in the service
  61     <type scope="com::sun::star::drawing">Shape</type> correlate to all text
  62     objects inside the legend.</p>
  63  */
  64 published service ChartLegend
  65 {
  66     service com::sun::star::drawing::Shape;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** If this property is <TRUE/> the position is calculated by the application automatically.
  71         Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
  72         to set a concrete position.
  73      */
  74     [optional, property] boolean AutomaticPosition;
  75
  76     //-------------------------------------------------------------------------
  77
  78     service com::sun::star::style::CharacterProperties;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** If a <type>ChartLegend</type> may be stored as XML file,
  83         this service should be supported in order to preserve unparsed
  84         XML attributes.
  85
  86     @since OOo 1.1.2
  87      */
  88     [optional] service com::sun::star::xml::UserDefinedAttributeSupplier;
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** determines the alignment of the legend relative
  93         to the diagram.
  94      */
  95     [property] com::sun::star::chart::ChartLegendPosition Alignment;
  96
  97 };
  98
  99 //=============================================================================
 100
 101 }; }; }; };
 102
 103 #endif