xref: /trunk/main/offapi/com/sun/star/chart/ChartTitle.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_chart_ChartTitle_idl__
24#define __com_sun_star_chart_ChartTitle_idl__
25
26#ifndef __com_sun_star_drawing_Shape_idl__
27#include <com/sun/star/drawing/Shape.idl>
28#endif
29
30#ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
31#include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
32#endif
33
34//=============================================================================
35
36 module com {  module sun {  module star {  module chart {
37
38//=============================================================================
39
40/** specifies titles in a chart.
41
42    <p>In a chart there may be the following titles: the main title,
43	the sub title, and axis titles of the x- and y-axis.</p>
44 */
45published service ChartTitle
46{
47	service com::sun::star::drawing::Shape;
48
49    //-------------------------------------------------------------------------
50
51	/** If this property is <TRUE/> the position is calculated by the application automatically.
52        Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
53        to set a concrete position.
54	 */
55	[optional, property] boolean AutomaticPosition;
56
57    //-------------------------------------------------------------------------
58
59    /** If a <type>ChartTitle</type> may be stored as XML element,
60        this service should be supported in order to preserve unparsed
61        XML attributes.
62
63	@since OOo 1.1.2
64     */
65    [optional] service com::sun::star::xml::UserDefinedAttributeSupplier;
66
67	//-------------------------------------------------------------------------
68
69	/** specifies the rotation of the shape in 100th of degrees.
70
71		<p>Especially in three-dimensional charts, this property comes
72		in handy if you want to align the axis titles with the axis,
73		which are usually not vertical or horizontal in the
74		two-dimensional projection.</p>
75	 */
76	[property] long TextRotation;
77
78	//-------------------------------------------------------------------------
79
80	/** contains the text of the title.
81
82        <p>Note that you can not change attributes of parts of a
83        title, e.g., put one word in bold characters.  All formatting
84        affects the entire string.</p>
85	 */
86	[property] string String;
87
88};
89
90//=============================================================================
91
92}; }; }; };
93
94#endif
95