summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/chart/XChartDocument.idl
blob: 1dc3930e3eb8e80ca535c349f54ec6aace3e059b (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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/*************************************************************************
 *
 *  $RCSfile: XChartDocument.idl,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 09:21:15 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_chart_XChartDocument_idl__
#define __com_sun_star_chart_XChartDocument_idl__

#ifndef __com_sun_star_frame_XModel_idl__
#include <com/sun/star/frame/XModel.idl>
#endif

#ifndef __com_sun_star_drawing_XShape_idl__
#include <com/sun/star/drawing/XShape.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_chart_XDiagram_idl__
#include <com/sun/star/chart/XDiagram.idl>
#endif

#ifndef __com_sun_star_chart_XChartData_idl__
#include <com/sun/star/chart/XChartData.idl>
#endif


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

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

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

// DocMerge from xml: interface com::sun::star::chart::XChartDocument
/** manages the chart document.@see        XDiagram
        @see        XChartData
 */
[ uik(E2281603-33D6-11D1-AABE00A0-249D5590), ident( "XChartDocument", 1.0 ) ]
interface XChartDocument: com::sun::star::frame::XModel
{
    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::chart::XChartDocument::getTitle
    /** @returns
                the shape of the main title of the chart document.

                @see service ChartTitle
     */
    [const] com::sun::star::drawing::XShape getTitle();

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

    // DocMerge from idl: method com::sun::star::chart::XChartDocument::getSubTitle
    /** @returns
                the shape of the subtitle of the chart document.

                @see service ChartTitle
     */
    [const] com::sun::star::drawing::XShape getSubTitle();

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

    // DocMerge from idl: method com::sun::star::chart::XChartDocument::getLegend
    /** @returns
                the shape of the legend of the chart document.

                @see service ChartLegend
     */
    [const] com::sun::star::drawing::XShape getLegend();

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

    // DocMerge from idl: method com::sun::star::chart::XChartDocument::getArea
    /** @returns
                the properties of the background area of the chart document.

                @see service ChartArea
     */
    [const] com::sun::star::beans::XPropertySet getArea();

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

    // DocMerge from idl: method com::sun::star::chart::XChartDocument::getDiagram
    /** @returns
                the diagram of the chart document.

                @see service Diagram
     */
    [const] com::sun::star::chart::XDiagram getDiagram();

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

    // DocMerge from xml: method com::sun::star::chart::XChartDocument::setDiagram
    /** sets the diagram for the chart document.



        <p>The diagram component itself is created by
        <type scope="com::sun::star::lang">XMultiServiceFactory</type>,
        which is supplied by the <type>ChartDocument</type>.

        </p>
        <p>Setting a new diagram implicitly disposes the previous diagram.</p>
     */
    void setDiagram( [in] com::sun::star::chart::XDiagram xDiagram );

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

    // DocMerge from idl: method com::sun::star::chart::XChartDocument::getData
    /** @returns
                the data source of the chart.

                @see service ChartData
     */
    [const] com::sun::star::chart::XChartData getData();

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

    // DocMerge from xml: method com::sun::star::chart::XChartDocument::attachData
    /** attaches an external data source to the chart.@see service ChartData
     */
    void attachData( [in] com::sun::star::chart::XChartData xData );

};

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

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:35:03  hjs
    initial import

    Revision 1.3  2000/09/11 11:52:16  mi
    documentation merged from XML

    Revision 1.1.1.1  1999/11/11 09:48:41  jsc
    new


=============================================================================*/
#endif