vcl/source/control/prgsbar.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 <vcl/event.hxx>
  21 #include <vcl/status.hxx>
  22 #include <vcl/toolkit/prgsbar.hxx>
  23 #include <vcl/settings.hxx>
  24 #include <sal/log.hxx>
  25 #include <vcl/svapp.hxx>
  26 #include <vcl/idle.hxx>
  27 #include <tools/json_writer.hxx>
  28
  29 #define PROGRESSBAR_OFFSET          3
  30 #define PROGRESSBAR_WIN_OFFSET      2
  31
  32 void ProgressBar::ImplInit()
  33 {
  34     mnPrgsWidth = 0;
  35     mnPrgsHeight = 0;
  36     mnPercent = 0;
  37     mnPercentCount = 0;
  38     mbCalcNew = true;
  39     SetType(WindowType::PROGRESSBAR);
  40
  41     ImplInitSettings( true, true, true );
  42 }
  43
  44 static WinBits clearProgressBarBorder( vcl::Window const * pParent, WinBits nOrgStyle, ProgressBar::BarStyle eBarStyle )
  45 {
  46     WinBits nOutStyle = nOrgStyle;
  47     if( pParent && (nOrgStyle & WB_BORDER) != 0 )
  48     {
  49         if (pParent->IsNativeControlSupported(eBarStyle == ProgressBar::BarStyle::Progress
  50                                                   ? ControlType::Progress
  51                                                   : ControlType::LevelBar,
  52                                               ControlPart::Entire))
  53             nOutStyle &= WB_BORDER;
  54     }
  55     return nOutStyle;
  56 }
  57
  58 Size ProgressBar::GetOptimalSize() const
  59 {
  60     return meBarStyle == BarStyle::Progress ? Size(150, 20) : Size(150,10);
  61 }
  62
  63 ProgressBar::ProgressBar( vcl::Window* pParent, WinBits nWinStyle, BarStyle eBarStyle ) :
  64         Window( pParent, clearProgressBarBorder( pParent, nWinStyle, eBarStyle ) ),
  65         meBarStyle(eBarStyle)
  66 {
  67     SetOutputSizePixel( GetOptimalSize() );
  68     ImplInit();
  69 }
  70
  71 void ProgressBar::ImplInitSettings( bool bFont,
  72                                     bool bForeground, bool bBackground )
  73 {
  74     const StyleSettings& rStyleSettings = GetSettings().GetStyleSettings();
  75
  76 /* FIXME: !!! We do not support text output at the moment
  77     if ( bFont )
  78         ApplyControlFont(*this, rStyleSettings.GetAppFont());
  79 */
  80
  81     if ( bBackground )
  82     {
  83         if (!IsControlBackground()
  84             && IsNativeControlSupported(meBarStyle == BarStyle::Progress ? ControlType::Progress
  85                                                                          : ControlType::LevelBar,
  86                                         ControlPart::Entire))
  87         {
  88             if( GetStyle() & WB_BORDER )
  89                 SetBorderStyle( WindowBorderStyle::REMOVEBORDER );
  90             EnableChildTransparentMode();
  91             SetPaintTransparent( true );
  92             SetBackground();
  93             SetParentClipMode( ParentClipMode::NoClip );
  94         }
  95         else
  96         {
  97             Color aColor;
  98             if ( IsControlBackground() )
  99                 aColor = GetControlBackground();
 100             else
 101                 aColor = rStyleSettings.GetFaceColor();
 102             SetBackground( aColor );
 103         }
 104     }
 105
 106     if ( !(bForeground || bFont) )
 107         return;
 108
 109     Color aColor = rStyleSettings.GetHighlightColor();
 110     if ( IsControlForeground() )
 111         aColor = GetControlForeground();
 112     if ( aColor.IsRGBEqual( GetBackground().GetColor() ) )
 113     {
 114         if ( aColor.GetLuminance() > 100 )
 115             aColor.DecreaseLuminance( 64 );
 116         else
 117             aColor.IncreaseLuminance( 64 );
 118     }
 119     GetOutDev()->SetLineColor();
 120     GetOutDev()->SetFillColor( aColor );
 121 /* FIXME: !!! We do not support text output at the moment
 122     SetTextColor( aColor );
 123     SetTextFillColor();
 124 */
 125 }
 126
 127 void ProgressBar::ImplDrawProgress(vcl::RenderContext& rRenderContext, sal_uInt16 nNewPerc)
 128 {
 129     if (mbCalcNew)
 130     {
 131         mbCalcNew = false;
 132
 133         Size aSize(GetOutputSizePixel());
 134         mnPrgsHeight = aSize.Height() - (PROGRESSBAR_WIN_OFFSET * 2);
 135         mnPrgsWidth = (mnPrgsHeight * 2) / 3;
 136         maPos.setY( PROGRESSBAR_WIN_OFFSET );
 137         tools::Long nMaxWidth = aSize.Width() - (PROGRESSBAR_WIN_OFFSET * 2) + PROGRESSBAR_OFFSET;
 138         sal_uInt16 nMaxCount = static_cast<sal_uInt16>(nMaxWidth / (mnPrgsWidth+PROGRESSBAR_OFFSET));
 139         if (nMaxCount <= 1)
 140         {
 141             nMaxCount = 1;
 142         }
 143         else
 144         {
 145             while (((10000 / (10000 / nMaxCount)) * (mnPrgsWidth + PROGRESSBAR_OFFSET)) > nMaxWidth)
 146             {
 147                 nMaxCount--;
 148             }
 149         }
 150         mnPercentCount = 10000 / nMaxCount;
 151         nMaxWidth = ((10000 / (10000 / nMaxCount)) * (mnPrgsWidth + PROGRESSBAR_OFFSET)) - PROGRESSBAR_OFFSET;
 152         maPos.setX( (aSize.Width() - nMaxWidth) / 2 );
 153     }
 154
 155     ::DrawProgress(
 156         this, rRenderContext, maPos, PROGRESSBAR_OFFSET, mnPrgsWidth, mnPrgsHeight,
 157         /*nPercent1=*/0, nNewPerc * 100, mnPercentCount, tools::Rectangle(Point(), GetSizePixel()),
 158         meBarStyle == BarStyle::Progress ? ControlType::Progress : ControlType::LevelBar);
 159 }
 160
 161 void ProgressBar::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& /*rRect*/)
 162 {
 163     ImplDrawProgress(rRenderContext, mnPercent);
 164 }
 165
 166 void ProgressBar::Resize()
 167 {
 168     mbCalcNew = true;
 169     if ( IsReallyVisible() )
 170         Invalidate();
 171 }
 172
 173 void ProgressBar::SetValue( sal_uInt16 nNewPercent )
 174 {
 175     SAL_WARN_IF( nNewPercent > 100, "vcl", "StatusBar::SetProgressValue(): nPercent > 100" );
 176
 177     if ( nNewPercent < mnPercent )
 178     {
 179         mbCalcNew = true;
 180         mnPercent = nNewPercent;
 181         if ( IsReallyVisible() )
 182         {
 183             Invalidate();
 184             PaintImmediately();
 185         }
 186     }
 187     else if ( mnPercent != nNewPercent )
 188     {
 189         mnPercent = nNewPercent;
 190         Invalidate();
 191
 192         // Make sure the progressbar is actually painted even if the caller is busy with its task,
 193         // so the main loop would not be invoked.
 194         Idle aIdle("ProgressBar::SetValue aIdle");
 195         aIdle.SetPriority(TaskPriority::POST_PAINT);
 196         aIdle.Start();
 197         while (aIdle.IsActive() && !Application::IsQuit())
 198         {
 199             Application::Yield();
 200         }
 201     }
 202 }
 203
 204 void ProgressBar::StateChanged( StateChangedType nType )
 205 {
 206 /* FIXME: !!! We do not support text output at the moment
 207     if ( (nType == StateChangedType::Zoom) ||
 208          (nType == StateChangedType::ControlFont) )
 209     {
 210         ImplInitSettings( true, false, false );
 211         Invalidate();
 212     }
 213     else
 214 */
 215     if ( nType == StateChangedType::ControlForeground )
 216     {
 217         ImplInitSettings( false, true, false );
 218         Invalidate();
 219     }
 220     else if ( nType == StateChangedType::ControlBackground )
 221     {
 222         ImplInitSettings( false, false, true );
 223         Invalidate();
 224     }
 225
 226     Window::StateChanged( nType );
 227 }
 228
 229 void ProgressBar::DataChanged( const DataChangedEvent& rDCEvt )
 230 {
 231     if ( (rDCEvt.GetType() == DataChangedEventType::SETTINGS) &&
 232          (rDCEvt.GetFlags() & AllSettingsFlags::STYLE) )
 233     {
 234         ImplInitSettings( true, true, true );
 235         Invalidate();
 236     }
 237
 238     Window::DataChanged( rDCEvt );
 239 }
 240
 241 void ProgressBar::DumpAsPropertyTree(tools::JsonWriter& rJsonWriter)
 242 {
 243     vcl::Window::DumpAsPropertyTree(rJsonWriter);
 244     rJsonWriter.put("value", mnPercent);
 245 }
 246
 247 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */