editeng/source/items/bulitem.cxx

   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
  29
  30 // include ---------------------------------------------------------------
  31 #include <tools/stream.hxx>
  32 #include <vcl/outdev.hxx>
  33
  34 #define _SVX_BULITEM_CXX
  35
  36 #include <editeng/bulitem.hxx>
  37 #include <editeng/editrids.hrc>
  38
  39 #include <tools/tenccvt.hxx>
  40
  41 #define BULITEM_VERSION     ((sal_uInt16)2)
  42
  43 // -----------------------------------------------------------------------
  44
  45 TYPEINIT1(SvxBulletItem,SfxPoolItem);
  46
  47 // -----------------------------------------------------------------------
  48
  49 void SvxBulletItem::StoreFont( SvStream& rStream, const Font& rFont )
  50 {
  51     sal_uInt16 nTemp;
  52
  53     rStream << rFont.GetColor();
  54     nTemp = (sal_uInt16)rFont.GetFamily(); rStream << nTemp;
  55
  56     nTemp = (sal_uInt16)GetSOStoreTextEncoding((rtl_TextEncoding)rFont.GetCharSet());
  57     rStream << nTemp;
  58
  59     nTemp = (sal_uInt16)rFont.GetPitch(); rStream << nTemp;
  60     nTemp = (sal_uInt16)rFont.GetAlign(); rStream << nTemp;
  61     nTemp = (sal_uInt16)rFont.GetWeight(); rStream << nTemp;
  62     nTemp = (sal_uInt16)rFont.GetUnderline(); rStream << nTemp;
  63     nTemp = (sal_uInt16)rFont.GetStrikeout(); rStream << nTemp;
  64     nTemp = (sal_uInt16)rFont.GetItalic(); rStream << nTemp;
  65
  66     // UNICODE: rStream << rFont.GetName();
  67     rStream.WriteUniOrByteString(rFont.GetName(), rStream.GetStreamCharSet());
  68
  69     rStream << rFont.IsOutline();
  70     rStream << rFont.IsShadow();
  71     rStream << rFont.IsTransparent();
  72 }
  73
  74 // -----------------------------------------------------------------------
  75
  76 Font SvxBulletItem::CreateFont( SvStream& rStream, sal_uInt16 nVer )
  77 {
  78     Font aFont;
  79     Color aColor;
  80     rStream >> aColor;    aFont.SetColor( aColor );
  81     sal_uInt16 nTemp;
  82     rStream >> nTemp; aFont.SetFamily((FontFamily)nTemp);
  83
  84     rStream >> nTemp;
  85     nTemp = (sal_uInt16)GetSOLoadTextEncoding((rtl_TextEncoding)nTemp);
  86     aFont.SetCharSet((rtl_TextEncoding)nTemp);
  87
  88     rStream >> nTemp; aFont.SetPitch((FontPitch)nTemp);
  89     rStream >> nTemp; aFont.SetAlign((FontAlign)nTemp);
  90     rStream >> nTemp; aFont.SetWeight((FontWeight)nTemp);
  91     rStream >> nTemp; aFont.SetUnderline((FontUnderline)nTemp);
  92     rStream >> nTemp; aFont.SetStrikeout((FontStrikeout)nTemp);
  93     rStream >> nTemp; aFont.SetItalic((FontItalic)nTemp);
  94
  95     // UNICODE: rStream >> aName; aFont.SetName( aName );
  96     String aName = rStream.ReadUniOrByteString(rStream.GetStreamCharSet());
  97     aFont.SetName( aName );
  98
  99     if( nVer == 1 )
 100     {
 101         //#fdo39428 SvStream no longer supports operator>>(long&)
 102         sal_Int32 nHeight(0), nWidth(0);
 103         rStream >> nHeight; rStream >> nWidth; Size aSize( nWidth, nHeight );
 104         aFont.SetSize( aSize );
 105     }
 106
 107     sal_Bool bTemp;
 108     rStream >> bTemp; aFont.SetOutline( bTemp );
 109     rStream >> bTemp; aFont.SetShadow( bTemp );
 110     rStream >> bTemp; aFont.SetTransparent( bTemp );
 111     return aFont;
 112 }
 113
 114
 115 // -----------------------------------------------------------------------
 116
 117 SvxBulletItem::SvxBulletItem( sal_uInt16 _nWhich ) : SfxPoolItem( _nWhich )
 118 {
 119     SetDefaultFont_Impl();
 120     SetDefaults_Impl();
 121     nValidMask = 0xFFFF;
 122 }
 123
 124 // -----------------------------------------------------------------------
 125
 126 SvxBulletItem::SvxBulletItem( SvStream& rStrm, sal_uInt16 _nWhich ) :
 127     SfxPoolItem( _nWhich ),
 128     pGraphicObject( NULL )
 129 {
 130     rStrm >> nStyle;
 131
 132     if( nStyle != BS_BMP )
 133         aFont = CreateFont( rStrm, BULITEM_VERSION );
 134     else
 135     {
 136         // Safe Load with Test on empty Bitmap
 137         Bitmap          aBmp;
 138         const sal_uInt32    nOldPos = rStrm.Tell();
 139         // Ignore Errorcode when reading Bitmap,
 140         // see comment in SvxBulletItem::Store()
 141         sal_Bool bOldError = rStrm.GetError() ? sal_True : sal_False;
 142         rStrm >> aBmp;
 143         if ( !bOldError && rStrm.GetError() )
 144         {
 145             rStrm.ResetError();
 146         }
 147
 148         if( aBmp.IsEmpty() )
 149         {
 150             rStrm.Seek( nOldPos );
 151             nStyle = BS_NONE;
 152         }
 153         else
 154             pGraphicObject = new GraphicObject( aBmp );
 155     }
 156
 157     //#fdo39428 SvStream no longer supports operator>>(long&)
 158     sal_Int32 nTmp(0);
 159     rStrm >> nTmp; nWidth = nTmp;
 160     rStrm >> nStart;
 161     rStrm >> nJustify;
 162
 163     char cTmpSymbol;
 164     rStrm >> cTmpSymbol;
 165     //convert single byte to unicode
 166     cSymbol = rtl::OUString(&cTmpSymbol, 1, aFont.GetCharSet()).toChar();
 167
 168     rStrm >> nScale;
 169
 170     // UNICODE: rStrm >> aPrevText;
 171     aPrevText = rStrm.ReadUniOrByteString(rStrm.GetStreamCharSet());
 172
 173     // UNICODE: rStrm >> aFollowText;
 174     aFollowText = rStrm.ReadUniOrByteString(rStrm.GetStreamCharSet());
 175
 176     nValidMask = 0xFFFF;
 177 }
 178
 179 // -----------------------------------------------------------------------
 180
 181 SvxBulletItem::SvxBulletItem( const SvxBulletItem& rItem) : SfxPoolItem( rItem )
 182 {
 183     aFont           = rItem.aFont;
 184     pGraphicObject  = ( rItem.pGraphicObject ? new GraphicObject( *rItem.pGraphicObject ) : NULL );
 185     aPrevText       = rItem.aPrevText;
 186     aFollowText     = rItem.aFollowText;
 187     nStart          = rItem.nStart;
 188     nStyle          = rItem.nStyle;
 189     nWidth          = rItem.nWidth;
 190     nScale          = rItem.nScale;
 191     cSymbol         = rItem.cSymbol;
 192     nJustify        = rItem.nJustify;
 193     nValidMask      = rItem.nValidMask;
 194 }
 195
 196 // -----------------------------------------------------------------------
 197
 198 SvxBulletItem::~SvxBulletItem()
 199 {
 200     if( pGraphicObject )
 201         delete pGraphicObject;
 202 }
 203
 204 // -----------------------------------------------------------------------
 205
 206 SfxPoolItem* SvxBulletItem::Clone( SfxItemPool * /*pPool*/ ) const
 207 {
 208     return new SvxBulletItem( *this );
 209 }
 210
 211 // -----------------------------------------------------------------------
 212
 213 SfxPoolItem* SvxBulletItem::Create( SvStream& rStrm, sal_uInt16 /*nVersion*/ ) const
 214 {
 215     return new SvxBulletItem( rStrm, Which() );
 216 }
 217
 218 // -----------------------------------------------------------------------
 219
 220 void SvxBulletItem::SetDefaultFont_Impl()
 221 {
 222     aFont = OutputDevice::GetDefaultFont( DEFAULTFONT_FIXED, LANGUAGE_SYSTEM, 0 );
 223     aFont.SetAlign( ALIGN_BOTTOM);
 224     aFont.SetTransparent( sal_True );
 225 }
 226
 227 // -----------------------------------------------------------------------
 228
 229 void SvxBulletItem::SetDefaults_Impl()
 230 {
 231     pGraphicObject  = NULL;
 232     nWidth          = 1200;  // 1.2cm
 233     nStart          = 1;
 234     nStyle          = BS_123;
 235     nJustify        = BJ_HLEFT | BJ_VCENTER;
 236     cSymbol         = sal_Unicode(' ');
 237     nScale          = 75;
 238 }
 239
 240 // -----------------------------------------------------------------------
 241
 242 sal_uInt16 SvxBulletItem::GetVersion( sal_uInt16 /*nVersion*/ ) const
 243 {
 244     return BULITEM_VERSION;
 245 }
 246
 247 // -----------------------------------------------------------------------
 248
 249 void SvxBulletItem::CopyValidProperties( const SvxBulletItem& rCopyFrom )
 250 {
 251     Font _aFont = GetFont();
 252     Font aNewFont = rCopyFrom.GetFont();
 253     if ( rCopyFrom.IsValid( VALID_FONTNAME ) )
 254     {
 255         _aFont.SetName( aNewFont.GetName() );
 256         _aFont.SetFamily( aNewFont.GetFamily() );
 257         _aFont.SetStyleName( aNewFont.GetStyleName() );
 258     }
 259     if ( rCopyFrom.IsValid( VALID_FONTCOLOR ) )
 260         _aFont.SetColor( aNewFont.GetColor() );
 261     if ( rCopyFrom.IsValid( VALID_SYMBOL ) )
 262         SetSymbol( rCopyFrom.GetSymbol() );
 263     if ( rCopyFrom.IsValid( VALID_BITMAP ) )
 264         SetGraphicObject( rCopyFrom.GetGraphicObject() );
 265     if ( rCopyFrom.IsValid( VALID_SCALE ) )
 266         SetScale( rCopyFrom.GetScale() );
 267     if ( rCopyFrom.IsValid( VALID_START ) )
 268         SetStart( rCopyFrom.GetStart() );
 269     if ( rCopyFrom.IsValid( VALID_STYLE ) )
 270         SetStyle( rCopyFrom.GetStyle() );
 271     if ( rCopyFrom.IsValid( VALID_PREVTEXT ) )
 272         SetPrevText( rCopyFrom.GetPrevText() );
 273     if ( rCopyFrom.IsValid( VALID_FOLLOWTEXT ) )
 274         SetFollowText( rCopyFrom.GetFollowText() );
 275
 276     SetFont( _aFont );
 277 }
 278
 279
 280 // -----------------------------------------------------------------------
 281
 282 int SvxBulletItem::operator==( const SfxPoolItem& rItem ) const
 283 {
 284     DBG_ASSERT(rItem.ISA(SvxBulletItem),"operator==Types not matching");
 285     const SvxBulletItem& rBullet = (const SvxBulletItem&)rItem;
 286     // Compare with ValidMask, otherwise no put possible in a AttrSet if the
 287     // item differs only in terms of the ValidMask from an existing one.
 288     if( nValidMask != rBullet.nValidMask    ||
 289         nStyle != rBullet.nStyle            ||
 290         nScale != rBullet.nScale            ||
 291         nJustify != rBullet.nJustify        ||
 292         nWidth != rBullet.nWidth            ||
 293         nStart != rBullet.nStart            ||
 294         cSymbol != rBullet.cSymbol          ||
 295         aPrevText != rBullet.aPrevText      ||
 296         aFollowText != rBullet.aFollowText )
 297             return 0;
 298
 299     if( ( nStyle != BS_BMP ) && ( aFont != rBullet.aFont ) )
 300         return 0;
 301
 302     if( nStyle == BS_BMP )
 303     {
 304         if( ( pGraphicObject && !rBullet.pGraphicObject ) || ( !pGraphicObject && rBullet.pGraphicObject ) )
 305             return 0;
 306
 307         if( ( pGraphicObject && rBullet.pGraphicObject ) &&
 308             ( ( *pGraphicObject != *rBullet.pGraphicObject ) ||
 309               ( pGraphicObject->GetPrefSize() != rBullet.pGraphicObject->GetPrefSize() ) ) )
 310         {
 311             return 0;
 312         }
 313     }
 314
 315     return 1;
 316 }
 317
 318 // -----------------------------------------------------------------------
 319
 320 SvStream& SvxBulletItem::Store( SvStream& rStrm, sal_uInt16 /*nItemVersion*/ ) const
 321 {
 322     // Correction for empty bitmap
 323     if( ( nStyle == BS_BMP ) &&
 324         ( !pGraphicObject || ( GRAPHIC_NONE == pGraphicObject->GetType() ) || ( GRAPHIC_DEFAULT == pGraphicObject->GetType() ) ) )
 325     {
 326         if( pGraphicObject )
 327         {
 328             delete( const_cast< SvxBulletItem* >( this )->pGraphicObject );
 329             const_cast< SvxBulletItem* >( this )->pGraphicObject = NULL;
 330         }
 331
 332         const_cast< SvxBulletItem* >( this )->nStyle = BS_NONE;
 333     }
 334
 335     rStrm << nStyle;
 336
 337     if( nStyle != BS_BMP )
 338         StoreFont( rStrm, aFont );
 339     else
 340     {
 341         sal_uLong _nStart = rStrm.Tell();
 342
 343         // Small preliminary estimate of the size ...
 344         sal_uInt16 nFac = ( rStrm.GetCompressMode() != COMPRESSMODE_NONE ) ? 3 : 1;
 345         const Bitmap aBmp( pGraphicObject->GetGraphic().GetBitmap() );
 346         sal_uLong nBytes = aBmp.GetSizeBytes();
 347         if ( nBytes < sal_uLong(0xFF00*nFac) )
 348             rStrm << aBmp;
 349
 350         sal_uLong nEnd = rStrm.Tell();
 351         // Item can not write with an overhead more than 64K or SfxMultiRecord
 352         // will crash. Then prefer to forego on the bitmap, it is only
 353         // important for the outliner and only for <= 5.0.
 354         // When reading, the stream-operator makes note of the bitmap and the
 355         // fact that there is none. This is now the case how it works with
 356         // large bitmap created from another file format, which do not occupy a
 357         // 64K chunk, but if a bitmap > 64K is used, the SvxNumBulletItem will
 358         // have problem loading it, but does not crash.
 359
 360         if ( (nEnd-_nStart) > 0xFF00 )
 361             rStrm.Seek( _nStart );
 362     }
 363     rStrm << static_cast<sal_Int32>(nWidth);
 364     rStrm << nStart;
 365     rStrm << nJustify;
 366     rStrm << rtl::OUStringToOString(rtl::OUString(cSymbol), aFont.GetCharSet()).toChar();
 367     rStrm << nScale;
 368
 369     // UNICODE: rStrm << aPrevText;
 370     rStrm.WriteUniOrByteString(aPrevText, rStrm.GetStreamCharSet());
 371
 372     // UNICODE: rStrm << aFollowText;
 373     rStrm.WriteUniOrByteString(aFollowText, rStrm.GetStreamCharSet());
 374
 375     return rStrm;
 376 }
 377
 378 //------------------------------------------------------------------------
 379
 380 XubString SvxBulletItem::GetFullText() const
 381 {
 382     XubString aStr( aPrevText );
 383     aStr += cSymbol;
 384     aStr += aFollowText;
 385     return aStr;
 386 }
 387
 388 //------------------------------------------------------------------------
 389
 390 SfxItemPresentation SvxBulletItem::GetPresentation
 391 (
 392     SfxItemPresentation ePres,
 393     SfxMapUnit          /*eCoreUnit*/,
 394     SfxMapUnit          /*ePresUnit*/,
 395     XubString&          rText, const IntlWrapper *
 396 )   const
 397 {
 398     SfxItemPresentation eRet = SFX_ITEM_PRESENTATION_NONE;
 399     switch ( ePres )
 400     {
 401         case SFX_ITEM_PRESENTATION_NONE:
 402             rText.Erase();
 403             eRet = SFX_ITEM_PRESENTATION_NONE;
 404             break;
 405
 406         case SFX_ITEM_PRESENTATION_NAMELESS:
 407         case SFX_ITEM_PRESENTATION_COMPLETE:
 408             rText = GetFullText();
 409             eRet = SFX_ITEM_PRESENTATION_COMPLETE;
 410             break;
 411         default: ; //prevent warning
 412     }
 413     return eRet;
 414 }
 415
 416 //------------------------------------------------------------------------
 417
 418 const GraphicObject& SvxBulletItem::GetGraphicObject() const
 419 {
 420     if( pGraphicObject )
 421         return *pGraphicObject;
 422     else
 423     {
 424         static const GraphicObject aDefaultObject;
 425         return aDefaultObject;
 426     }
 427 }
 428
 429 //------------------------------------------------------------------------
 430
 431 void SvxBulletItem::SetGraphicObject( const GraphicObject& rGraphicObject )
 432 {
 433     if( ( GRAPHIC_NONE == rGraphicObject.GetType() ) || ( GRAPHIC_DEFAULT == rGraphicObject.GetType() ) )
 434     {
 435         if( pGraphicObject )
 436         {
 437             delete pGraphicObject;
 438             pGraphicObject = NULL;
 439         }
 440     }
 441     else
 442     {
 443         delete pGraphicObject;
 444         pGraphicObject = new GraphicObject( rGraphicObject );
 445     }
 446 }
 447
 448 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */