chart2/source/controller/inc/ObjectNameProvider.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_CHART2_SOURCE_CONTROLLER_INC_OBJECTNAMEPROVIDER_HXX
  21 #define INCLUDED_CHART2_SOURCE_CONTROLLER_INC_OBJECTNAMEPROVIDER_HXX
  22
  23 #include <ObjectIdentifier.hxx>
  24 #include <TitleHelper.hxx>
  25
  26 namespace com { namespace sun { namespace star { namespace chart2 { class XChartDocument; } } } }
  27 namespace com { namespace sun { namespace star { namespace frame { class XModel; } } } }
  28
  29 namespace chart
  30 {
  31
  32 /** Provides localized ui strings for the userinterface.
  33 */
  34
  35 class ObjectNameProvider
  36 {
  37 public:
  38     static OUString getName( ObjectType eObjectType, bool bPlural=false );
  39     static OUString getAxisName( const OUString& rObjectCID
  40                         , const css::uno::Reference< css::frame::XModel >& xChartModel  );
  41     static OUString getGridName( const OUString& rObjectCID
  42                         , const css::uno::Reference< css::frame::XModel >& xChartModel );
  43     static OUString getTitleName( const OUString& rObjectCID
  44                         , const css::uno::Reference< css::frame::XModel >& xChartModel );
  45     static OUString getTitleNameByType( TitleHelper::eTitleType eType );
  46
  47     static OUString getNameForCID(
  48         const OUString& rObjectCID,
  49         const css::uno::Reference< css::chart2::XChartDocument >& xChartDocument );
  50
  51     static OUString getName_ObjectForSeries(
  52         ObjectType eObjectType,
  53         const OUString& rSeriesCID,
  54         const css::uno::Reference< css::chart2::XChartDocument >& xChartDocument );
  55     static OUString getName_ObjectForAllSeries( ObjectType eObjectType );
  56
  57     /** Provides help texts for the various chart elements.
  58         The parameter rObjectCID has to be a ClassifiedIdentifier - see class ObjectIdentifier.
  59      */
  60     static OUString getHelpText( const OUString& rObjectCID, const css::uno::Reference< ::com::sun::star::frame::XModel >& xChartModel, bool bVerbose=false );
  61     static OUString getHelpText( const OUString& rObjectCID, const css::uno::Reference< ::com::sun::star::chart2::XChartDocument >& xChartDocument );
  62
  63     /** This is used for showing the currently selected object in the status bar
  64         (command "Context")
  65      */
  66     static OUString getSelectedObjectText( const OUString & rObjectCID, const css::uno::Reference< css::chart2::XChartDocument >& xChartDocument );
  67 };
  68
  69 } //namespace chart
  70 #endif
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */