chart2/source/inc/TitleHelper.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef _CHART2_TOOLS_TITLEHELPER_HXX
  29 #define _CHART2_TOOLS_TITLEHELPER_HXX
  30
  31 #include "ReferenceSizeProvider.hxx"
  32 #include "charttoolsdllapi.hxx"
  33 #include <com/sun/star/chart2/XTitled.hpp>
  34 #include <com/sun/star/frame/XModel.hpp>
  35 #include <com/sun/star/uno/XComponentContext.hpp>
  36 #include <com/sun/star/chart2/XDiagram.hpp>
  37
  38 //.............................................................................
  39 namespace chart
  40 {
  41 //.............................................................................
  42
  43 class OOO_DLLPUBLIC_CHARTTOOLS TitleHelper
  44 {
  45 public:
  46     enum eTitleType
  47     {
  48         TITLE_BEGIN = 0,
  49         MAIN_TITLE = 0,
  50         SUB_TITLE,
  51         X_AXIS_TITLE,
  52         Y_AXIS_TITLE,
  53         Z_AXIS_TITLE,
  54         SECONDARY_X_AXIS_TITLE,
  55         SECONDARY_Y_AXIS_TITLE,
  56         NORMAL_TITLE_END,
  57
  58         //it is intended that this both types are after NORMAL_TITLE_END
  59         TITLE_AT_STANDARD_X_AXIS_POSITION, //equals the Y_AXIS_TITLE for barchart
  60         TITLE_AT_STANDARD_Y_AXIS_POSITION  //equals the X_AXIS_TITLE for barchart
  61     };
  62
  63     static ::com::sun::star::uno::Reference<
  64             ::com::sun::star::chart2::XTitle >
  65         getTitle( eTitleType nTitleIndex
  66                     , const ::com::sun::star::uno::Reference<
  67                     ::com::sun::star::frame::XModel >& xModel );
  68
  69     static ::com::sun::star::uno::Reference<
  70             ::com::sun::star::chart2::XTitle >
  71         createTitle(  eTitleType nTitleIndex
  72                     , const rtl::OUString& rTitleText
  73                     , const ::com::sun::star::uno::Reference<
  74                             ::com::sun::star::frame::XModel >& xModel
  75                     , const ::com::sun::star::uno::Reference<
  76                             ::com::sun::star::uno::XComponentContext > & xContext
  77                     , ReferenceSizeProvider * pRefSizeProvider = 0 );
  78
  79     static void removeTitle( eTitleType nTitleIndex
  80                     , const ::com::sun::star::uno::Reference<
  81                             ::com::sun::star::frame::XModel >& xModel );
  82
  83     static rtl::OUString getCompleteString( const ::com::sun::star::uno::Reference<
  84         ::com::sun::star::chart2::XTitle >& xTitle );
  85     static void setCompleteString( const rtl::OUString& rNewText
  86         , const ::com::sun::star::uno::Reference<
  87             ::com::sun::star::chart2::XTitle >& xTitle
  88         , const ::com::sun::star::uno::Reference<
  89             ::com::sun::star::uno::XComponentContext > & xContext
  90         , float * pDefaultCharHeight = 0 );
  91
  92     static bool getTitleType( eTitleType& rType
  93                     , const ::com::sun::star::uno::Reference<
  94                         ::com::sun::star::chart2::XTitle >& xTitle
  95                     , const ::com::sun::star::uno::Reference<
  96                         ::com::sun::star::frame::XModel >& xModel );
  97 };
  98
  99 //.............................................................................
 100 } //namespace chart
 101 //.............................................................................
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */