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 #include <com/sun/star/frame/XModel.hpp>
  26 #include <com/sun/star/chart2/XChartDocument.hpp>
  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 ::com::sun::star::uno::Reference<
  40                             ::com::sun::star::frame::XModel >& xChartModel  );
  41     static OUString getGridName( const OUString& rObjectCID
  42                         , const ::com::sun::star::uno::Reference<
  43                             ::com::sun::star::frame::XModel >& xChartModel );
  44     static OUString getTitleName( const OUString& rObjectCID
  45                         , const ::com::sun::star::uno::Reference<
  46                             ::com::sun::star::frame::XModel >& xChartModel );
  47     static OUString getTitleNameByType( TitleHelper::eTitleType eType );
  48
  49     static OUString getNameForCID(
  50         const OUString& rObjectCID,
  51         const ::com::sun::star::uno::Reference<
  52             ::com::sun::star::chart2::XChartDocument >& xChartDocument );
  53
  54     static OUString getName_ObjectForSeries(
  55         ObjectType eObjectType,
  56         const OUString& rSeriesCID,
  57         const ::com::sun::star::uno::Reference<
  58             ::com::sun::star::chart2::XChartDocument >& xChartDocument );
  59     static OUString getName_ObjectForAllSeries( ObjectType eObjectType );
  60
  61     /** Provides help texts for the various chart elements.
  62         The parameter rObjectCID has to be a ClassifiedIdentifier - see class ObjectIdentifier.
  63      */
  64     static OUString getHelpText( const OUString& rObjectCID, const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& xChartModel, bool bVerbose=false );
  65     static OUString getHelpText( const OUString& rObjectCID, const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XChartDocument >& xChartDocument, bool bVerbose=false );
  66
  67     /** This is used for showing the currently selected object in the status bar
  68         (command "Context")
  69      */
  70     static OUString getSelectedObjectText( const OUString & rObjectCID, const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XChartDocument >& xChartDocument );
  71 };
  72
  73 } //namespace chart
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */