include/vcl/toolkit/prgsbar.hxx

   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 #pragma once
  21
  22 #if !defined(VCL_DLLIMPLEMENTATION) && !defined(TOOLKIT_DLLIMPLEMENTATION) && !defined(VCL_INTERNALS)
  23 #error "don't use this in new code"
  24 #endif
  25
  26 #include <config_options.h>
  27 #include <vcl/dllapi.h>
  28 #include <vcl/window.hxx>
  29
  30 /*************************************************************************
  31  *
  32  * class ProgressBar
  33  *
  34  * this class is used to display the ProgressBar
  35  *
  36  * -----------------------------------------------------------------------
  37  *
  38  * WinBits
  39  *
  40  * WB_BORDER           border around the window
  41  * WB_3DLOOK           3D representation
  42  *
  43  * -----------------------------------------------------------------------
  44  *
  45  * Methods
  46  *
  47  * Use SetValue() to set a percentage between 0 and 100. A value larger
  48  * than 100 will cause the last rectangle to start flashing
  49  *
  50  ************************************************************************/
  51
  52
  53 class UNLESS_MERGELIBS(VCL_DLLPUBLIC) ProgressBar final : public vcl::Window
  54 {
  55 public:
  56     enum class BarStyle
  57     {
  58         Progress,
  59         Level,
  60     };
  61
  62 private:
  63     Point               maPos;
  64     tools::Long                mnPrgsWidth;
  65     tools::Long                mnPrgsHeight;
  66     sal_uInt16          mnPercent;
  67     sal_uInt16          mnPercentCount;
  68     bool                mbCalcNew;
  69     BarStyle            meBarStyle;
  70
  71     using Window::ImplInit;
  72     SAL_DLLPRIVATE void             ImplInit();
  73     SAL_DLLPRIVATE void             ImplInitSettings( bool bFont, bool bForeground, bool bBackground );
  74     SAL_DLLPRIVATE void ImplDrawProgress(vcl::RenderContext& rRenderContext, sal_uInt16 nNewPerc);
  75
  76 protected:
  77     virtual void        DumpAsPropertyTree(tools::JsonWriter&) override;
  78
  79 public:
  80                         ProgressBar( vcl::Window* pParent, WinBits nWinBits, BarStyle eBarStyle );
  81
  82     virtual void        Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
  83     virtual void        Resize() override;
  84     virtual void        StateChanged( StateChangedType nStateChange ) override;
  85     virtual void        DataChanged( const DataChangedEvent& rDCEvt ) override;
  86     virtual Size        GetOptimalSize() const override;
  87
  88     void                SetValue( sal_uInt16 nNewPercent );
  89 };
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */