vcl/source/gdi/wall.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 <tools/stream.hxx>
  21 #include <tools/vcompat.hxx>
  22 #include <vcl/bitmapex.hxx>
  23 #include <vcl/gradient.hxx>
  24 #include <vcl/wall.hxx>
  25 #include <vcl/svapp.hxx>
  26 #include <wall2.hxx>
  27 #include <vcl/dibtools.hxx>
  28 #include <vcl/settings.hxx>
  29 #include <o3tl/make_unique.hxx>
  30
  31 ImplWallpaper::ImplWallpaper() :
  32     maColor( COL_TRANSPARENT ), meStyle( WallpaperStyle::NONE )
  33 {
  34 }
  35
  36 ImplWallpaper::ImplWallpaper( const ImplWallpaper& rImplWallpaper ) :
  37     maColor( rImplWallpaper.maColor ), meStyle(rImplWallpaper.meStyle)
  38 {
  39     if ( rImplWallpaper.mpBitmap )
  40         mpBitmap = o3tl::make_unique<BitmapEx>( *rImplWallpaper.mpBitmap );
  41
  42     if( rImplWallpaper.mpCache )
  43         mpCache = o3tl::make_unique<BitmapEx>( *rImplWallpaper.mpCache );
  44
  45     if ( rImplWallpaper.mpGradient )
  46         mpGradient = o3tl::make_unique<Gradient>( *rImplWallpaper.mpGradient );
  47
  48     if ( rImplWallpaper.mpRect )
  49         mpRect = o3tl::make_unique<tools::Rectangle>( *rImplWallpaper.mpRect );
  50
  51 }
  52
  53 ImplWallpaper::~ImplWallpaper()
  54 {
  55 }
  56
  57 SvStream& ReadImplWallpaper( SvStream& rIStm, ImplWallpaper& rImplWallpaper )
  58 {
  59     VersionCompat   aCompat( rIStm, StreamMode::READ );
  60     sal_uInt16          nTmp16;
  61
  62     rImplWallpaper.mpRect.reset();
  63     rImplWallpaper.mpGradient.reset();
  64     rImplWallpaper.mpBitmap.reset();
  65
  66     // version 1
  67     ReadColor( rIStm, rImplWallpaper.maColor );
  68     rIStm.ReadUInt16( nTmp16 ); rImplWallpaper.meStyle = (WallpaperStyle) nTmp16;
  69
  70     // version 2
  71     if( aCompat.GetVersion() >= 2 )
  72     {
  73         bool bRect, bGrad, bBmp, bDummy;
  74
  75         rIStm.ReadCharAsBool( bRect ).ReadCharAsBool( bGrad ).ReadCharAsBool( bBmp ).ReadCharAsBool( bDummy ).ReadCharAsBool( bDummy ).ReadCharAsBool( bDummy );
  76
  77         if( bRect )
  78         {
  79             rImplWallpaper.mpRect = o3tl::make_unique<tools::Rectangle>();
  80             ReadRectangle( rIStm, *rImplWallpaper.mpRect );
  81         }
  82
  83         if( bGrad )
  84         {
  85             rImplWallpaper.mpGradient = o3tl::make_unique<Gradient>();
  86             ReadGradient( rIStm, *rImplWallpaper.mpGradient );
  87         }
  88
  89         if( bBmp )
  90         {
  91             rImplWallpaper.mpBitmap = o3tl::make_unique<BitmapEx>();
  92             ReadDIBBitmapEx(*rImplWallpaper.mpBitmap, rIStm);
  93         }
  94
  95         // version 3 (new color format)
  96         if( aCompat.GetVersion() >= 3 )
  97         {
  98             rImplWallpaper.maColor.Read( rIStm );
  99         }
 100     }
 101
 102     return rIStm;
 103 }
 104
 105 SvStream& WriteImplWallpaper( SvStream& rOStm, const ImplWallpaper& rImplWallpaper )
 106 {
 107     VersionCompat   aCompat( rOStm, StreamMode::WRITE, 3 );
 108     bool            bRect = bool(rImplWallpaper.mpRect);
 109     bool            bGrad = bool(rImplWallpaper.mpGradient);
 110     bool            bBmp = bool(rImplWallpaper.mpBitmap);
 111     bool            bDummy = false;
 112
 113     // version 1
 114     WriteColor( rOStm, rImplWallpaper.maColor );
 115     rOStm.WriteUInt16( static_cast<sal_uInt16>(rImplWallpaper.meStyle) );
 116
 117     // version 2
 118     rOStm.WriteBool( bRect ).WriteBool( bGrad ).WriteBool( bBmp ).WriteBool( bDummy ).WriteBool( bDummy ).WriteBool( bDummy );
 119
 120     if( bRect )
 121         WriteRectangle( rOStm, *rImplWallpaper.mpRect );
 122
 123     if( bGrad )
 124         WriteGradient( rOStm, *rImplWallpaper.mpGradient );
 125
 126     if( bBmp )
 127         WriteDIBBitmapEx(*rImplWallpaper.mpBitmap, rOStm);
 128
 129     // version 3 (new color format)
 130     ( (Color&) rImplWallpaper.maColor ).Write( rOStm );
 131
 132     return rOStm;
 133 }
 134
 135 namespace
 136 {
 137     struct theGlobalDefault :
 138         public rtl::Static< Wallpaper::ImplType, theGlobalDefault > {};
 139 }
 140
 141 Wallpaper::Wallpaper() : mpImplWallpaper(theGlobalDefault::get())
 142 {
 143 }
 144
 145 Wallpaper::Wallpaper( const Wallpaper& rWallpaper )
 146     : mpImplWallpaper( rWallpaper.mpImplWallpaper)
 147 {
 148 }
 149
 150 Wallpaper::Wallpaper( Wallpaper&& rWallpaper )
 151     : mpImplWallpaper( std::move(rWallpaper.mpImplWallpaper) )
 152 {
 153 }
 154
 155 Wallpaper::Wallpaper( const Color& rColor ) : mpImplWallpaper()
 156 {
 157     mpImplWallpaper->maColor    = rColor;
 158     mpImplWallpaper->meStyle    = WallpaperStyle::Tile;
 159 }
 160
 161 Wallpaper::Wallpaper( const BitmapEx& rBmpEx ) : mpImplWallpaper()
 162 {
 163     mpImplWallpaper->mpBitmap   = o3tl::make_unique<BitmapEx>( rBmpEx );
 164     mpImplWallpaper->meStyle    = WallpaperStyle::Tile;
 165 }
 166
 167 Wallpaper::Wallpaper( const Gradient& rGradient ) : mpImplWallpaper()
 168 {
 169     mpImplWallpaper->mpGradient = o3tl::make_unique<Gradient>( rGradient );
 170     mpImplWallpaper->meStyle    = WallpaperStyle::Tile;
 171 }
 172
 173 Wallpaper::~Wallpaper()
 174 {
 175 }
 176
 177 void Wallpaper::ImplSetCachedBitmap( BitmapEx& rBmp ) const
 178 {
 179    if( !mpImplWallpaper->mpCache )
 180       const_cast< ImplWallpaper* >(mpImplWallpaper.get())->mpCache = o3tl::make_unique<BitmapEx>( rBmp );
 181    else
 182       *const_cast< ImplWallpaper* >(mpImplWallpaper.get())->mpCache = rBmp;
 183 }
 184
 185 const BitmapEx* Wallpaper::ImplGetCachedBitmap() const
 186 {
 187     return mpImplWallpaper->mpCache.get();
 188 }
 189
 190 void Wallpaper::ImplReleaseCachedBitmap() const
 191 {
 192     const_cast< ImplWallpaper* >(mpImplWallpaper.get())->mpCache.reset();
 193 }
 194
 195 void Wallpaper::SetColor( const Color& rColor )
 196 {
 197     ImplReleaseCachedBitmap();
 198     mpImplWallpaper->maColor = rColor;
 199
 200     if( WallpaperStyle::NONE == mpImplWallpaper->meStyle || WallpaperStyle::ApplicationGradient == mpImplWallpaper->meStyle )
 201         mpImplWallpaper->meStyle = WallpaperStyle::Tile;
 202 }
 203
 204 const Color& Wallpaper::GetColor() const
 205 {
 206     return mpImplWallpaper->maColor;
 207 }
 208
 209 void Wallpaper::SetStyle( WallpaperStyle eStyle )
 210 {
 211     if( eStyle == WallpaperStyle::ApplicationGradient )
 212         // set a dummy gradient, the correct gradient
 213         // will be created dynamically in GetGradient()
 214         SetGradient( ImplGetApplicationGradient() );
 215
 216     mpImplWallpaper->meStyle = eStyle;
 217 }
 218
 219 WallpaperStyle Wallpaper::GetStyle() const
 220 {
 221     return mpImplWallpaper->meStyle;
 222 }
 223
 224 void Wallpaper::SetBitmap( const BitmapEx& rBitmap )
 225 {
 226     if ( !rBitmap )
 227     {
 228         if ( mpImplWallpaper->mpBitmap )
 229         {
 230             ImplReleaseCachedBitmap();
 231             mpImplWallpaper->mpBitmap.reset();
 232         }
 233     }
 234     else
 235     {
 236         ImplReleaseCachedBitmap();
 237         if ( mpImplWallpaper->mpBitmap )
 238             *(mpImplWallpaper->mpBitmap) = rBitmap;
 239         else
 240             mpImplWallpaper->mpBitmap = o3tl::make_unique<BitmapEx>( rBitmap );
 241     }
 242
 243     if( WallpaperStyle::NONE == mpImplWallpaper->meStyle || WallpaperStyle::ApplicationGradient == mpImplWallpaper->meStyle)
 244         mpImplWallpaper->meStyle = WallpaperStyle::Tile;
 245 }
 246
 247 BitmapEx Wallpaper::GetBitmap() const
 248 {
 249     if ( mpImplWallpaper->mpBitmap )
 250         return *(mpImplWallpaper->mpBitmap);
 251     else
 252         return BitmapEx();
 253 }
 254
 255 bool Wallpaper::IsBitmap() const
 256 {
 257     return bool(mpImplWallpaper->mpBitmap);
 258 }
 259
 260 void Wallpaper::SetGradient( const Gradient& rGradient )
 261 {
 262     ImplReleaseCachedBitmap();
 263
 264     if ( mpImplWallpaper->mpGradient )
 265         *(mpImplWallpaper->mpGradient) = rGradient;
 266     else
 267         mpImplWallpaper->mpGradient = o3tl::make_unique<Gradient>( rGradient );
 268
 269     if( WallpaperStyle::NONE == mpImplWallpaper->meStyle || WallpaperStyle::ApplicationGradient == mpImplWallpaper->meStyle )
 270         mpImplWallpaper->meStyle = WallpaperStyle::Tile;
 271 }
 272
 273 Gradient Wallpaper::GetGradient() const
 274 {
 275     if( WallpaperStyle::ApplicationGradient == mpImplWallpaper->meStyle )
 276         return ImplGetApplicationGradient();
 277     else if ( mpImplWallpaper->mpGradient )
 278         return *(mpImplWallpaper->mpGradient);
 279     else
 280         return Gradient();
 281 }
 282
 283 bool Wallpaper::IsGradient() const
 284 {
 285     return bool(mpImplWallpaper->mpGradient);
 286 }
 287
 288 Gradient Wallpaper::ImplGetApplicationGradient()
 289 {
 290     Gradient g;
 291     g.SetAngle( 900 );
 292     g.SetStyle( GradientStyle::Linear );
 293     g.SetStartColor( Application::GetSettings().GetStyleSettings().GetFaceColor() );
 294     // no 'extreme' gradient when high contrast
 295     if( Application::GetSettings().GetStyleSettings().GetHighContrastMode() )
 296         g.SetEndColor( Application::GetSettings().GetStyleSettings().GetFaceColor() );
 297     else
 298         g.SetEndColor( Application::GetSettings().GetStyleSettings().GetFaceGradientColor() );
 299     return g;
 300 }
 301
 302 void Wallpaper::SetRect( const tools::Rectangle& rRect )
 303 {
 304     if ( rRect.IsEmpty() )
 305     {
 306         mpImplWallpaper->mpRect.reset();
 307     }
 308     else
 309     {
 310         if ( mpImplWallpaper->mpRect )
 311             *(mpImplWallpaper->mpRect) = rRect;
 312         else
 313             mpImplWallpaper->mpRect = o3tl::make_unique<tools::Rectangle>( rRect );
 314     }
 315 }
 316
 317 tools::Rectangle Wallpaper::GetRect() const
 318 {
 319     if ( mpImplWallpaper->mpRect )
 320         return *(mpImplWallpaper->mpRect);
 321     else
 322         return tools::Rectangle();
 323 }
 324
 325 bool Wallpaper::IsRect() const
 326 {
 327     return bool(mpImplWallpaper->mpRect);
 328 }
 329
 330 bool Wallpaper::IsFixed() const
 331 {
 332     if ( mpImplWallpaper->meStyle == WallpaperStyle::NONE )
 333         return false;
 334     else
 335         return (!mpImplWallpaper->mpBitmap && !mpImplWallpaper->mpGradient);
 336 }
 337
 338 bool Wallpaper::IsScrollable() const
 339 {
 340     if ( mpImplWallpaper->meStyle == WallpaperStyle::NONE )
 341         return false;
 342     else if ( !mpImplWallpaper->mpBitmap && !mpImplWallpaper->mpGradient )
 343         return true;
 344     else if ( mpImplWallpaper->mpBitmap )
 345         return (mpImplWallpaper->meStyle == WallpaperStyle::Tile);
 346     else
 347         return false;
 348 }
 349
 350 Wallpaper& Wallpaper::operator=( const Wallpaper& rWallpaper )
 351 {
 352     mpImplWallpaper = rWallpaper.mpImplWallpaper;
 353     return *this;
 354 }
 355
 356 Wallpaper& Wallpaper::operator=( Wallpaper&& rWallpaper )
 357 {
 358     mpImplWallpaper = std::move(rWallpaper.mpImplWallpaper);
 359     return *this;
 360 }
 361
 362 bool Wallpaper::operator==( const Wallpaper& rWallpaper ) const
 363 {
 364     return mpImplWallpaper.same_object(rWallpaper.mpImplWallpaper);
 365 }
 366
 367 SvStream& ReadWallpaper( SvStream& rIStm, Wallpaper& rWallpaper )
 368 {
 369     return ReadImplWallpaper( rIStm, *rWallpaper.mpImplWallpaper );
 370 }
 371
 372 SvStream& WriteWallpaper( SvStream& rOStm, const Wallpaper& rWallpaper )
 373 {
 374     return WriteImplWallpaper( rOStm, *rWallpaper.mpImplWallpaper );
 375 }
 376
 377 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */