xref: /AOO41X/main/chart2/source/inc/TitleHelper.hxx (revision de7b3f825c374d9f7270d1282e9d92876f197200)
1*de7b3f82SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*de7b3f82SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*de7b3f82SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*de7b3f82SAndrew Rist  * distributed with this work for additional information
6*de7b3f82SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*de7b3f82SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*de7b3f82SAndrew Rist  * "License"); you may not use this file except in compliance
9*de7b3f82SAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
11*de7b3f82SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
13*de7b3f82SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*de7b3f82SAndrew Rist  * software distributed under the License is distributed on an
15*de7b3f82SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*de7b3f82SAndrew Rist  * KIND, either express or implied.  See the License for the
17*de7b3f82SAndrew Rist  * specific language governing permissions and limitations
18*de7b3f82SAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
20*de7b3f82SAndrew Rist  *************************************************************/
21*de7b3f82SAndrew Rist 
22*de7b3f82SAndrew Rist 
23cdf0e10cSrcweir #ifndef _CHART2_TOOLS_TITLEHELPER_HXX
24cdf0e10cSrcweir #define _CHART2_TOOLS_TITLEHELPER_HXX
25cdf0e10cSrcweir 
26cdf0e10cSrcweir #include "ReferenceSizeProvider.hxx"
27cdf0e10cSrcweir #include "charttoolsdllapi.hxx"
28cdf0e10cSrcweir #include <com/sun/star/chart2/XTitled.hpp>
29cdf0e10cSrcweir #include <com/sun/star/frame/XModel.hpp>
30cdf0e10cSrcweir #include <com/sun/star/uno/XComponentContext.hpp>
31cdf0e10cSrcweir #include <com/sun/star/chart2/XDiagram.hpp>
32cdf0e10cSrcweir 
33cdf0e10cSrcweir //.............................................................................
34cdf0e10cSrcweir namespace chart
35cdf0e10cSrcweir {
36cdf0e10cSrcweir //.............................................................................
37cdf0e10cSrcweir 
38cdf0e10cSrcweir class OOO_DLLPUBLIC_CHARTTOOLS TitleHelper
39cdf0e10cSrcweir {
40cdf0e10cSrcweir public:
41cdf0e10cSrcweir     enum eTitleType
42cdf0e10cSrcweir     {
43cdf0e10cSrcweir         TITLE_BEGIN = 0,
44cdf0e10cSrcweir         MAIN_TITLE = 0,
45cdf0e10cSrcweir         SUB_TITLE,
46cdf0e10cSrcweir         X_AXIS_TITLE,
47cdf0e10cSrcweir         Y_AXIS_TITLE,
48cdf0e10cSrcweir         Z_AXIS_TITLE,
49cdf0e10cSrcweir         SECONDARY_X_AXIS_TITLE,
50cdf0e10cSrcweir         SECONDARY_Y_AXIS_TITLE,
51cdf0e10cSrcweir         NORMAL_TITLE_END,
52cdf0e10cSrcweir 
53cdf0e10cSrcweir         //it is intended that this both types are after NORMAL_TITLE_END
54cdf0e10cSrcweir         TITLE_AT_STANDARD_X_AXIS_POSITION, //equals the Y_AXIS_TITLE for barchart
55cdf0e10cSrcweir         TITLE_AT_STANDARD_Y_AXIS_POSITION  //equals the X_AXIS_TITLE for barchart
56cdf0e10cSrcweir     };
57cdf0e10cSrcweir 
58cdf0e10cSrcweir     static ::com::sun::star::uno::Reference<
59cdf0e10cSrcweir             ::com::sun::star::chart2::XTitle >
60cdf0e10cSrcweir         getTitle( eTitleType nTitleIndex
61cdf0e10cSrcweir                     , const ::com::sun::star::uno::Reference<
62cdf0e10cSrcweir                     ::com::sun::star::frame::XModel >& xModel );
63cdf0e10cSrcweir 
64cdf0e10cSrcweir     static ::com::sun::star::uno::Reference<
65cdf0e10cSrcweir             ::com::sun::star::chart2::XTitle >
66cdf0e10cSrcweir         createTitle(  eTitleType nTitleIndex
67cdf0e10cSrcweir                     , const rtl::OUString& rTitleText
68cdf0e10cSrcweir                     , const ::com::sun::star::uno::Reference<
69cdf0e10cSrcweir                             ::com::sun::star::frame::XModel >& xModel
70cdf0e10cSrcweir                     , const ::com::sun::star::uno::Reference<
71cdf0e10cSrcweir                             ::com::sun::star::uno::XComponentContext > & xContext
72cdf0e10cSrcweir                     , ReferenceSizeProvider * pRefSizeProvider = 0 );
73cdf0e10cSrcweir 
74cdf0e10cSrcweir     static void removeTitle( eTitleType nTitleIndex
75cdf0e10cSrcweir                     , const ::com::sun::star::uno::Reference<
76cdf0e10cSrcweir                             ::com::sun::star::frame::XModel >& xModel );
77cdf0e10cSrcweir 
78cdf0e10cSrcweir     static rtl::OUString getCompleteString( const ::com::sun::star::uno::Reference<
79cdf0e10cSrcweir         ::com::sun::star::chart2::XTitle >& xTitle );
80cdf0e10cSrcweir     static void setCompleteString( const rtl::OUString& rNewText
81cdf0e10cSrcweir         , const ::com::sun::star::uno::Reference<
82cdf0e10cSrcweir             ::com::sun::star::chart2::XTitle >& xTitle
83cdf0e10cSrcweir         , const ::com::sun::star::uno::Reference<
84cdf0e10cSrcweir             ::com::sun::star::uno::XComponentContext > & xContext
85cdf0e10cSrcweir         , float * pDefaultCharHeight = 0 );
86cdf0e10cSrcweir 
87cdf0e10cSrcweir     static bool getTitleType( eTitleType& rType
88cdf0e10cSrcweir                     , const ::com::sun::star::uno::Reference<
89cdf0e10cSrcweir                         ::com::sun::star::chart2::XTitle >& xTitle
90cdf0e10cSrcweir                     , const ::com::sun::star::uno::Reference<
91cdf0e10cSrcweir                         ::com::sun::star::frame::XModel >& xModel );
92cdf0e10cSrcweir };
93cdf0e10cSrcweir 
94cdf0e10cSrcweir //.............................................................................
95cdf0e10cSrcweir } //namespace chart
96cdf0e10cSrcweir //.............................................................................
97cdf0e10cSrcweir #endif
98