summaryrefslogtreecommitdiff
path: root/chart2/source/model/template/ChartTypeTemplate.hxx
blob: d59763872a906989960583a4d092a295a83d66e7 (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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
/*************************************************************************
 *
 *  $RCSfile: ChartTypeTemplate.hxx,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: bm $ $Date: 2003-11-04 12:37:32 $
 *
 *  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: 2003 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef CHART_CHARTTYPETEMPLATE_HXX
#define CHART_CHARTTYPETEMPLATE_HXX

#ifndef _CPPUHELPER_IMPLBASE2_HXX_
#include <cppuhelper/implbase2.hxx>
#endif
#include "ServiceMacros.hxx"

#ifndef _COM_SUN_STAR_UNO_XCOMPONENTCONTEXT_HPP_
#include <com/sun/star/uno/XComponentContext.hpp>
#endif
#ifndef _DRAFTS_COM_SUN_STAR_CHART2_XCHARTTYPETEMPLATE_HPP_
#include <drafts/com/sun/star/chart2/XChartTypeTemplate.hpp>
#endif
#ifndef _DRAFTS_COM_SUN_STAR_CHART2_XAXISCONTAINER_HPP_
#include <drafts/com/sun/star/chart2/XAxisContainer.hpp>
#endif
#ifndef _DRAFTS_COM_SUN_STAR_CHART2_STACKMODE_HPP_
#include <drafts/com/sun/star/chart2/StackMode.hpp>
#endif
#ifndef _DRAFTS_COM_SUN_STAR_CHART2_XGRIDCONTAINER_HPP_
#include <drafts/com/sun/star/chart2/XGridContainer.hpp>
#endif
#ifndef _DRAFTS_COM_SUN_STAR_CHART2_XBOUNDEDCOORDINATESYSTEMCONTAINER_HPP_
#include <drafts/com/sun/star/chart2/XBoundedCoordinateSystemContainer.hpp>
#endif
#ifndef _DRAFTS_COM_SUN_STAR_CHART2_XLEGEND_HPP_
#include <drafts/com/sun/star/chart2/XLegend.hpp>
#endif
#ifndef _COM_SUN_STAR_LANG_XSERVICENAME_HPP_
#include <com/sun/star/lang/XServiceName.hpp>
#endif
#ifndef _DRAFTS_COM_SUN_STAR_CHART2_XCHARTTYPE_HPP_
#include <drafts/com/sun/star/chart2/XChartType.hpp>
#endif

namespace chart
{

class ChartTypeTemplate : public ::cppu::WeakImplHelper2<
        ::drafts::com::sun::star::chart2::XChartTypeTemplate,
        ::com::sun::star::lang::XServiceName >
{
public:
    explicit ChartTypeTemplate(
        ::com::sun::star::uno::Reference<
            ::com::sun::star::uno::XComponentContext > const & xContext,
        const ::rtl::OUString & rServiceName );
    virtual ~ChartTypeTemplate();

    APPHELPER_XSERVICEINFO_DECL()
    /// establish methods for factory instatiation
//  APPHELPER_SERVICE_FACTORY_HELPER( ChartTypeTemplate )

protected:
    // ____ XChartTypeTemplate ____
    virtual ::com::sun::star::uno::Reference< ::drafts::com::sun::star::chart2::XDiagram > SAL_CALL
        createDiagram( const ::com::sun::star::uno::Sequence<
                           ::com::sun::star::uno::Reference<
                               ::drafts::com::sun::star::chart2::XDataSeries > >& aSeriesSeq )
        throw (::com::sun::star::uno::RuntimeException);

    // ____ XServiceName ____
    virtual ::rtl::OUString SAL_CALL getServiceName()
        throw (::com::sun::star::uno::RuntimeException);

    // Methods to overload for automatic creation
    // ------------------------------------------

    /// returns 2 by default.  Supported are 2 and 3
    virtual sal_Int32 getDimension() const;

    /** returns StackMode_NONE by default.  This is a global flag used for all series
        if createDataSeriesTree() is not overloaded
     */
    virtual ::drafts::com::sun::star::chart2::StackMode getStackMode() const;

    virtual ::com::sun::star::uno::Reference<
        ::drafts::com::sun::star::chart2::XChartType > getDefaultChartType()
        throw (::com::sun::star::uno::RuntimeException);

    // Methods for creating the diagram piecewise
    // ------------------------------------------

    /** Creates a 2d or 3d cartesian coordinate system with mathematically
        oriented, linear scales with auto-min/max.

        <p>The dimension depends on the property "ChartStyle".</p>

        @param xCoordSysCnt
            If this container is valid, the coordinate system is added to it.
     */
   virtual ::com::sun::star::uno::Reference<
        ::drafts::com::sun::star::chart2::XBoundedCoordinateSystem >
       createCoordinateSystem(
           const ::com::sun::star::uno::Reference<
               ::drafts::com::sun::star::chart2::XBoundedCoordinateSystemContainer > & xCoordSysCnt );

    /** create axes and add them to the given container.

        <p>As default, this method creates as many axes as there are dimensions
        in the given coordinate system.  Each of the axis represents one of the
        dimensions of the coordinate system.</p>
     */
    virtual void createAndAddAxes(
        const ::com::sun::star::uno::Reference<
            ::drafts::com::sun::star::chart2::XBoundedCoordinateSystem > & rCoordSys,
        const ::com::sun::star::uno::Reference<
            ::drafts::com::sun::star::chart2::XAxisContainer > & rOutAxisCnt );

    /** create grids and add them to the given container.

        <p>As default, this method creates a major grid for the second
        coordinate of the coordinate system.</p>
     */
    virtual void createAndAddGrids(
        const ::com::sun::star::uno::Reference<
            ::drafts::com::sun::star::chart2::XBoundedCoordinateSystem > & rCoordSys,
        const ::com::sun::star::uno::Reference<
            ::drafts::com::sun::star::chart2::XGridContainer > & rOutGridCnt );

    /** create a data series tree, that fits the requirements of the chart type.

        <p>As default, this creates a tree with the following structure:</p>

        <pre>
          root
           |
           +-- chart type
                   |
                   +-- category (DiscreteStackableScaleGroup using scale 0)
                          |
                          +-- values (ContinuousStackableScaleGroup using scale 1)
                                |
                                +-- series 0
                                |
                                +-- series 1
                                |
                                ...
                                |
                                +.. series n-1
        </pre>

        <p>If there are less than two scales available the returned tree is
        empty.</p>
     */
    virtual ::com::sun::star::uno::Reference<
        ::drafts::com::sun::star::chart2::XDataSeriesTreeParent > createDataSeriesTree(
            const ::com::sun::star::uno::Sequence<
                ::com::sun::star::uno::Reference<
                    ::drafts::com::sun::star::chart2::XDataSeries > >& aSeriesSeq,
            const ::com::sun::star::uno::Reference<
                ::drafts::com::sun::star::chart2::XBoundedCoordinateSystem > & rCoordSys
            );

    // helper methods
    // --------------
    ::com::sun::star::uno::Reference<
        ::drafts::com::sun::star::chart2::XDataSeriesTreeParent > createRootNode();

    ::com::sun::star::uno::Reference<
        ::drafts::com::sun::star::chart2::XDataSeriesTreeNode >
        createChartTypeGroup(
            const ::com::sun::star::uno::Reference<
                ::drafts::com::sun::star::chart2::XChartType > & xChartType );

    ::com::sun::star::uno::Reference<
        ::drafts::com::sun::star::chart2::XDataSeriesTreeNode >
        createScaleGroup( bool bIsDiscrete,
                          bool bIsStackable,
                          ::com::sun::star::uno::Reference<
                              ::drafts::com::sun::star::chart2::XBoundedCoordinateSystem > xCoordSys,
                          sal_Int32 nRepresentedDimension,
                          ::drafts::com::sun::star::chart2::StackMode eStackMode =
                              ::drafts::com::sun::star::chart2::StackMode_NONE );

    void addDataSeriesToGroup(
        const ::com::sun::star::uno::Reference<
            ::drafts::com::sun::star::chart2::XDataSeriesTreeNode > & rParent,
        const ::com::sun::star::uno::Sequence<
            ::com::sun::star::uno::Reference<
                ::drafts::com::sun::star::chart2::XDataSeries > > & rDataSeries );

    /** Finds the first ContinuousScaleGroup in the tree and sets the stacking
        mode there if it is a stackable group
     */
    void setStackModeAtTree(
        const  ::com::sun::star::uno::Reference<
            ::drafts::com::sun::star::chart2::XDataSeriesTreeParent > & rTree,
        ::drafts::com::sun::star::chart2::StackMode eMode );

    void attachNodeToNode(
        const ::com::sun::star::uno::Reference<
            ::drafts::com::sun::star::chart2::XDataSeriesTreeNode > & rParent,
        const ::com::sun::star::uno::Reference<
            ::drafts::com::sun::star::chart2::XDataSeriesTreeNode > & rChild );

    ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
        GetComponentContext() const;

private:
    ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
        m_xContext;
    const ::rtl::OUString m_aServiceName;

    /** modifies the given diagram
     */
    void FillDiagram( const ::com::sun::star::uno::Reference<
                          ::drafts::com::sun::star::chart2::XDiagram > & xDiagram,
                      const ::com::sun::star::uno::Sequence<
                          ::com::sun::star::uno::Reference<
                              ::drafts::com::sun::star::chart2::XDataSeries > >& aSeriesSeq );
};

} //  namespace chart

// CHART_CHARTTYPETEMPLATE_HXX
#endif