svx/source/items/bulitem.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: bulitem.cxx,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_svx.hxx"
  33
  34 // include ---------------------------------------------------------------
  35 #include <tools/stream.hxx>
  36
  37 #include <vcl/outdev.hxx>
  38
  39 #define _SVX_BULITEM_CXX
  40
  41 #include "bulitem.hxx"
  42 #include "svxerr.hxx"
  43
  44 // #90477#
  45 #include <tools/tenccvt.hxx>
  46
  47 #define BULITEM_VERSION         ((USHORT)2)
  48
  49 // -----------------------------------------------------------------------
  50
  51 TYPEINIT1(SvxBulletItem,SfxPoolItem);
  52
  53 // -----------------------------------------------------------------------
  54
  55 void SvxBulletItem::StoreFont( SvStream& rStream, const Font& rFont )
  56 {
  57     USHORT nTemp;
  58
  59     rStream << rFont.GetColor();
  60     nTemp = (USHORT)rFont.GetFamily(); rStream << nTemp;
  61
  62     // #90477# nTemp = (USHORT)GetStoreCharSet( rFont.GetCharSet(), rStream.GetVersion() );
  63     nTemp = (USHORT)GetSOStoreTextEncoding((rtl_TextEncoding)rFont.GetCharSet(), (sal_uInt16)rStream.GetVersion());
  64     rStream << nTemp;
  65
  66     nTemp = (USHORT)rFont.GetPitch(); rStream << nTemp;
  67     nTemp = (USHORT)rFont.GetAlign(); rStream << nTemp;
  68     nTemp = (USHORT)rFont.GetWeight(); rStream << nTemp;
  69     nTemp = (USHORT)rFont.GetUnderline(); rStream << nTemp;
  70     nTemp = (USHORT)rFont.GetStrikeout(); rStream << nTemp;
  71     nTemp = (USHORT)rFont.GetItalic(); rStream << nTemp;
  72
  73     // UNICODE: rStream << rFont.GetName();
  74     rStream.WriteByteString(rFont.GetName());
  75
  76     rStream << rFont.IsOutline();
  77     rStream << rFont.IsShadow();
  78     rStream << rFont.IsTransparent();
  79 }
  80
  81 // -----------------------------------------------------------------------
  82
  83 Font SvxBulletItem::CreateFont( SvStream& rStream, USHORT nVer )
  84 {
  85     Font aFont;
  86     Color aColor;
  87     rStream >> aColor;    aFont.SetColor( aColor );
  88     USHORT nTemp;
  89     rStream >> nTemp; aFont.SetFamily((FontFamily)nTemp);
  90
  91     // #90477#
  92     rStream >> nTemp;
  93     nTemp = (sal_uInt16)GetSOLoadTextEncoding((rtl_TextEncoding)nTemp, (sal_uInt16)rStream.GetVersion());
  94     aFont.SetCharSet((rtl_TextEncoding)nTemp);
  95
  96     rStream >> nTemp; aFont.SetPitch((FontPitch)nTemp);
  97     rStream >> nTemp; aFont.SetAlign((FontAlign)nTemp);
  98     rStream >> nTemp; aFont.SetWeight((FontWeight)nTemp);
  99     rStream >> nTemp; aFont.SetUnderline((FontUnderline)nTemp);
 100     rStream >> nTemp; aFont.SetStrikeout((FontStrikeout)nTemp);
 101     rStream >> nTemp; aFont.SetItalic((FontItalic)nTemp);
 102
 103     // UNICODE: rStream >> aName; aFont.SetName( aName );
 104     String aName;
 105     rStream.ReadByteString(aName);
 106     aFont.SetName( aName );
 107
 108     if( nVer == 1 )
 109     {
 110         long nHeight, nWidth;
 111         rStream >> nHeight; rStream >> nWidth; Size aSize( nWidth, nHeight );
 112         aFont.SetSize( aSize );
 113     }
 114
 115     BOOL bTemp;
 116     rStream >> bTemp; aFont.SetOutline( bTemp );
 117     rStream >> bTemp; aFont.SetShadow( bTemp );
 118     rStream >> bTemp; aFont.SetTransparent( bTemp );
 119     return aFont;
 120 }
 121
 122
 123 // -----------------------------------------------------------------------
 124
 125 SvxBulletItem::SvxBulletItem( USHORT _nWhich ) : SfxPoolItem( _nWhich )
 126 {
 127     SetDefaultFont_Impl();
 128     SetDefaults_Impl();
 129     nValidMask = 0xFFFF;
 130 }
 131
 132 // -----------------------------------------------------------------------
 133
 134 SvxBulletItem::SvxBulletItem( BYTE nNewStyle, const Font& rFont, USHORT /*nStart*/, USHORT _nWhich ) : SfxPoolItem( _nWhich )
 135 {
 136     SetDefaults_Impl();
 137     nStyle = nNewStyle;
 138     aFont  = rFont;
 139     nValidMask = 0xFFFF;
 140 }
 141
 142 // -----------------------------------------------------------------------
 143
 144 SvxBulletItem::SvxBulletItem( const Font& rFont, xub_Unicode cSymb, USHORT _nWhich ) : SfxPoolItem( _nWhich )
 145 {
 146     SetDefaults_Impl();
 147     aFont       = rFont;
 148     cSymbol = cSymb;
 149     nStyle      = BS_BULLET;
 150     nValidMask = 0xFFFF;
 151 }
 152
 153 // -----------------------------------------------------------------------
 154
 155 SvxBulletItem::SvxBulletItem( const Bitmap& rBmp, USHORT _nWhich ) : SfxPoolItem( _nWhich )
 156 {
 157     SetDefaults_Impl();
 158
 159     if( !rBmp.IsEmpty() )
 160     {
 161         pGraphicObject = new GraphicObject( rBmp );
 162         nStyle = BS_BMP;
 163     }
 164
 165     nValidMask = 0xFFFF;
 166 }
 167
 168 // -----------------------------------------------------------------------
 169
 170 SvxBulletItem::SvxBulletItem( const GraphicObject& rGraphicObject, USHORT _nWhich ) : SfxPoolItem( _nWhich )
 171 {
 172     SetDefaults_Impl();
 173
 174     if( ( GRAPHIC_NONE != pGraphicObject->GetType() ) && ( GRAPHIC_DEFAULT != pGraphicObject->GetType() ) )
 175     {
 176         pGraphicObject = new GraphicObject( rGraphicObject );
 177         nStyle = BS_BMP;
 178     }
 179
 180     nValidMask = 0xFFFF;
 181 }
 182
 183 // -----------------------------------------------------------------------
 184
 185 SvxBulletItem::SvxBulletItem( SvStream& rStrm, USHORT _nWhich ) :
 186     SfxPoolItem( _nWhich ),
 187     pGraphicObject( NULL )
 188 {
 189     rStrm >> nStyle;
 190
 191     if( nStyle != BS_BMP )
 192         aFont = CreateFont( rStrm, BULITEM_VERSION );
 193     else
 194     {
 195         // Sicheres Laden mit Test auf leere Bitmap
 196         Bitmap                  aBmp;
 197         const UINT32    nOldPos = rStrm.Tell();
 198         // #69345# Errorcode beim Bitmap lesen ignorieren,
 199         // siehe Kommentar #67581# in SvxBulletItem::Store()
 200         BOOL bOldError = rStrm.GetError() ? TRUE : FALSE;
 201         rStrm >> aBmp;
 202         if ( !bOldError && rStrm.GetError() )
 203         {
 204             rStrm.ResetError();
 205             // #71493# Keine Warnung: Das BulletItem interessiert seit 5.0 im Dateiformat nicht mehr.
 206             // rStrm.SetError(ERRCODE_CLASS_READ | ERRCODE_SVX_BULLETITEM_NOBULLET | ERRCODE_WARNING_MASK);
 207         }
 208
 209         if( aBmp.IsEmpty() )
 210         {
 211             rStrm.Seek( nOldPos );
 212             nStyle = BS_NONE;
 213         }
 214         else
 215             pGraphicObject = new GraphicObject( aBmp );
 216     }
 217
 218     rStrm >> nWidth;
 219     rStrm >> nStart;
 220     rStrm >> nJustify;
 221
 222     char cTmpSymbol;
 223     rStrm >> cTmpSymbol;
 224     cSymbol = ByteString::ConvertToUnicode( cTmpSymbol, aFont.GetCharSet() );
 225
 226     rStrm >> nScale;
 227
 228     // UNICODE: rStrm >> aPrevText;
 229     rStrm.ReadByteString(aPrevText);
 230
 231     // UNICODE: rStrm >> aFollowText;
 232     rStrm.ReadByteString(aFollowText);
 233
 234     nValidMask = 0xFFFF;
 235 }
 236
 237 // -----------------------------------------------------------------------
 238
 239 SvxBulletItem::SvxBulletItem( const SvxBulletItem& rItem) : SfxPoolItem( rItem )
 240 {
 241     aFont                       = rItem.aFont;
 242     pGraphicObject      = ( rItem.pGraphicObject ? new GraphicObject( *rItem.pGraphicObject ) : NULL );
 243     aPrevText           = rItem.aPrevText;
 244     aFollowText         = rItem.aFollowText;
 245     nStart                      = rItem.nStart;
 246     nStyle                      = rItem.nStyle;
 247     nWidth                      = rItem.nWidth;
 248     nScale                      = rItem.nScale;
 249     cSymbol                     = rItem.cSymbol;
 250     nJustify            = rItem.nJustify;
 251     nValidMask          = rItem.nValidMask;
 252 }
 253
 254 // -----------------------------------------------------------------------
 255
 256 SvxBulletItem::~SvxBulletItem()
 257 {
 258     if( pGraphicObject )
 259         delete pGraphicObject;
 260 }
 261
 262 // -----------------------------------------------------------------------
 263
 264 SfxPoolItem* SvxBulletItem::Clone( SfxItemPool * /*pPool*/ ) const
 265 {
 266     return new SvxBulletItem( *this );
 267 }
 268
 269 // -----------------------------------------------------------------------
 270
 271 SfxPoolItem* SvxBulletItem::Create( SvStream& rStrm, USHORT /*nVersion*/ ) const
 272 {
 273     return new SvxBulletItem( rStrm, Which() );
 274 }
 275
 276 // -----------------------------------------------------------------------
 277
 278 void SvxBulletItem::SetDefaultFont_Impl()
 279 {
 280     aFont = OutputDevice::GetDefaultFont( DEFAULTFONT_FIXED, LANGUAGE_SYSTEM, 0 );
 281     aFont.SetAlign( ALIGN_BOTTOM);
 282     aFont.SetTransparent( TRUE );
 283 }
 284
 285 // -----------------------------------------------------------------------
 286
 287 void SvxBulletItem::SetDefaults_Impl()
 288 {
 289     pGraphicObject  = NULL;
 290     nWidth                  = 1200;  // 1.2cm
 291     nStart                  = 1;
 292     nStyle                  = BS_123;
 293     nJustify        = BJ_HLEFT | BJ_VCENTER;
 294     cSymbol                 = sal_Unicode(' ');
 295     nScale                  = 75;
 296 }
 297
 298 // -----------------------------------------------------------------------
 299
 300 USHORT SvxBulletItem::GetVersion( USHORT /*nVersion*/ ) const
 301 {
 302     return BULITEM_VERSION;
 303 }
 304
 305 // -----------------------------------------------------------------------
 306
 307 void SvxBulletItem::CopyValidProperties( const SvxBulletItem& rCopyFrom )
 308 {
 309     Font _aFont = GetFont();
 310     Font aNewFont = rCopyFrom.GetFont();
 311     if ( rCopyFrom.IsValid( VALID_FONTNAME ) )
 312     {
 313         _aFont.SetName( aNewFont.GetName() );
 314         _aFont.SetFamily( aNewFont.GetFamily() );
 315         _aFont.SetStyleName( aNewFont.GetStyleName() );
 316     }
 317     if ( rCopyFrom.IsValid( VALID_FONTCOLOR ) )
 318         _aFont.SetColor( aNewFont.GetColor() );
 319     if ( rCopyFrom.IsValid( VALID_SYMBOL ) )
 320         SetSymbol( rCopyFrom.GetSymbol() );
 321     if ( rCopyFrom.IsValid( VALID_BITMAP ) )
 322         SetGraphicObject( rCopyFrom.GetGraphicObject() );
 323     if ( rCopyFrom.IsValid( VALID_SCALE ) )
 324         SetScale( rCopyFrom.GetScale() );
 325     if ( rCopyFrom.IsValid( VALID_START ) )
 326         SetStart( rCopyFrom.GetStart() );
 327     if ( rCopyFrom.IsValid( VALID_STYLE ) )
 328         SetStyle( rCopyFrom.GetStyle() );
 329     if ( rCopyFrom.IsValid( VALID_PREVTEXT ) )
 330         SetPrevText( rCopyFrom.GetPrevText() );
 331     if ( rCopyFrom.IsValid( VALID_FOLLOWTEXT ) )
 332         SetFollowText( rCopyFrom.GetFollowText() );
 333
 334     SetFont( _aFont );
 335 }
 336
 337
 338 // -----------------------------------------------------------------------
 339
 340 int SvxBulletItem::operator==( const SfxPoolItem& rItem ) const
 341 {
 342     DBG_ASSERT(rItem.ISA(SvxBulletItem),"operator==Types not matching");
 343     const SvxBulletItem& rBullet = (const SvxBulletItem&)rItem;
 344     // ValidMask mitvergleichen, da sonst kein Putten in ein AttrSet moeglich,
 345     // wenn sich das Item nur in der ValidMask von einem existierenden unterscheidet.
 346     if( nValidMask != rBullet.nValidMask        ||
 347         nStyle != rBullet.nStyle                        ||
 348         nScale != rBullet.nScale                        ||
 349         nJustify != rBullet.nJustify            ||
 350         nWidth != rBullet.nWidth                        ||
 351         nStart != rBullet.nStart                        ||
 352         cSymbol != rBullet.cSymbol                      ||
 353         aPrevText != rBullet.aPrevText          ||
 354         aFollowText != rBullet.aFollowText )
 355             return 0;
 356
 357     if( ( nStyle != BS_BMP ) && ( aFont != rBullet.aFont ) )
 358         return 0;
 359
 360     if( nStyle == BS_BMP )
 361     {
 362         if( ( pGraphicObject && !rBullet.pGraphicObject ) || ( !pGraphicObject && rBullet.pGraphicObject ) )
 363             return 0;
 364
 365         if( ( pGraphicObject && rBullet.pGraphicObject ) &&
 366             ( ( *pGraphicObject != *rBullet.pGraphicObject ) ||
 367               ( pGraphicObject->GetPrefSize() != rBullet.pGraphicObject->GetPrefSize() ) ) )
 368         {
 369             return 0;
 370         }
 371     }
 372
 373     return 1;
 374 }
 375
 376 // -----------------------------------------------------------------------
 377
 378 SvStream& SvxBulletItem::Store( SvStream& rStrm, USHORT /*nItemVersion*/ ) const
 379 {
 380     // Korrektur bei leerer Bitmap
 381     if( ( nStyle == BS_BMP ) &&
 382         ( !pGraphicObject || ( GRAPHIC_NONE == pGraphicObject->GetType() ) || ( GRAPHIC_DEFAULT == pGraphicObject->GetType() ) ) )
 383     {
 384         if( pGraphicObject )
 385         {
 386             delete( const_cast< SvxBulletItem* >( this )->pGraphicObject );
 387             const_cast< SvxBulletItem* >( this )->pGraphicObject = NULL;
 388         }
 389
 390         const_cast< SvxBulletItem* >( this )->nStyle = BS_NONE;
 391     }
 392
 393     rStrm << nStyle;
 394
 395     if( nStyle != BS_BMP )
 396         StoreFont( rStrm, aFont );
 397     else
 398     {
 399         ULONG _nStart = rStrm.Tell();
 400
 401         // Kleine Vorab-Schaetzung der Groesse...
 402         USHORT nFac = ( rStrm.GetCompressMode() != COMPRESSMODE_NONE ) ? 3 : 1;
 403         const Bitmap aBmp( pGraphicObject->GetGraphic().GetBitmap() );
 404         ULONG nBytes = aBmp.GetSizeBytes();
 405         if ( nBytes < ULONG(0xFF00*nFac) )
 406             rStrm << aBmp;
 407
 408         ULONG nEnd = rStrm.Tell();
 409         // #67581# Item darf mit Overhead nicht mehr als 64K schreiben,
 410         // sonst platzt der SfxMultiRecord
 411         // Dann lieber auf die Bitmap verzichten, ist nur fuer Outliner
 412         // und auch nur fuer <= 5.0 wichtig.
 413         // Beim Einlesen merkt der Stream-Operator der Bitmap, dass dort keine steht.
 414         // Hiermit funktioniert jetzt der Fall das die grosse Bitmap aus einem anderen
 415         // Fileformat entstanden ist, welches keine 64K belegt, aber wenn eine
 416         // Bitmap > 64K verwendet wird, hat das SvxNumBulletItem beim Laden ein Problem,
 417         // stuerzt aber nicht ab.
 418
 419         if ( (nEnd-_nStart) > 0xFF00 )
 420             rStrm.Seek( _nStart );
 421     }
 422     rStrm << nWidth;
 423     rStrm << nStart;
 424     rStrm << nJustify;
 425     rStrm << (char)ByteString::ConvertFromUnicode( cSymbol, aFont.GetCharSet() );
 426     rStrm << nScale;
 427
 428     // UNICODE: rStrm << aPrevText;
 429     rStrm.WriteByteString(aPrevText);
 430
 431     // UNICODE: rStrm << aFollowText;
 432     rStrm.WriteByteString(aFollowText);
 433
 434     return rStrm;
 435 }
 436
 437 //------------------------------------------------------------------------
 438
 439 XubString SvxBulletItem::GetFullText() const
 440 {
 441     XubString aStr( aPrevText );
 442     aStr += cSymbol;
 443     aStr += aFollowText;
 444     return aStr;
 445 }
 446
 447 //------------------------------------------------------------------------
 448
 449 SfxItemPresentation SvxBulletItem::GetPresentation
 450 (
 451     SfxItemPresentation ePres,
 452     SfxMapUnit          /*eCoreUnit*/,
 453     SfxMapUnit          /*ePresUnit*/,
 454     XubString&          rText, const IntlWrapper *
 455 )       const
 456 {
 457     SfxItemPresentation eRet = SFX_ITEM_PRESENTATION_NONE;
 458     switch ( ePres )
 459     {
 460         case SFX_ITEM_PRESENTATION_NONE:
 461             rText.Erase();
 462             eRet = SFX_ITEM_PRESENTATION_NONE;
 463             break;
 464
 465         case SFX_ITEM_PRESENTATION_NAMELESS:
 466         case SFX_ITEM_PRESENTATION_COMPLETE:
 467             rText = GetFullText();
 468             eRet = SFX_ITEM_PRESENTATION_COMPLETE;
 469             break;
 470         default: ; //prevent warning
 471     }
 472     return eRet;
 473 }
 474
 475 //------------------------------------------------------------------------
 476
 477 Bitmap SvxBulletItem::GetBitmap() const
 478 {
 479     if( pGraphicObject )
 480         return pGraphicObject->GetGraphic().GetBitmap();
 481     else
 482     {
 483         const Bitmap aDefaultBitmap;
 484         return aDefaultBitmap;
 485     }
 486 }
 487
 488 //------------------------------------------------------------------------
 489
 490 void SvxBulletItem::SetBitmap( const Bitmap& rBmp )
 491 {
 492     if( rBmp.IsEmpty() )
 493     {
 494         if( pGraphicObject )
 495         {
 496             delete pGraphicObject;
 497             pGraphicObject = NULL;
 498         }
 499     }
 500     else
 501     {
 502         delete pGraphicObject;
 503         pGraphicObject = new GraphicObject( rBmp );
 504
 505     }
 506 }
 507
 508 //------------------------------------------------------------------------
 509
 510 const GraphicObject& SvxBulletItem::GetGraphicObject() const
 511 {
 512     if( pGraphicObject )
 513         return *pGraphicObject;
 514     else
 515     {
 516         static const GraphicObject aDefaultObject;
 517         return aDefaultObject;
 518     }
 519 }
 520
 521 //------------------------------------------------------------------------
 522
 523 void SvxBulletItem::SetGraphicObject( const GraphicObject& rGraphicObject )
 524 {
 525     if( ( GRAPHIC_NONE == rGraphicObject.GetType() ) || ( GRAPHIC_DEFAULT == rGraphicObject.GetType() ) )
 526     {
 527         if( pGraphicObject )
 528         {
 529             delete pGraphicObject;
 530             pGraphicObject = NULL;
 531         }
 532     }
 533     else
 534     {
 535         delete pGraphicObject;
 536         pGraphicObject = new GraphicObject( rGraphicObject );
 537     }
 538 }