chart2/source/controller/inc/ObjectNameProvider.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ObjectNameProvider.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _CHART2_OBJECTNAME_PROVIDER_HXX
  32 #define _CHART2_OBJECTNAME_PROVIDER_HXX
  33
  34 #include "ObjectIdentifier.hxx"
  35 #include <com/sun/star/frame/XModel.hpp>
  36 #include <com/sun/star/chart2/XChartDocument.hpp>
  37
  38 //.............................................................................
  39 namespace chart
  40 {
  41 //.............................................................................
  42
  43 //-----------------------------------------------------------------------------
  44 /** Provides localized ui strings for the userinterface.
  45 */
  46
  47 class ObjectNameProvider
  48 {
  49 public:
  50     static rtl::OUString getName( ObjectType eObjectType, bool bPlural=false );
  51     static rtl::OUString getAxisName( const rtl::OUString& rObjectCID
  52                         , const ::com::sun::star::uno::Reference<
  53                             ::com::sun::star::frame::XModel >& xChartModel  );
  54     static rtl::OUString getGridName( const rtl::OUString& rObjectCID
  55                         , const ::com::sun::star::uno::Reference<
  56                             ::com::sun::star::frame::XModel >& xChartModel );
  57     static rtl::OUString getTitleName( const rtl::OUString& rObjectCID
  58                         , const ::com::sun::star::uno::Reference<
  59                             ::com::sun::star::frame::XModel >& xChartModel );
  60
  61     static rtl::OUString getNameForCID(
  62         const rtl::OUString& rObjectCID,
  63         const ::com::sun::star::uno::Reference<
  64             ::com::sun::star::chart2::XChartDocument >& xChartDocument );
  65
  66     /** Provides help texts for the various chart elements.
  67         The parameter rObjectCID has to be a ClassifiedIdentifier - see class ObjectIdentifier.
  68      */
  69     static rtl::OUString getHelpText( const rtl::OUString& rObjectCID, const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& xChartModel, bool bVerbose=false );
  70     static rtl::OUString getHelpText( const rtl::OUString& rObjectCID, const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XChartDocument >& xChartDocument, bool bVerbose=false );
  71
  72     /** This is used for showing the currently selected object in the status bar
  73         (command "Context")
  74      */
  75     static rtl::OUString getSelectedObjectText( const rtl::OUString & rObjectCID, const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XChartDocument >& xChartDocument );
  76 };
  77
  78 //.............................................................................
  79 } //namespace chart
  80 //.............................................................................
  81 #endif