include/vcl/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 #ifndef INCLUDED_VCL_PRGSBAR_HXX
  21 #define INCLUDED_VCL_PRGSBAR_HXX
  22
  23 #include <vcl/dllapi.h>
  24 #include <vcl/window.hxx>
  25
  26 /*************************************************************************
  27  *
  28  * class ProgressBar
  29  *
  30  * this class is used to display the ProgressBar
  31  *
  32  * -----------------------------------------------------------------------
  33  *
  34  * WinBits
  35  *
  36  * WB_BORDER           border around the window
  37  * WB_3DLOOK           3D representation
  38  *
  39  * -----------------------------------------------------------------------
  40  *
  41  * Methods
  42  *
  43  * Use SetValue() to set a percentage between 0 and 100. A value larger
  44  * than 100 will cause the last rectangle to start flashing
  45  *
  46  ************************************************************************/
  47
  48
  49 class VCL_DLLPUBLIC ProgressBar : public vcl::Window
  50 {
  51 private:
  52     Point               maPos;
  53     long                mnPrgsWidth;
  54     long                mnPrgsHeight;
  55     sal_uInt16          mnPercent;
  56     sal_uInt16          mnPercentCount;
  57     sal_uInt16          mnPreviousPercent;
  58     bool                mbCalcNew;
  59
  60     using Window::ImplInit;
  61     SAL_DLLPRIVATE void             ImplInit();
  62     SAL_DLLPRIVATE void             ImplInitSettings( bool bFont, bool bForeground, bool bBackground );
  63     SAL_DLLPRIVATE void ImplDrawProgress(vcl::RenderContext& rRenderContext, sal_uInt16 nOldPerc, sal_uInt16 nNewPerc);
  64
  65 public:
  66                         ProgressBar( vcl::Window* pParent, WinBits nWinBits );
  67
  68     virtual void        Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
  69     virtual void        Resize() override;
  70     virtual void        StateChanged( StateChangedType nStateChange ) override;
  71     virtual void        DataChanged( const DataChangedEvent& rDCEvt ) override;
  72     virtual Size        GetOptimalSize() const override;
  73
  74     void                SetValue( sal_uInt16 nNewPercent );
  75 };
  76
  77 #endif // INCLUDED_VCL_PRGSBAR_HXX
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */