xref: /AOO41X/main/chart2/source/inc/TitleHelper.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir #ifndef _CHART2_TOOLS_TITLEHELPER_HXX
28*cdf0e10cSrcweir #define _CHART2_TOOLS_TITLEHELPER_HXX
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir #include "ReferenceSizeProvider.hxx"
31*cdf0e10cSrcweir #include "charttoolsdllapi.hxx"
32*cdf0e10cSrcweir #include <com/sun/star/chart2/XTitled.hpp>
33*cdf0e10cSrcweir #include <com/sun/star/frame/XModel.hpp>
34*cdf0e10cSrcweir #include <com/sun/star/uno/XComponentContext.hpp>
35*cdf0e10cSrcweir #include <com/sun/star/chart2/XDiagram.hpp>
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir //.............................................................................
38*cdf0e10cSrcweir namespace chart
39*cdf0e10cSrcweir {
40*cdf0e10cSrcweir //.............................................................................
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir class OOO_DLLPUBLIC_CHARTTOOLS TitleHelper
43*cdf0e10cSrcweir {
44*cdf0e10cSrcweir public:
45*cdf0e10cSrcweir     enum eTitleType
46*cdf0e10cSrcweir     {
47*cdf0e10cSrcweir         TITLE_BEGIN = 0,
48*cdf0e10cSrcweir         MAIN_TITLE = 0,
49*cdf0e10cSrcweir         SUB_TITLE,
50*cdf0e10cSrcweir         X_AXIS_TITLE,
51*cdf0e10cSrcweir         Y_AXIS_TITLE,
52*cdf0e10cSrcweir         Z_AXIS_TITLE,
53*cdf0e10cSrcweir         SECONDARY_X_AXIS_TITLE,
54*cdf0e10cSrcweir         SECONDARY_Y_AXIS_TITLE,
55*cdf0e10cSrcweir         NORMAL_TITLE_END,
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir         //it is intended that this both types are after NORMAL_TITLE_END
58*cdf0e10cSrcweir         TITLE_AT_STANDARD_X_AXIS_POSITION, //equals the Y_AXIS_TITLE for barchart
59*cdf0e10cSrcweir         TITLE_AT_STANDARD_Y_AXIS_POSITION  //equals the X_AXIS_TITLE for barchart
60*cdf0e10cSrcweir     };
61*cdf0e10cSrcweir 
62*cdf0e10cSrcweir     static ::com::sun::star::uno::Reference<
63*cdf0e10cSrcweir             ::com::sun::star::chart2::XTitle >
64*cdf0e10cSrcweir         getTitle( eTitleType nTitleIndex
65*cdf0e10cSrcweir                     , const ::com::sun::star::uno::Reference<
66*cdf0e10cSrcweir                     ::com::sun::star::frame::XModel >& xModel );
67*cdf0e10cSrcweir 
68*cdf0e10cSrcweir     static ::com::sun::star::uno::Reference<
69*cdf0e10cSrcweir             ::com::sun::star::chart2::XTitle >
70*cdf0e10cSrcweir         createTitle(  eTitleType nTitleIndex
71*cdf0e10cSrcweir                     , const rtl::OUString& rTitleText
72*cdf0e10cSrcweir                     , const ::com::sun::star::uno::Reference<
73*cdf0e10cSrcweir                             ::com::sun::star::frame::XModel >& xModel
74*cdf0e10cSrcweir                     , const ::com::sun::star::uno::Reference<
75*cdf0e10cSrcweir                             ::com::sun::star::uno::XComponentContext > & xContext
76*cdf0e10cSrcweir                     , ReferenceSizeProvider * pRefSizeProvider = 0 );
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir     static void removeTitle( eTitleType nTitleIndex
79*cdf0e10cSrcweir                     , const ::com::sun::star::uno::Reference<
80*cdf0e10cSrcweir                             ::com::sun::star::frame::XModel >& xModel );
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir     static rtl::OUString getCompleteString( const ::com::sun::star::uno::Reference<
83*cdf0e10cSrcweir         ::com::sun::star::chart2::XTitle >& xTitle );
84*cdf0e10cSrcweir     static void setCompleteString( const rtl::OUString& rNewText
85*cdf0e10cSrcweir         , const ::com::sun::star::uno::Reference<
86*cdf0e10cSrcweir             ::com::sun::star::chart2::XTitle >& xTitle
87*cdf0e10cSrcweir         , const ::com::sun::star::uno::Reference<
88*cdf0e10cSrcweir             ::com::sun::star::uno::XComponentContext > & xContext
89*cdf0e10cSrcweir         , float * pDefaultCharHeight = 0 );
90*cdf0e10cSrcweir 
91*cdf0e10cSrcweir     static bool getTitleType( eTitleType& rType
92*cdf0e10cSrcweir                     , const ::com::sun::star::uno::Reference<
93*cdf0e10cSrcweir                         ::com::sun::star::chart2::XTitle >& xTitle
94*cdf0e10cSrcweir                     , const ::com::sun::star::uno::Reference<
95*cdf0e10cSrcweir                         ::com::sun::star::frame::XModel >& xModel );
96*cdf0e10cSrcweir };
97*cdf0e10cSrcweir 
98*cdf0e10cSrcweir //.............................................................................
99*cdf0e10cSrcweir } //namespace chart
100*cdf0e10cSrcweir //.............................................................................
101*cdf0e10cSrcweir #endif
102