chart2/source/controller/chartapiwrapper/WrappedAxisAndGridExistenceProperties.cxx

   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 #include "WrappedAxisAndGridExistenceProperties.hxx"
  21 #include <com/sun/star/beans/XPropertySet.hpp>
  22 #include <AxisHelper.hxx>
  23 #include <WrappedProperty.hxx>
  24 #include "Chart2ModelContact.hxx"
  25 #include <TitleHelper.hxx>
  26 #include <osl/diagnose.h>
  27
  28 using namespace ::com::sun::star;
  29 using ::com::sun::star::uno::Any;
  30 using ::com::sun::star::uno::Reference;
  31
  32 namespace chart
  33 {
  34 namespace wrapper
  35 {
  36
  37 class WrappedAxisAndGridExistenceProperty : public WrappedProperty
  38 {
  39 public:
  40     WrappedAxisAndGridExistenceProperty( bool bAxis, bool bMain, sal_Int32 nDimensionIndex
  41         , const std::shared_ptr<Chart2ModelContact>& spChart2ModelContact );
  42
  43     virtual void setPropertyValue( const css::uno::Any& rOuterValue, const css::uno::Reference< css::beans::XPropertySet >& xInnerPropertySet ) const override;
  44
  45     virtual css::uno::Any getPropertyValue( const css::uno::Reference< css::beans::XPropertySet >& xInnerPropertySet ) const override;
  46
  47     virtual css::uno::Any getPropertyDefault( const css::uno::Reference< css::beans::XPropertyState >& xInnerPropertyState ) const override;
  48
  49 private: //member
  50     std::shared_ptr< Chart2ModelContact >   m_spChart2ModelContact;
  51     bool        m_bAxis;
  52     bool        m_bMain;
  53     sal_Int32   m_nDimensionIndex;
  54 };
  55
  56 void WrappedAxisAndGridExistenceProperties::addWrappedProperties( std::vector< std::unique_ptr<WrappedProperty> >& rList
  57             , const std::shared_ptr< Chart2ModelContact >& spChart2ModelContact )
  58 {
  59     rList.emplace_back( new WrappedAxisAndGridExistenceProperty( true, true, 0, spChart2ModelContact ) );//x axis
  60     rList.emplace_back( new WrappedAxisAndGridExistenceProperty( true, false, 0, spChart2ModelContact ) );//x secondary axis
  61     rList.emplace_back( new WrappedAxisAndGridExistenceProperty( false, true, 0, spChart2ModelContact ) );//x grid
  62     rList.emplace_back( new WrappedAxisAndGridExistenceProperty( false, false, 0, spChart2ModelContact ) );//x help grid
  63
  64     rList.emplace_back( new WrappedAxisAndGridExistenceProperty( true, true, 1, spChart2ModelContact ) );//y axis
  65     rList.emplace_back( new WrappedAxisAndGridExistenceProperty( true, false, 1, spChart2ModelContact ) );//y secondary axis
  66     rList.emplace_back( new WrappedAxisAndGridExistenceProperty( false, true, 1, spChart2ModelContact ) );//y grid
  67     rList.emplace_back( new WrappedAxisAndGridExistenceProperty( false, false, 1, spChart2ModelContact ) );//y help grid
  68
  69     rList.emplace_back( new WrappedAxisAndGridExistenceProperty( true, true, 2, spChart2ModelContact ) );//z axis
  70     rList.emplace_back( new WrappedAxisAndGridExistenceProperty( false, true, 2, spChart2ModelContact ) );//z grid
  71     rList.emplace_back( new WrappedAxisAndGridExistenceProperty( false, false, 2, spChart2ModelContact ) );//z help grid
  72 }
  73
  74 WrappedAxisAndGridExistenceProperty::WrappedAxisAndGridExistenceProperty( bool bAxis, bool bMain, sal_Int32 nDimensionIndex
  75                 , const std::shared_ptr<Chart2ModelContact>& spChart2ModelContact )
  76             : WrappedProperty(OUString(),OUString())
  77             , m_spChart2ModelContact( spChart2ModelContact )
  78             , m_bAxis( bAxis )
  79             , m_bMain( bMain )
  80             , m_nDimensionIndex( nDimensionIndex )
  81 {
  82     switch( m_nDimensionIndex )
  83     {
  84         case 0:
  85         {
  86             if( m_bAxis )
  87             {
  88                 if( m_bMain )
  89                     m_aOuterName = "HasXAxis";
  90                 else
  91                     m_aOuterName = "HasSecondaryXAxis";
  92             }
  93             else
  94             {
  95                 if( m_bMain )
  96                     m_aOuterName = "HasXAxisGrid";
  97                 else
  98                     m_aOuterName = "HasXAxisHelpGrid";
  99             }
 100         }
 101         break;
 102         case 2:
 103         {
 104             if( m_bAxis )
 105             {
 106                 OSL_ENSURE(m_bMain,"there is no secondary z axis at the old api");
 107                 m_bMain = true;
 108                 m_aOuterName = "HasZAxis";
 109             }
 110             else
 111             {
 112                 if( m_bMain )
 113                     m_aOuterName = "HasZAxisGrid";
 114                 else
 115                     m_aOuterName = "HasZAxisHelpGrid";
 116             }
 117         }
 118         break;
 119         default:
 120         {
 121             if( m_bAxis )
 122             {
 123                 if( m_bMain )
 124                     m_aOuterName = "HasYAxis";
 125                 else
 126                     m_aOuterName = "HasSecondaryYAxis";
 127             }
 128             else
 129             {
 130                 if( m_bMain )
 131                     m_aOuterName = "HasYAxisGrid";
 132                 else
 133                     m_aOuterName = "HasYAxisHelpGrid";
 134             }
 135         }
 136         break;
 137     }
 138 }
 139
 140 void WrappedAxisAndGridExistenceProperty::setPropertyValue( const Any& rOuterValue, const Reference< beans::XPropertySet >& xInnerPropertySet ) const
 141 {
 142     bool bNewValue = false;
 143     if( ! (rOuterValue >>= bNewValue) )
 144         throw lang::IllegalArgumentException( "Has axis or grid properties require boolean values", nullptr, 0 );
 145
 146     bool bOldValue = false;
 147     getPropertyValue( xInnerPropertySet ) >>= bOldValue;
 148
 149     if( bOldValue == bNewValue )
 150         return;
 151
 152     Reference< chart2::XDiagram > xDiagram( m_spChart2ModelContact->getChart2Diagram() );
 153     if( bNewValue )
 154     {
 155         if( m_bAxis )
 156             AxisHelper::showAxis( m_nDimensionIndex, m_bMain, xDiagram, m_spChart2ModelContact->m_xContext );
 157         else
 158             AxisHelper::showGrid( m_nDimensionIndex, 0, m_bMain, xDiagram );
 159     }
 160     else
 161     {
 162         if( m_bAxis )
 163             AxisHelper::hideAxis( m_nDimensionIndex, m_bMain, xDiagram );
 164         else
 165             AxisHelper::hideGrid( m_nDimensionIndex, 0, m_bMain, xDiagram );
 166     }
 167 }
 168
 169 Any WrappedAxisAndGridExistenceProperty::getPropertyValue( const Reference< beans::XPropertySet >& /* xInnerPropertySet */ ) const
 170 {
 171     Any aRet;
 172     Reference< chart2::XDiagram > xDiagram( m_spChart2ModelContact->getChart2Diagram() );
 173     if(m_bAxis)
 174     {
 175         bool bShown = AxisHelper::isAxisShown( m_nDimensionIndex, m_bMain, xDiagram );
 176         aRet <<= bShown;
 177     }
 178     else
 179     {
 180         bool bShown = AxisHelper::isGridShown( m_nDimensionIndex, 0, m_bMain, xDiagram );
 181         aRet <<= bShown;
 182     }
 183     return aRet;
 184 }
 185
 186 Any WrappedAxisAndGridExistenceProperty::getPropertyDefault( const Reference< beans::XPropertyState >& /*xInnerPropertyState*/ ) const
 187 {
 188     Any aRet;
 189     aRet <<= false;
 190     return aRet;
 191 }
 192
 193 class WrappedAxisTitleExistenceProperty : public WrappedProperty
 194 {
 195 public:
 196     WrappedAxisTitleExistenceProperty( sal_Int32 nTitleIndex
 197         , const std::shared_ptr<Chart2ModelContact>& spChart2ModelContact );
 198
 199     virtual void setPropertyValue( const css::uno::Any& rOuterValue, const css::uno::Reference< css::beans::XPropertySet >& xInnerPropertySet ) const override;
 200
 201     virtual css::uno::Any getPropertyValue( const css::uno::Reference< css::beans::XPropertySet >& xInnerPropertySet ) const override;
 202
 203     virtual css::uno::Any getPropertyDefault( const css::uno::Reference< css::beans::XPropertyState >& xInnerPropertyState ) const override;
 204
 205 private: //member
 206     std::shared_ptr< Chart2ModelContact >   m_spChart2ModelContact;
 207     TitleHelper::eTitleType             m_eTitleType;
 208 };
 209
 210 void WrappedAxisTitleExistenceProperties::addWrappedProperties( std::vector< std::unique_ptr<WrappedProperty> >& rList
 211             , const std::shared_ptr< Chart2ModelContact >& spChart2ModelContact )
 212 {
 213     rList.emplace_back( new WrappedAxisTitleExistenceProperty( 0, spChart2ModelContact ) );//x axis title
 214     rList.emplace_back( new WrappedAxisTitleExistenceProperty( 1, spChart2ModelContact ) );//y axis title
 215     rList.emplace_back( new WrappedAxisTitleExistenceProperty( 2, spChart2ModelContact ) );//z axis title
 216     rList.emplace_back( new WrappedAxisTitleExistenceProperty( 3, spChart2ModelContact ) );//secondary x axis title
 217     rList.emplace_back( new WrappedAxisTitleExistenceProperty( 4, spChart2ModelContact ) );//secondary y axis title
 218 }
 219
 220 WrappedAxisTitleExistenceProperty::WrappedAxisTitleExistenceProperty(sal_Int32 nTitleIndex
 221                 , const std::shared_ptr<Chart2ModelContact>& spChart2ModelContact)
 222             : WrappedProperty(OUString(),OUString())
 223             , m_spChart2ModelContact( spChart2ModelContact )
 224             , m_eTitleType( TitleHelper::Y_AXIS_TITLE )
 225 {
 226     switch( nTitleIndex )
 227     {
 228         case 0:
 229             m_aOuterName = "HasXAxisTitle";
 230             m_eTitleType = TitleHelper::X_AXIS_TITLE;
 231             break;
 232         case 2:
 233             m_aOuterName = "HasZAxisTitle";
 234             m_eTitleType = TitleHelper::Z_AXIS_TITLE;
 235             break;
 236         case 3:
 237             m_aOuterName = "HasSecondaryXAxisTitle";
 238             m_eTitleType = TitleHelper::SECONDARY_X_AXIS_TITLE;
 239             break;
 240         case 4:
 241             m_aOuterName = "HasSecondaryYAxisTitle";
 242             m_eTitleType = TitleHelper::SECONDARY_Y_AXIS_TITLE;
 243             break;
 244         default:
 245             m_aOuterName = "HasYAxisTitle";
 246             m_eTitleType = TitleHelper::Y_AXIS_TITLE;
 247             break;
 248     }
 249 }
 250
 251 void WrappedAxisTitleExistenceProperty::setPropertyValue( const Any& rOuterValue, const Reference< beans::XPropertySet >& xInnerPropertySet ) const
 252 {
 253     bool bNewValue = false;
 254     if( ! (rOuterValue >>= bNewValue) )
 255         throw lang::IllegalArgumentException( "Has axis or grid properties require boolean values", nullptr, 0 );
 256
 257     bool bOldValue = false;
 258     getPropertyValue( xInnerPropertySet ) >>= bOldValue;
 259
 260     if( bOldValue == bNewValue )
 261         return;
 262
 263     if( bNewValue )
 264     {
 265         TitleHelper::createTitle(  m_eTitleType, OUString()
 266             , m_spChart2ModelContact->getChartModel(), m_spChart2ModelContact->m_xContext );
 267     }
 268     else
 269     {
 270         TitleHelper::removeTitle( m_eTitleType, m_spChart2ModelContact->getChartModel() );
 271     }
 272 }
 273
 274 Any WrappedAxisTitleExistenceProperty::getPropertyValue( const Reference< beans::XPropertySet >& /*xInnerPropertySet*/ ) const
 275 {
 276     bool bHasTitle = false;
 277
 278     Reference< chart2::XTitle > xTitle( TitleHelper::getTitle( m_eTitleType, m_spChart2ModelContact->getChartModel() ) );
 279     if( xTitle.is() && !TitleHelper::getCompleteString( xTitle ).isEmpty() )
 280         bHasTitle = true;
 281
 282     Any aRet;
 283     aRet <<= bHasTitle;
 284     return aRet;
 285
 286 }
 287
 288 Any WrappedAxisTitleExistenceProperty::getPropertyDefault( const Reference< beans::XPropertyState >& /*xInnerPropertyState*/ ) const
 289 {
 290     Any aRet;
 291     aRet <<= false;
 292     return aRet;
 293 }
 294
 295 class WrappedAxisLabelExistenceProperty : public WrappedProperty
 296 {
 297 public:
 298     WrappedAxisLabelExistenceProperty( bool bMain, sal_Int32 nDimensionIndex
 299         , const std::shared_ptr<Chart2ModelContact>& spChart2ModelContact );
 300
 301     virtual void setPropertyValue( const css::uno::Any& rOuterValue, const css::uno::Reference< css::beans::XPropertySet >& xInnerPropertySet ) const override;
 302
 303     virtual css::uno::Any getPropertyValue( const css::uno::Reference< css::beans::XPropertySet >& xInnerPropertySet ) const override;
 304
 305     virtual css::uno::Any getPropertyDefault( const css::uno::Reference< css::beans::XPropertyState >& xInnerPropertyState ) const override;
 306
 307 private: //member
 308     std::shared_ptr< Chart2ModelContact >   m_spChart2ModelContact;
 309     bool        m_bMain;
 310     sal_Int32   m_nDimensionIndex;
 311 };
 312
 313 void WrappedAxisLabelExistenceProperties::addWrappedProperties( std::vector< std::unique_ptr<WrappedProperty> >& rList
 314             , const std::shared_ptr< Chart2ModelContact >& spChart2ModelContact )
 315 {
 316     rList.emplace_back( new WrappedAxisLabelExistenceProperty( true, 0, spChart2ModelContact ) );//x axis
 317     rList.emplace_back( new WrappedAxisLabelExistenceProperty( true, 1, spChart2ModelContact ) );//y axis
 318     rList.emplace_back( new WrappedAxisLabelExistenceProperty( true, 2, spChart2ModelContact ) );//z axis
 319     rList.emplace_back( new WrappedAxisLabelExistenceProperty( false, 0, spChart2ModelContact ) );//secondary x axis
 320     rList.emplace_back( new WrappedAxisLabelExistenceProperty( false, 1, spChart2ModelContact ) );//secondary y axis
 321 }
 322
 323 WrappedAxisLabelExistenceProperty::WrappedAxisLabelExistenceProperty(bool bMain, sal_Int32 nDimensionIndex
 324                 , const std::shared_ptr<Chart2ModelContact>& spChart2ModelContact)
 325             : WrappedProperty(OUString(),OUString())
 326             , m_spChart2ModelContact( spChart2ModelContact )
 327             , m_bMain( bMain )
 328             , m_nDimensionIndex( nDimensionIndex )
 329 {
 330     switch( m_nDimensionIndex )
 331     {
 332         case 0:
 333             m_bMain ? m_aOuterName = "HasXAxisDescription" : m_aOuterName = "HasSecondaryXAxisDescription";
 334             break;
 335         case 2:
 336             OSL_ENSURE(m_bMain,"there is no description available for a secondary z axis");
 337             m_aOuterName = "HasZAxisDescription";
 338             break;
 339         default:
 340             m_bMain ? m_aOuterName = "HasYAxisDescription" : m_aOuterName = "HasSecondaryYAxisDescription";
 341             break;
 342     }
 343 }
 344
 345 void WrappedAxisLabelExistenceProperty::setPropertyValue( const Any& rOuterValue, const Reference< beans::XPropertySet >& xInnerPropertySet ) const
 346 {
 347     bool bNewValue = false;
 348     if( ! (rOuterValue >>= bNewValue) )
 349         throw lang::IllegalArgumentException( "Has axis or grid properties require boolean values", nullptr, 0 );
 350
 351     bool bOldValue = false;
 352     getPropertyValue( xInnerPropertySet ) >>= bOldValue;
 353
 354     if( bOldValue == bNewValue )
 355         return;
 356
 357     Reference< chart2::XDiagram > xDiagram( m_spChart2ModelContact->getChart2Diagram() );
 358     Reference< beans::XPropertySet > xProp( AxisHelper::getAxis( m_nDimensionIndex, m_bMain, xDiagram ), uno::UNO_QUERY );
 359     if( !xProp.is() && bNewValue )
 360     {
 361         //create axis if needed
 362         xProp.set( AxisHelper::createAxis( m_nDimensionIndex, m_bMain, xDiagram, m_spChart2ModelContact->m_xContext ), uno::UNO_QUERY );
 363         if( xProp.is() )
 364             xProp->setPropertyValue( "Show", uno::Any( false ) );
 365     }
 366     if( xProp.is() )
 367         xProp->setPropertyValue( "DisplayLabels", rOuterValue );
 368 }
 369
 370 Any WrappedAxisLabelExistenceProperty::getPropertyValue( const Reference< beans::XPropertySet >& /*xInnerPropertySet*/ ) const
 371 {
 372     Any aRet;
 373     Reference< chart2::XDiagram > xDiagram( m_spChart2ModelContact->getChart2Diagram() );
 374     Reference< beans::XPropertySet > xProp( AxisHelper::getAxis( m_nDimensionIndex, m_bMain, xDiagram ), uno::UNO_QUERY );
 375     if( xProp.is() )
 376         aRet = xProp->getPropertyValue( "DisplayLabels" );
 377     else
 378         aRet <<= false;
 379     return aRet;
 380 }
 381
 382 Any WrappedAxisLabelExistenceProperty::getPropertyDefault( const Reference< beans::XPropertyState >& /*xInnerPropertyState*/ ) const
 383 {
 384     Any aRet;
 385     aRet <<= true;
 386     return aRet;
 387 }
 388
 389 } //namespace wrapper
 390 } //namespace chart
 391
 392 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */