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 #pragma once
  21
  22 #include <ObjectIdentifier.hxx>
  23 #include <TitleHelper.hxx>
  24
  25 namespace com::sun::star::chart2 { class XChartDocument; }
  26 namespace com::sun::star::frame { class XModel; }
  27
  28 namespace chart
  29 {
  30
  31 /** Provides localized ui strings for the userinterface.
  32 */
  33
  34 class ObjectNameProvider
  35 {
  36 public:
  37     static OUString getName( ObjectType eObjectType, bool bPlural=false );
  38     static OUString getAxisName( const OUString& rObjectCID
  39                         , const css::uno::Reference< css::frame::XModel >& xChartModel  );
  40     static OUString getGridName( const OUString& rObjectCID
  41                         , const css::uno::Reference< css::frame::XModel >& xChartModel );
  42     static OUString getTitleName( const OUString& rObjectCID
  43                         , const css::uno::Reference< css::frame::XModel >& xChartModel );
  44     static OUString getTitleNameByType( TitleHelper::eTitleType eType );
  45
  46     static OUString getNameForCID(
  47         const OUString& rObjectCID,
  48         const css::uno::Reference< css::chart2::XChartDocument >& xChartDocument );
  49
  50     static OUString getName_ObjectForSeries(
  51         ObjectType eObjectType,
  52         const OUString& rSeriesCID,
  53         const css::uno::Reference< css::chart2::XChartDocument >& xChartDocument );
  54     static OUString getName_ObjectForAllSeries( ObjectType eObjectType );
  55
  56     /** Provides help texts for the various chart elements.
  57         The parameter rObjectCID has to be a ClassifiedIdentifier - see class ObjectIdentifier.
  58      */
  59     static OUString getHelpText( const OUString& rObjectCID, const css::uno::Reference< ::com::sun::star::frame::XModel >& xChartModel, bool bVerbose=false );
  60     static OUString getHelpText( const OUString& rObjectCID, const css::uno::Reference< ::com::sun::star::chart2::XChartDocument >& xChartDocument );
  61
  62     /** This is used for showing the currently selected object in the status bar
  63         (command "Context")
  64      */
  65     static OUString getSelectedObjectText( const OUString & rObjectCID, const css::uno::Reference< css::chart2::XChartDocument >& xChartDocument );
  66 };
  67
  68 } //namespace chart
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */