offapi/com/sun/star/chart/ChartTitle.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_chart_ChartTitle_idl__
  28 #define __com_sun_star_chart_ChartTitle_idl__
  29
  30 #ifndef __com_sun_star_drawing_Shape_idl__
  31 #include <com/sun/star/drawing/Shape.idl>
  32 #endif
  33
  34 #ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
  35 #include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module chart {
  41
  42 //=============================================================================
  43
  44 /** specifies titles in a chart.
  45
  46     <p>In a chart there may be the following titles: the main title,
  47     the sub title, and axis titles of the x- and y-axis.</p>
  48  */
  49 published service ChartTitle
  50 {
  51     service com::sun::star::drawing::Shape;
  52
  53     //-------------------------------------------------------------------------
  54
  55     /** If this property is <TRUE/> the position is calculated by the application automatically.
  56         Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
  57         to set a concrete position.
  58      */
  59     [optional, property] boolean AutomaticPosition;
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** If a <type>ChartTitle</type> may be stored as XML element,
  64         this service should be supported in order to preserve unparsed
  65         XML attributes.
  66
  67     @since OOo 1.1.2
  68      */
  69     [optional] service com::sun::star::xml::UserDefinedAttributeSupplier;
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** specifies the rotation of the shape in 100th of degrees.
  74
  75         <p>Especially in three-dimensional charts, this property comes
  76         in handy if you want to align the axis titles with the axis,
  77         which are usually not vertical or horizontal in the
  78         two-dimensional projection.</p>
  79      */
  80     [property] long TextRotation;
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** contains the text of the title.
  85
  86         <p>Note that you can not change attributes of parts of a
  87         title, e.g., put one word in bold characters.  All formatting
  88         affects the entire string.</p>
  89      */
  90     [property] string String;
  91
  92 };
  93
  94 //=============================================================================
  95
  96 }; }; }; };
  97
  98 #endif