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 _PRGSBAR_HXX
  21 #define _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  * Methodes
  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 // - WinBits -
  50 // -----------
  51
  52 #define WB_STDPROGRESSBAR       WB_BORDER
  53
  54 // ---------------
  55 // - ProgressBar -
  56 // ---------------
  57
  58 class VCL_DLLPUBLIC ProgressBar : public Window
  59 {
  60 private:
  61     Point               maPos;
  62     long                mnPrgsWidth;
  63     long                mnPrgsHeight;
  64     sal_uInt16              mnPercent;
  65     sal_uInt16              mnPercentCount;
  66     sal_Bool                mbCalcNew;
  67
  68     using Window::ImplInit;
  69     SAL_DLLPRIVATE void             ImplInit();
  70     SAL_DLLPRIVATE void             ImplInitSettings( sal_Bool bFont, sal_Bool bForeground, sal_Bool bBackground );
  71     SAL_DLLPRIVATE void             ImplDrawProgress( sal_uInt16 nOldPerc, sal_uInt16 nNewPerc );
  72
  73 public:
  74                         ProgressBar( Window* pParent, WinBits nWinBits = WB_STDPROGRESSBAR );
  75                         ProgressBar( Window* pParent, const ResId& rResId );
  76                         ~ProgressBar();
  77
  78     virtual void        Paint( const Rectangle& rRect );
  79     virtual void        Resize();
  80     virtual void        StateChanged( StateChangedType nStateChange );
  81     virtual void        DataChanged( const DataChangedEvent& rDCEvt );
  82
  83     void                SetValue( sal_uInt16 nNewPercent );
  84     sal_uInt16              GetValue() const { return mnPercent; }
  85 };
  86
  87 #endif  // _PRGSBAR_HXX
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */