chart2/source/model/main/Legend.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 "Legend.hxx"
  21 #include "macros.hxx"
  22 #include "LinePropertiesHelper.hxx"
  23 #include "FillProperties.hxx"
  24 #include "CharacterProperties.hxx"
  25 #include "UserDefinedProperties.hxx"
  26 #include "LegendHelper.hxx"
  27 #include "ContainerHelper.hxx"
  28 #include "CloneHelper.hxx"
  29 #include "PropertyHelper.hxx"
  30 #include <com/sun/star/beans/PropertyAttribute.hpp>
  31 #include <com/sun/star/awt/Size.hpp>
  32 #include <com/sun/star/chart2/LegendPosition.hpp>
  33 #include <com/sun/star/chart/ChartLegendExpansion.hpp>
  34 #include <com/sun/star/chart2/RelativePosition.hpp>
  35 #include <com/sun/star/chart2/RelativeSize.hpp>
  36
  37 #include <algorithm>
  38
  39 using namespace ::com::sun::star;
  40 using namespace ::com::sun::star::beans::PropertyAttribute;
  41
  42 using ::com::sun::star::uno::Sequence;
  43 using ::com::sun::star::uno::Reference;
  44 using ::com::sun::star::uno::Any;
  45 using ::com::sun::star::beans::Property;
  46
  47 namespace
  48 {
  49
  50 static const OUString lcl_aServiceName( "com.sun.star.comp.chart2.Legend" );
  51
  52 enum
  53 {
  54     PROP_LEGEND_ANCHOR_POSITION,
  55     PROP_LEGEND_EXPANSION,
  56     PROP_LEGEND_SHOW,
  57     PROP_LEGEND_REF_PAGE_SIZE,
  58     PROP_LEGEND_REL_POS,
  59     PROP_LEGEND_REL_SIZE
  60 };
  61
  62 void lcl_AddPropertiesToVector(
  63     ::std::vector< Property > & rOutProperties )
  64 {
  65     rOutProperties.push_back(
  66         Property( "AnchorPosition",
  67                   PROP_LEGEND_ANCHOR_POSITION,
  68                   ::getCppuType( reinterpret_cast< const chart2::LegendPosition * >(0)),
  69                   beans::PropertyAttribute::BOUND
  70                   | beans::PropertyAttribute::MAYBEDEFAULT ));
  71
  72     rOutProperties.push_back(
  73         Property( "Expansion",
  74                   PROP_LEGEND_EXPANSION,
  75                   ::getCppuType( reinterpret_cast< const ::com::sun::star::chart::ChartLegendExpansion * >(0)),
  76                   beans::PropertyAttribute::BOUND
  77                   | beans::PropertyAttribute::MAYBEDEFAULT ));
  78
  79     rOutProperties.push_back(
  80         Property( "Show",
  81                   PROP_LEGEND_SHOW,
  82                   ::getBooleanCppuType(),
  83                   beans::PropertyAttribute::BOUND
  84                   | beans::PropertyAttribute::MAYBEDEFAULT ));
  85     rOutProperties.push_back(
  86         Property( "ReferencePageSize",
  87                   PROP_LEGEND_REF_PAGE_SIZE,
  88                   ::getCppuType( reinterpret_cast< const awt::Size * >(0)),
  89                   beans::PropertyAttribute::BOUND
  90                   | beans::PropertyAttribute::MAYBEVOID ));
  91
  92     rOutProperties.push_back(
  93         Property( "RelativePosition",
  94                   PROP_LEGEND_REL_POS,
  95                   ::getCppuType( reinterpret_cast< const chart2::RelativePosition * >(0)),
  96                   beans::PropertyAttribute::BOUND
  97                   | beans::PropertyAttribute::MAYBEVOID ));
  98
  99     rOutProperties.push_back(
 100         Property( "RelativeSize",
 101                   PROP_LEGEND_REL_SIZE,
 102                   ::getCppuType( reinterpret_cast< const chart2::RelativeSize * >(0)),
 103                   beans::PropertyAttribute::BOUND
 104                   | beans::PropertyAttribute::MAYBEVOID ));
 105
 106 }
 107
 108 struct StaticLegendDefaults_Initializer
 109 {
 110     ::chart::tPropertyValueMap* operator()()
 111     {
 112         static ::chart::tPropertyValueMap aStaticDefaults;
 113         lcl_AddDefaultsToMap( aStaticDefaults );
 114         return &aStaticDefaults;
 115     }
 116 private:
 117     void lcl_AddDefaultsToMap( ::chart::tPropertyValueMap & rOutMap )
 118     {
 119         ::chart::LinePropertiesHelper::AddDefaultsToMap( rOutMap );
 120         ::chart::FillProperties::AddDefaultsToMap( rOutMap );
 121         ::chart::CharacterProperties::AddDefaultsToMap( rOutMap );
 122
 123         ::chart::PropertyHelper::setPropertyValueDefault( rOutMap, PROP_LEGEND_ANCHOR_POSITION, chart2::LegendPosition_LINE_END );
 124         ::chart::PropertyHelper::setPropertyValueDefault( rOutMap, PROP_LEGEND_EXPANSION, ::com::sun::star::chart::ChartLegendExpansion_HIGH );
 125         ::chart::PropertyHelper::setPropertyValueDefault( rOutMap, PROP_LEGEND_SHOW, true );
 126
 127         float fDefaultCharHeight = 10.0;
 128         ::chart::PropertyHelper::setPropertyValue( rOutMap, ::chart::CharacterProperties::PROP_CHAR_CHAR_HEIGHT, fDefaultCharHeight );
 129         ::chart::PropertyHelper::setPropertyValue( rOutMap, ::chart::CharacterProperties::PROP_CHAR_ASIAN_CHAR_HEIGHT, fDefaultCharHeight );
 130         ::chart::PropertyHelper::setPropertyValue( rOutMap, ::chart::CharacterProperties::PROP_CHAR_COMPLEX_CHAR_HEIGHT, fDefaultCharHeight );
 131     }
 132 };
 133
 134 struct StaticLegendDefaults : public rtl::StaticAggregate< ::chart::tPropertyValueMap, StaticLegendDefaults_Initializer >
 135 {
 136 };
 137
 138 struct StaticLegendInfoHelper_Initializer
 139 {
 140     ::cppu::OPropertyArrayHelper* operator()()
 141     {
 142         static ::cppu::OPropertyArrayHelper aPropHelper( lcl_GetPropertySequence() );
 143         return &aPropHelper;
 144     }
 145
 146 private:
 147     Sequence< Property > lcl_GetPropertySequence()
 148     {
 149         ::std::vector< ::com::sun::star::beans::Property > aProperties;
 150         lcl_AddPropertiesToVector( aProperties );
 151         ::chart::LinePropertiesHelper::AddPropertiesToVector( aProperties );
 152         ::chart::FillProperties::AddPropertiesToVector( aProperties );
 153         ::chart::CharacterProperties::AddPropertiesToVector( aProperties );
 154         ::chart::UserDefinedProperties::AddPropertiesToVector( aProperties );
 155
 156         ::std::sort( aProperties.begin(), aProperties.end(),
 157                      ::chart::PropertyNameLess() );
 158
 159         return ::chart::ContainerHelper::ContainerToSequence( aProperties );
 160     }
 161 };
 162
 163 struct StaticLegendInfoHelper : public rtl::StaticAggregate< ::cppu::OPropertyArrayHelper, StaticLegendInfoHelper_Initializer >
 164 {
 165 };
 166
 167 struct StaticLegendInfo_Initializer
 168 {
 169     uno::Reference< beans::XPropertySetInfo >* operator()()
 170     {
 171         static uno::Reference< beans::XPropertySetInfo > xPropertySetInfo(
 172             ::cppu::OPropertySetHelper::createPropertySetInfo(*StaticLegendInfoHelper::get() ) );
 173         return &xPropertySetInfo;
 174     }
 175 };
 176
 177 struct StaticLegendInfo : public rtl::StaticAggregate< uno::Reference< beans::XPropertySetInfo >, StaticLegendInfo_Initializer >
 178 {
 179 };
 180
 181 } // anonymous namespace
 182
 183 namespace chart
 184 {
 185
 186 Legend::Legend( Reference< uno::XComponentContext > const & /* xContext */ ) :
 187         ::property::OPropertySet( m_aMutex ),
 188         m_xModifyEventForwarder( ModifyListenerHelper::createModifyEventForwarder())
 189 {
 190 }
 191
 192 Legend::Legend( const Legend & rOther ) :
 193         MutexContainer(),
 194         impl::Legend_Base(),
 195         ::property::OPropertySet( rOther, m_aMutex ),
 196     m_xModifyEventForwarder( ModifyListenerHelper::createModifyEventForwarder())
 197 {
 198 }
 199
 200 Legend::~Legend()
 201 {
 202 }
 203
 204 // ____ XCloneable ____
 205 Reference< util::XCloneable > SAL_CALL Legend::createClone()
 206     throw (uno::RuntimeException)
 207 {
 208     return Reference< util::XCloneable >( new Legend( *this ));
 209 }
 210
 211 // ____ XModifyBroadcaster ____
 212 void SAL_CALL Legend::addModifyListener( const Reference< util::XModifyListener >& aListener )
 213     throw (uno::RuntimeException)
 214 {
 215     try
 216     {
 217         Reference< util::XModifyBroadcaster > xBroadcaster( m_xModifyEventForwarder, uno::UNO_QUERY_THROW );
 218         xBroadcaster->addModifyListener( aListener );
 219     }
 220     catch( const uno::Exception & ex )
 221     {
 222         ASSERT_EXCEPTION( ex );
 223     }
 224 }
 225
 226 void SAL_CALL Legend::removeModifyListener( const Reference< util::XModifyListener >& aListener )
 227     throw (uno::RuntimeException)
 228 {
 229     try
 230     {
 231         Reference< util::XModifyBroadcaster > xBroadcaster( m_xModifyEventForwarder, uno::UNO_QUERY_THROW );
 232         xBroadcaster->removeModifyListener( aListener );
 233     }
 234     catch( const uno::Exception & ex )
 235     {
 236         ASSERT_EXCEPTION( ex );
 237     }
 238 }
 239
 240 // ____ XModifyListener ____
 241 void SAL_CALL Legend::modified( const lang::EventObject& aEvent )
 242     throw (uno::RuntimeException)
 243 {
 244     m_xModifyEventForwarder->modified( aEvent );
 245 }
 246
 247 // ____ XEventListener (base of XModifyListener) ____
 248 void SAL_CALL Legend::disposing( const lang::EventObject& /* Source */ )
 249     throw (uno::RuntimeException)
 250 {
 251     // nothing
 252 }
 253
 254 // ____ OPropertySet ____
 255 void Legend::firePropertyChangeEvent()
 256 {
 257     fireModifyEvent();
 258 }
 259
 260 void Legend::fireModifyEvent()
 261 {
 262     m_xModifyEventForwarder->modified( lang::EventObject( static_cast< uno::XWeak* >( this )));
 263 }
 264
 265 // ================================================================================
 266
 267 Sequence< OUString > Legend::getSupportedServiceNames_Static()
 268 {
 269     const sal_Int32 nNumServices( 6 );
 270     sal_Int32 nI = 0;
 271     Sequence< OUString > aServices( nNumServices );
 272     aServices[ nI++ ] = "com.sun.star.chart2.Legend";
 273     aServices[ nI++ ] = "com.sun.star.beans.PropertySet";
 274     aServices[ nI++ ] = "com.sun.star.drawing.FillProperties";
 275     aServices[ nI++ ] = "com.sun.star.drawing.LineProperties";
 276     aServices[ nI++ ] = "com.sun.star.style.CharacterProperties";
 277     aServices[ nI++ ] = "com.sun.star.layout.LayoutElement";
 278     OSL_ASSERT( nNumServices == nI );
 279     return aServices;
 280 }
 281
 282 // ____ OPropertySet ____
 283 Any Legend::GetDefaultValue( sal_Int32 nHandle ) const
 284     throw(beans::UnknownPropertyException)
 285 {
 286     const tPropertyValueMap& rStaticDefaults = *StaticLegendDefaults::get();
 287     tPropertyValueMap::const_iterator aFound( rStaticDefaults.find( nHandle ) );
 288     if( aFound == rStaticDefaults.end() )
 289         return uno::Any();
 290     return (*aFound).second;
 291 }
 292
 293 ::cppu::IPropertyArrayHelper & SAL_CALL Legend::getInfoHelper()
 294 {
 295     return *StaticLegendInfoHelper::get();
 296 }
 297
 298 // ____ XPropertySet ____
 299 Reference< beans::XPropertySetInfo > SAL_CALL Legend::getPropertySetInfo()
 300     throw (uno::RuntimeException)
 301 {
 302     return *StaticLegendInfo::get();
 303 }
 304
 305 // implement XServiceInfo methods basing upon getSupportedServiceNames_Static
 306 APPHELPER_XSERVICEINFO_IMPL( Legend, lcl_aServiceName );
 307
 308 // needed by MSC compiler
 309 using impl::Legend_Base;
 310
 311 IMPLEMENT_FORWARD_XINTERFACE2( Legend, Legend_Base, ::property::OPropertySet )
 312 IMPLEMENT_FORWARD_XTYPEPROVIDER2( Legend, Legend_Base, ::property::OPropertySet )
 313
 314 } //  namespace chart
 315
 316 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */