summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/chart/ChartTitle.idl
blob: d6d283cb1ce65abd7bc7af6890e36c25c2ab98a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: ChartTitle.idl,v $
 * $Revision: 1.15.94.1 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_chart_ChartTitle_idl__
#define __com_sun_star_chart_ChartTitle_idl__

#ifndef __com_sun_star_drawing_Shape_idl__
#include <com/sun/star/drawing/Shape.idl>
#endif

#ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
#include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module chart {

//=============================================================================

/** specifies titles in a chart.

    <p>In a chart there may be the following titles: the main title,
    the sub title, and axis titles of the x- and y-axis.</p>
 */
published service ChartTitle
{
    service com::sun::star::drawing::Shape;

    //-------------------------------------------------------------------------

    /** If this property is <TRUE/> the position is calculated by the application automatically.
        Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
        to set a concrete position.
     */
    [optional, property] boolean AutomaticPosition;

    //-------------------------------------------------------------------------

    /** If a <type>ChartTitle</type> may be stored as XML element,
        this service should be supported in order to preserve unparsed
        XML attributes.

    @since OOo 1.1.2
     */
    [optional] service com::sun::star::xml::UserDefinedAttributeSupplier;

    //-------------------------------------------------------------------------

    /** specifies the rotation of the shape in 100th of degrees.

        <p>Especially in three-dimensional charts, this property comes
        in handy if you want to align the axis titles with the axis,
        which are usually not vertical or horizontal in the
        two-dimensional projection.</p>
     */
    [property] long TextRotation;

    //-------------------------------------------------------------------------

    /** contains the text of the title.

        <p>Note that you can not change attributes of parts of a
        title, e.g., put one word in bold characters.  All formatting
        affects the entire string.</p>
     */
    [property] string String;

};

//=============================================================================

}; }; }; };

#endif