chart2/source/inc/TitleHelper.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 #pragma once
  20
  21 #include <com/sun/star/uno/Reference.h>
  22 #include <rtl/ustring.hxx>
  23 #include "charttoolsdllapi.hxx"
  24
  25 namespace chart { class ChartModel; }
  26 namespace chart { class ReferenceSizeProvider; }
  27 namespace com::sun::star::chart2 { class XTitle; }
  28 namespace com::sun::star::frame { class XModel; }
  29 namespace com::sun::star::uno { class XComponentContext; }
  30
  31 namespace chart
  32 {
  33
  34 class OOO_DLLPUBLIC_CHARTTOOLS TitleHelper
  35 {
  36 public:
  37     enum eTitleType
  38     {
  39         TITLE_BEGIN = 0,
  40         MAIN_TITLE = 0,
  41         SUB_TITLE,
  42         X_AXIS_TITLE,
  43         Y_AXIS_TITLE,
  44         Z_AXIS_TITLE,
  45         SECONDARY_X_AXIS_TITLE,
  46         SECONDARY_Y_AXIS_TITLE,
  47         NORMAL_TITLE_END,
  48
  49         //it is intended that this both types are after NORMAL_TITLE_END
  50         TITLE_AT_STANDARD_X_AXIS_POSITION, //equals the Y_AXIS_TITLE for barchart
  51         TITLE_AT_STANDARD_Y_AXIS_POSITION  //equals the X_AXIS_TITLE for barchart
  52     };
  53
  54     static css::uno::Reference< css::chart2::XTitle >
  55         getTitle( eTitleType nTitleIndex
  56                     , ChartModel& rModel );
  57
  58     static css::uno::Reference< css::chart2::XTitle >
  59         getTitle( eTitleType nTitleIndex
  60                     , const css::uno::Reference< css::frame::XModel >& xModel );
  61
  62     static css::uno::Reference<
  63             css::chart2::XTitle >
  64         createTitle(  eTitleType nTitleIndex
  65                     , const OUString& rTitleText
  66                     , const css::uno::Reference< css::frame::XModel >& xModel
  67                     , const css::uno::Reference< css::uno::XComponentContext > & xContext
  68                     , ReferenceSizeProvider * pRefSizeProvider = nullptr );
  69     static css::uno::Reference<
  70             css::chart2::XTitle >
  71           createOrShowTitle(  eTitleType nTitleIndex
  72                     , const OUString& rTitleText
  73                     , const css::uno::Reference< css::frame::XModel >& xModel
  74                     , const css::uno::Reference< css::uno::XComponentContext > & xContex );
  75
  76     static void removeTitle( eTitleType nTitleIndex
  77                     , const css::uno::Reference< css::frame::XModel >& xModel );
  78
  79     static void hideTitle( eTitleType nTitleIndex
  80                     , const css::uno::Reference< css::frame::XModel >& xModel );
  81
  82
  83     static OUString getCompleteString( const css::uno::Reference< css::chart2::XTitle >& xTitle );
  84     static void setCompleteString( const OUString& rNewText
  85         , const css::uno::Reference< css::chart2::XTitle >& xTitle
  86         , const css::uno::Reference< css::uno::XComponentContext > & xContext
  87         , const float * pDefaultCharHeight = nullptr );
  88
  89     static bool getTitleType( eTitleType& rType
  90                     , const css::uno::Reference< css::chart2::XTitle >& xTitle
  91                     , ChartModel& rModel);
  92
  93     static bool getTitleType( eTitleType& rType
  94                     , const css::uno::Reference< css::chart2::XTitle >& xTitle
  95                     , const css::uno::Reference< css::frame::XModel >& xModel );
  96 };
  97
  98 } //namespace chart
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */