xref: /AOO41X/main/chart2/source/controller/inc/ObjectNameProvider.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 
28*cdf0e10cSrcweir #ifndef _CHART2_OBJECTNAME_PROVIDER_HXX
29*cdf0e10cSrcweir #define _CHART2_OBJECTNAME_PROVIDER_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include "ObjectIdentifier.hxx"
32*cdf0e10cSrcweir #include "TitleHelper.hxx"
33*cdf0e10cSrcweir #include <com/sun/star/frame/XModel.hpp>
34*cdf0e10cSrcweir #include <com/sun/star/chart2/XChartDocument.hpp>
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir //.............................................................................
37*cdf0e10cSrcweir namespace chart
38*cdf0e10cSrcweir {
39*cdf0e10cSrcweir //.............................................................................
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir //-----------------------------------------------------------------------------
42*cdf0e10cSrcweir /** Provides localized ui strings for the userinterface.
43*cdf0e10cSrcweir */
44*cdf0e10cSrcweir 
45*cdf0e10cSrcweir class ObjectNameProvider
46*cdf0e10cSrcweir {
47*cdf0e10cSrcweir public:
48*cdf0e10cSrcweir     static rtl::OUString getName( ObjectType eObjectType, bool bPlural=false );
49*cdf0e10cSrcweir     static rtl::OUString getAxisName( const rtl::OUString& rObjectCID
50*cdf0e10cSrcweir                         , const ::com::sun::star::uno::Reference<
51*cdf0e10cSrcweir                             ::com::sun::star::frame::XModel >& xChartModel  );
52*cdf0e10cSrcweir     static rtl::OUString getGridName( const rtl::OUString& rObjectCID
53*cdf0e10cSrcweir                         , const ::com::sun::star::uno::Reference<
54*cdf0e10cSrcweir                             ::com::sun::star::frame::XModel >& xChartModel );
55*cdf0e10cSrcweir     static rtl::OUString getTitleName( const rtl::OUString& rObjectCID
56*cdf0e10cSrcweir                         , const ::com::sun::star::uno::Reference<
57*cdf0e10cSrcweir                             ::com::sun::star::frame::XModel >& xChartModel );
58*cdf0e10cSrcweir     static rtl::OUString getTitleNameByType( TitleHelper::eTitleType eType );
59*cdf0e10cSrcweir 
60*cdf0e10cSrcweir     static rtl::OUString getNameForCID(
61*cdf0e10cSrcweir         const rtl::OUString& rObjectCID,
62*cdf0e10cSrcweir         const ::com::sun::star::uno::Reference<
63*cdf0e10cSrcweir             ::com::sun::star::chart2::XChartDocument >& xChartDocument );
64*cdf0e10cSrcweir 
65*cdf0e10cSrcweir     static rtl::OUString getName_ObjectForSeries(
66*cdf0e10cSrcweir         ObjectType eObjectType,
67*cdf0e10cSrcweir         const rtl::OUString& rSeriesCID,
68*cdf0e10cSrcweir         const ::com::sun::star::uno::Reference<
69*cdf0e10cSrcweir             ::com::sun::star::chart2::XChartDocument >& xChartDocument );
70*cdf0e10cSrcweir     static rtl::OUString getName_ObjectForAllSeries( ObjectType eObjectType );
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir     /** Provides help texts for the various chart elements.
73*cdf0e10cSrcweir         The parameter rObjectCID has to be a ClassifiedIdentifier - see class ObjectIdentifier.
74*cdf0e10cSrcweir      */
75*cdf0e10cSrcweir     static rtl::OUString getHelpText( const rtl::OUString& rObjectCID, const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& xChartModel, bool bVerbose=false );
76*cdf0e10cSrcweir     static rtl::OUString getHelpText( const rtl::OUString& rObjectCID, const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XChartDocument >& xChartDocument, bool bVerbose=false );
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir     /** This is used for showing the currently selected object in the status bar
79*cdf0e10cSrcweir         (command "Context")
80*cdf0e10cSrcweir      */
81*cdf0e10cSrcweir     static rtl::OUString getSelectedObjectText( const rtl::OUString & rObjectCID, const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XChartDocument >& xChartDocument );
82*cdf0e10cSrcweir };
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir //.............................................................................
85*cdf0e10cSrcweir } //namespace chart
86*cdf0e10cSrcweir //.............................................................................
87*cdf0e10cSrcweir #endif
88