editeng/source/uno/unonrule.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 <sal/config.h>
  21
  22 #include <com/sun/star/awt/FontDescriptor.hpp>
  23 #include <com/sun/star/beans/PropertyValue.hpp>
  24 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  25 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  26 #include <com/sun/star/text/HoriOrientation.hpp>
  27 #include <com/sun/star/awt/XBitmap.hpp>
  28 #include <com/sun/star/graphic/XGraphic.hpp>
  29 #include <cppuhelper/supportsservice.hxx>
  30 #include <cppuhelper/implbase1.hxx>
  31 #include <vcl/font.hxx>
  32 #include <vcl/svapp.hxx>
  33 #include <vcl/graph.hxx>
  34 #include <vcl/GraphicObject.hxx>
  35 #include <vcl/GraphicLoader.hxx>
  36 #include <tools/debug.hxx>
  37
  38 #include <editeng/brushitem.hxx>
  39 #include <editeng/unoprnms.hxx>
  40 #include <editeng/numitem.hxx>
  41 #include <editeng/unofdesc.hxx>
  42 #include <editeng/unonrule.hxx>
  43 #include <editeng/editids.hrc>
  44 #include <editeng/numdef.hxx>
  45 #include <o3tl/enumarray.hxx>
  46 #include <memory>
  47
  48 using ::com::sun::star::util::XCloneable;
  49 using ::com::sun::star::ucb::XAnyCompare;
  50
  51
  52 using namespace ::std;
  53 using namespace ::com::sun::star;
  54 using namespace ::com::sun::star::uno;
  55 using namespace ::com::sun::star::lang;
  56 using namespace ::com::sun::star::container;
  57
  58 const SvxAdjust aUnoToSvxAdjust[] =
  59 {
  60     SvxAdjust::Left,
  61     SvxAdjust::Right,
  62     SvxAdjust::Center,
  63     SvxAdjust::Left,
  64     SvxAdjust::Left,
  65     SvxAdjust::Left,
  66     SvxAdjust::Block
  67 };
  68
  69 const o3tl::enumarray<SvxAdjust, unsigned short> aSvxToUnoAdjust
  70 {
  71     text::HoriOrientation::LEFT,
  72     text::HoriOrientation::RIGHT,
  73     text::HoriOrientation::FULL,
  74     text::HoriOrientation::CENTER,
  75     text::HoriOrientation::FULL,
  76     text::HoriOrientation::LEFT
  77 };
  78
  79 static SvxAdjust ConvertUnoAdjust( unsigned short nAdjust )
  80 {
  81     DBG_ASSERT( nAdjust <= 7, "Enum has changed! [CL]" );
  82     return aUnoToSvxAdjust[nAdjust];
  83 }
  84
  85 static unsigned short ConvertUnoAdjust( SvxAdjust eAdjust )
  86 {
  87     DBG_ASSERT( static_cast<int>(eAdjust) <= 6, "Enum has changed! [CL]" );
  88     return aSvxToUnoAdjust[eAdjust];
  89 }
  90
  91 UNO3_GETIMPLEMENTATION_IMPL( SvxUnoNumberingRules );
  92
  93 SvxUnoNumberingRules::SvxUnoNumberingRules(const SvxNumRule& rRule)
  94 : maRule( rRule )
  95 {
  96 }
  97
  98 SvxUnoNumberingRules::~SvxUnoNumberingRules() throw()
  99 {
 100 }
 101
 102 //XIndexReplace
 103 void SAL_CALL SvxUnoNumberingRules::replaceByIndex( sal_Int32 Index, const uno::Any& Element )
 104 {
 105     SolarMutexGuard aGuard;
 106
 107     if( Index < 0 || Index >= maRule.GetLevelCount() )
 108         throw IndexOutOfBoundsException();
 109
 110     Sequence< beans::PropertyValue > aSeq;
 111
 112     if( !( Element >>= aSeq) )
 113         throw IllegalArgumentException();
 114     setNumberingRuleByIndex( aSeq, Index );
 115 }
 116
 117 // XIndexAccess
 118 sal_Int32 SAL_CALL SvxUnoNumberingRules::getCount()
 119 {
 120     SolarMutexGuard aGuard;
 121
 122     return maRule.GetLevelCount();
 123 }
 124
 125 Any SAL_CALL SvxUnoNumberingRules::getByIndex( sal_Int32 Index )
 126 {
 127     SolarMutexGuard aGuard;
 128
 129     if( Index < 0 || Index >= maRule.GetLevelCount() )
 130         throw IndexOutOfBoundsException();
 131
 132     return Any( getNumberingRuleByIndex(Index) );
 133 }
 134
 135 //XElementAccess
 136 Type SAL_CALL SvxUnoNumberingRules::getElementType()
 137 {
 138     return cppu::UnoType<Sequence< beans::PropertyValue >>::get();
 139 }
 140
 141 sal_Bool SAL_CALL SvxUnoNumberingRules::hasElements()
 142 {
 143     return true;
 144 }
 145
 146 // XAnyCompare
 147 sal_Int16 SAL_CALL SvxUnoNumberingRules::compare( const Any& rAny1, const Any& rAny2 )
 148 {
 149     return SvxUnoNumberingRules::Compare( rAny1, rAny2 );
 150 }
 151
 152 // XCloneable
 153 Reference< XCloneable > SAL_CALL SvxUnoNumberingRules::createClone(  )
 154 {
 155     return new SvxUnoNumberingRules(maRule);
 156 }
 157
 158 OUString SAL_CALL SvxUnoNumberingRules::getImplementationName(  )
 159 {
 160     return "SvxUnoNumberingRules";
 161 }
 162
 163 sal_Bool SAL_CALL SvxUnoNumberingRules::supportsService( const OUString& ServiceName )
 164 {
 165     return cppu::supportsService(this, ServiceName);
 166 }
 167
 168 Sequence< OUString > SAL_CALL SvxUnoNumberingRules::getSupportedServiceNames(  )
 169 {
 170     return { "com.sun.star.text.NumberingRules" };
 171 }
 172
 173 Sequence<beans::PropertyValue> SvxUnoNumberingRules::getNumberingRuleByIndex(sal_Int32 nIndex) const
 174 {
 175     //  NumberingRule aRule;
 176     const SvxNumberFormat& rFmt = maRule.GetLevel(static_cast<sal_uInt16>(nIndex));
 177     sal_uInt16 nIdx = 0;
 178
 179     const int nProps = 15;
 180     std::unique_ptr<beans::PropertyValue[]> pArray(new beans::PropertyValue[nProps]);
 181
 182     Any aVal;
 183     {
 184         aVal <<= static_cast<sal_uInt16>(rFmt.GetNumberingType());
 185         beans::PropertyValue aAlignProp( UNO_NAME_NRULE_NUMBERINGTYPE, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 186         pArray[nIdx++] = aAlignProp;
 187     }
 188
 189     {
 190         SvxAdjust eAdj = rFmt.GetNumAdjust();
 191         aVal <<= ConvertUnoAdjust(eAdj);
 192         pArray[nIdx++] = beans::PropertyValue( UNO_NAME_NRULE_ADJUST, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 193     }
 194
 195     {
 196         aVal <<= rFmt.GetPrefix();
 197         beans::PropertyValue aPrefixProp( UNO_NAME_NRULE_PREFIX, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 198         pArray[nIdx++] = aPrefixProp;
 199     }
 200
 201     {
 202         aVal <<= rFmt.GetSuffix();
 203         beans::PropertyValue aSuffixProp( UNO_NAME_NRULE_SUFFIX, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 204         pArray[nIdx++] = aSuffixProp;
 205     }
 206
 207     if(SVX_NUM_CHAR_SPECIAL == rFmt.GetNumberingType())
 208     {
 209         sal_UCS4 nCode = rFmt.GetBulletChar();
 210         OUString aStr( &nCode, 1 );
 211         aVal <<= aStr;
 212         beans::PropertyValue aBulletProp( "BulletChar", -1, aVal, beans::PropertyState_DIRECT_VALUE);
 213         pArray[nIdx++] = aBulletProp;
 214     }
 215
 216     if( rFmt.GetBulletFont() )
 217     {
 218         awt::FontDescriptor aDesc;
 219         SvxUnoFontDescriptor::ConvertFromFont( *rFmt.GetBulletFont(), aDesc );
 220         aVal <<= aDesc;
 221         pArray[nIdx++] = beans::PropertyValue( UNO_NAME_NRULE_BULLET_FONT, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 222     }
 223
 224     {
 225         const SvxBrushItem* pBrush = rFmt.GetBrush();
 226         const Graphic* pGraphic = nullptr;
 227         if (pBrush)
 228             pGraphic = pBrush->GetGraphic();
 229         if (pGraphic)
 230         {
 231             uno::Reference<awt::XBitmap> xBitmap(pGraphic->GetXGraphic(), uno::UNO_QUERY);
 232             aVal <<= xBitmap;
 233
 234             const beans::PropertyValue aGraphicProp("GraphicBitmap", -1, aVal, beans::PropertyState_DIRECT_VALUE);
 235             pArray[nIdx++] = aGraphicProp;
 236         }
 237     }
 238
 239     {
 240         const Size aSize( rFmt.GetGraphicSize() );
 241         const awt::Size aUnoSize( aSize.Width(), aSize.Height() );
 242         aVal <<= aUnoSize;
 243         const beans::PropertyValue aGraphicSizeProp("GraphicSize", -1, aVal, beans::PropertyState_DIRECT_VALUE );
 244         pArray[nIdx++] = aGraphicSizeProp;
 245     }
 246
 247     aVal <<= static_cast<sal_Int16>(rFmt.GetStart());
 248     pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_START_WITH, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 249
 250     aVal <<= rFmt.GetAbsLSpace();
 251     pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_LEFT_MARGIN, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 252
 253     aVal <<= rFmt.GetFirstLineOffset();
 254     pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_FIRST_LINE_OFFSET, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 255
 256     pArray[nIdx++] = beans::PropertyValue("SymbolTextDistance", -1, aVal, beans::PropertyState_DIRECT_VALUE);
 257
 258     aVal <<= rFmt.GetBulletColor();
 259     pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_BULLET_COLOR, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 260
 261     aVal <<= static_cast<sal_Int16>(rFmt.GetBulletRelSize());
 262     pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_BULLET_RELSIZE, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 263
 264     DBG_ASSERT( nIdx <= nProps, "FixMe: overflow in Array!!! [CL]" );
 265     Sequence< beans::PropertyValue> aSeq(pArray.get(), nIdx);
 266
 267     return aSeq;
 268 }
 269
 270 void SvxUnoNumberingRules::setNumberingRuleByIndex(const Sequence<beans::PropertyValue >& rProperties, sal_Int32 nIndex)
 271 {
 272     SvxNumberFormat aFmt(maRule.GetLevel( static_cast<sal_uInt16>(nIndex) ));
 273     for(const beans::PropertyValue& rProp : rProperties)
 274     {
 275         const OUString& rPropName = rProp.Name;
 276         const Any& aVal = rProp.Value;
 277
 278         if ( rPropName == UNO_NAME_NRULE_NUMBERINGTYPE )
 279         {
 280             sal_Int16 nSet = sal_Int16();
 281             aVal >>= nSet;
 282
 283             // There is no reason to limit numbering types.
 284             if ( nSet>=0 )
 285             {
 286                 aFmt.SetNumberingType(static_cast<SvxNumType>(nSet));
 287                 continue;
 288             }
 289         }
 290         else if ( rPropName == UNO_NAME_NRULE_PREFIX )
 291         {
 292             OUString aPrefix;
 293             if( aVal >>= aPrefix )
 294             {
 295                 aFmt.SetPrefix(aPrefix);
 296                 continue;
 297             }
 298         }
 299         else if ( rPropName == UNO_NAME_NRULE_SUFFIX )
 300         {
 301             OUString aSuffix;
 302             if( aVal >>= aSuffix )
 303             {
 304                 aFmt.SetSuffix(aSuffix);
 305                 continue;
 306             }
 307         }
 308         else if ( rPropName == UNO_NAME_NRULE_BULLETID )
 309         {
 310             sal_Int16 nSet = sal_Int16();
 311             if( aVal >>= nSet )
 312             {
 313                 if(nSet < 0x100)
 314                 {
 315                     aFmt.SetBulletChar(nSet);
 316                     continue;
 317                 }
 318             }
 319         }
 320         else if ( rPropName == "BulletChar" )
 321         {
 322             OUString aStr;
 323             if( aVal >>= aStr )
 324             {
 325                 if(!aStr.isEmpty())
 326                 {
 327                     sal_Int32 nIndexUtf16 = 0;
 328                     aFmt.SetBulletChar(aStr.iterateCodePoints(&nIndexUtf16));
 329                 }
 330                 else
 331                 {
 332                     aFmt.SetBulletChar(0);
 333                 }
 334                 continue;
 335             }
 336         }
 337         else if ( rPropName == UNO_NAME_NRULE_ADJUST )
 338         {
 339             sal_Int16 nAdjust = sal_Int16();
 340             if( aVal >>= nAdjust )
 341             {
 342                 aFmt.SetNumAdjust(ConvertUnoAdjust( static_cast<unsigned short>(nAdjust) ));
 343                 continue;
 344             }
 345         }
 346         else if ( rPropName == UNO_NAME_NRULE_BULLET_FONT )
 347         {
 348             awt::FontDescriptor aDesc;
 349             if( aVal >>= aDesc )
 350             {
 351                 vcl::Font aFont;
 352                 SvxUnoFontDescriptor::ConvertToFont( aDesc, aFont );
 353                 aFmt.SetBulletFont(&aFont);
 354                 continue;
 355             }
 356         }
 357         else if ( rPropName == "GraphicURL" )
 358         {
 359             OUString aURL;
 360             if (aVal >>= aURL)
 361             {
 362                 Graphic aGraphic = vcl::graphic::loadFromURL(aURL);
 363                 if (!aGraphic.IsNone())
 364                 {
 365                     SvxBrushItem aBrushItem(aGraphic, GPOS_AREA, SID_ATTR_BRUSH);
 366                     aFmt.SetGraphicBrush(&aBrushItem);
 367                 }
 368                 continue;
 369             }
 370         }
 371         else if ( rPropName == "GraphicBitmap" )
 372         {
 373             uno::Reference<awt::XBitmap> xBitmap;
 374             if (aVal >>= xBitmap)
 375             {
 376                 uno::Reference<graphic::XGraphic> xGraphic(xBitmap, uno::UNO_QUERY);
 377                 Graphic aGraphic(xGraphic);
 378                 SvxBrushItem aBrushItem(aGraphic, GPOS_AREA, SID_ATTR_BRUSH);
 379                 aFmt.SetGraphicBrush( &aBrushItem );
 380                 continue;
 381             }
 382         }
 383         else if ( rPropName == "GraphicSize" )
 384         {
 385             awt::Size aUnoSize;
 386             if( aVal >>= aUnoSize )
 387             {
 388                 aFmt.SetGraphicSize( Size( aUnoSize.Width, aUnoSize.Height ) );
 389                 continue;
 390             }
 391         }
 392         else if ( rPropName == UNO_NAME_NRULE_START_WITH )
 393         {
 394             sal_Int16 nStart = sal_Int16();
 395             if( aVal >>= nStart )
 396             {
 397                 aFmt.SetStart( nStart );
 398                 continue;
 399             }
 400         }
 401         else if ( rPropName == UNO_NAME_NRULE_LEFT_MARGIN )
 402         {
 403             sal_Int32 nMargin = 0;
 404             if( aVal >>= nMargin )
 405             {
 406                 aFmt.SetAbsLSpace(nMargin);
 407                 continue;
 408             }
 409         }
 410         else if ( rPropName == UNO_NAME_NRULE_FIRST_LINE_OFFSET )
 411         {
 412             sal_Int32 nMargin = 0;
 413             if( aVal >>= nMargin )
 414             {
 415                 aFmt.SetFirstLineOffset(nMargin);
 416                 continue;
 417             }
 418         }
 419         else if ( rPropName == "SymbolTextDistance" )
 420         {
 421             sal_Int32 nTextDistance = 0;
 422             if( aVal >>= nTextDistance )
 423             {
 424                 aFmt.SetCharTextDistance(static_cast<sal_uInt16>(nTextDistance));
 425                 continue;
 426             }
 427         }
 428         else if ( rPropName == UNO_NAME_NRULE_BULLET_COLOR )
 429         {
 430             sal_Int32 nColor = 0;
 431             if( aVal >>= nColor )
 432             {
 433                 aFmt.SetBulletColor( static_cast<Color>(nColor) );
 434                 continue;
 435             }
 436         }
 437         else if ( rPropName == UNO_NAME_NRULE_BULLET_RELSIZE )
 438         {
 439             sal_Int16 nSize = sal_Int16();
 440             if( aVal >>= nSize )
 441             {
 442                 // [AOO Bug 120650] the slide content corrupt when open in Aoo
 443                 // [TDF# 126234] when MS Office document being imported, the value of the relative size
 444                 // of the bullet could be as high as 400%
 445                 if ((nSize>400)||(nSize<=0))
 446                 {
 447                     nSize = 100;
 448                 }
 449
 450                 aFmt.SetBulletRelSize( static_cast<short>(nSize) );
 451                 continue;
 452             }
 453         }
 454         else
 455         {
 456             continue;
 457         }
 458
 459         throw IllegalArgumentException();
 460     }
 461
 462     // check that we always have a brush item for bitmap numbering
 463     if( aFmt.GetNumberingType() == SVX_NUM_BITMAP )
 464     {
 465         if( nullptr == aFmt.GetBrush() )
 466         {
 467             GraphicObject aGrafObj;
 468             SvxBrushItem aBrushItem( aGrafObj, GPOS_AREA, SID_ATTR_BRUSH );
 469             aFmt.SetGraphicBrush( &aBrushItem );
 470         }
 471     }
 472     maRule.SetLevel( static_cast<sal_uInt16>(nIndex), aFmt );
 473 }
 474
 475 const SvxNumRule& SvxGetNumRule( Reference< XIndexReplace > const & xRule )
 476 {
 477     SvxUnoNumberingRules* pRule = comphelper::getUnoTunnelImplementation<SvxUnoNumberingRules>( xRule );
 478     if( pRule == nullptr )
 479         throw IllegalArgumentException();
 480
 481     return pRule->getNumRule();
 482 }
 483
 484 css::uno::Reference< css::container::XIndexReplace > SvxCreateNumRule(const SvxNumRule* pRule)
 485 {
 486     DBG_ASSERT( pRule, "No default SvxNumRule!" );
 487     if( pRule )
 488     {
 489         return new SvxUnoNumberingRules( *pRule );
 490     }
 491     else
 492     {
 493         SvxNumRule aDefaultRule( SvxNumRuleFlags::BULLET_REL_SIZE | SvxNumRuleFlags::BULLET_COLOR, SVX_MAX_NUM, false);
 494         return new SvxUnoNumberingRules( aDefaultRule );
 495     }
 496 }
 497
 498 namespace {
 499
 500 class SvxUnoNumberingRulesCompare : public ::cppu::WeakAggImplHelper1< XAnyCompare >
 501 {
 502 public:
 503     virtual sal_Int16 SAL_CALL compare( const Any& Any1, const Any& Any2 ) override;
 504 };
 505
 506 }
 507
 508 sal_Int16 SAL_CALL SvxUnoNumberingRulesCompare::compare( const Any& Any1, const Any& Any2 )
 509 {
 510     return SvxUnoNumberingRules::Compare( Any1, Any2 );
 511 }
 512
 513 sal_Int16 SvxUnoNumberingRules::Compare( const Any& Any1, const Any& Any2 )
 514 {
 515     Reference< XIndexReplace > x1( Any1, UNO_QUERY ), x2( Any2, UNO_QUERY );
 516     if( x1.is() && x2.is() )
 517     {
 518         if( x1.get() == x2.get() )
 519             return 0;
 520
 521         SvxUnoNumberingRules* pRule1 = comphelper::getUnoTunnelImplementation<SvxUnoNumberingRules>( x1 );
 522         if( pRule1 )
 523         {
 524             SvxUnoNumberingRules* pRule2 = comphelper::getUnoTunnelImplementation<SvxUnoNumberingRules>( x2 );
 525             if( pRule2 )
 526             {
 527                 const SvxNumRule& rRule1 = pRule1->getNumRule();
 528                 const SvxNumRule& rRule2 = pRule2->getNumRule();
 529
 530                 const sal_uInt16 nLevelCount1 = rRule1.GetLevelCount();
 531                 const sal_uInt16 nLevelCount2 = rRule2.GetLevelCount();
 532
 533                 if( nLevelCount1 == 0 || nLevelCount2 == 0 )
 534                     return -1;
 535
 536                 for( sal_uInt16 i = 0; (i < nLevelCount1) && (i < nLevelCount2); i++ )
 537                 {
 538                     if( rRule1.GetLevel(i) != rRule2.GetLevel(i) )
 539                         return -1;
 540                 }
 541                 return  0;
 542             }
 543         }
 544     }
 545
 546     return -1;
 547 }
 548
 549 Reference< XAnyCompare > SvxCreateNumRuleCompare() throw()
 550 {
 551     return new SvxUnoNumberingRulesCompare;
 552 }
 553
 554 css::uno::Reference< css::container::XIndexReplace > SvxCreateNumRule()
 555 {
 556     SvxNumRule aTempRule( SvxNumRuleFlags::NONE, 10, false );
 557     return SvxCreateNumRule( &aTempRule );
 558 }
 559
 560 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */