LibreOffice Module vcl (master)  1
prgsbar.hxx
Go to the documentation of this file.
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 #if !defined(VCL_DLLIMPLEMENTATION) && !defined(TOOLKIT_DLLIMPLEMENTATION) && !defined(VCL_INTERNALS)
24 #error "don't use this in new code"
25 #endif
26 
27 #include <config_options.h>
28 #include <vcl/dllapi.h>
29 #include <vcl/window.hxx>
30 
31 /*************************************************************************
32  *
33  * class ProgressBar
34  *
35  * this class is used to display the ProgressBar
36  *
37  * -----------------------------------------------------------------------
38  *
39  * WinBits
40  *
41  * WB_BORDER border around the window
42  * WB_3DLOOK 3D representation
43  *
44  * -----------------------------------------------------------------------
45  *
46  * Methods
47  *
48  * Use SetValue() to set a percentage between 0 and 100. A value larger
49  * than 100 will cause the last rectangle to start flashing
50  *
51  ************************************************************************/
52 
53 
54 class UNLESS_MERGELIBS(VCL_DLLPUBLIC) ProgressBar final : public vcl::Window
55 {
56 private:
57  Point maPos;
58  long mnPrgsWidth;
59  long mnPrgsHeight;
60  sal_uInt16 mnPercent;
61  sal_uInt16 mnPercentCount;
62  bool mbCalcNew;
63 
64  using Window::ImplInit;
65  SAL_DLLPRIVATE void ImplInit();
66  SAL_DLLPRIVATE void ImplInitSettings( bool bFont, bool bForeground, bool bBackground );
67  SAL_DLLPRIVATE void ImplDrawProgress(vcl::RenderContext& rRenderContext, sal_uInt16 nNewPerc);
68 
69 public:
70  ProgressBar( vcl::Window* pParent, WinBits nWinBits );
71 
72  virtual void Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
73  virtual void Resize() override;
74  virtual void StateChanged( StateChangedType nStateChange ) override;
75  virtual void DataChanged( const DataChangedEvent& rDCEvt ) override;
76  virtual Size GetOptimalSize() const override;
77 
78  void SetValue( sal_uInt16 nNewPercent );
79 };
80 
81 #endif // INCLUDED_VCL_PRGSBAR_HXX
82 
83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual Size GetOptimalSize() const
Definition: window3.cxx:33
StateChangedType
Definition: window.hxx:310
sal_Int64 WinBits
Some things multiple-inherit from VclAbstractDialog and OutputDevice, so we need to use virtual inher...
Definition: outdev.hxx:302
virtual void Resize()
Definition: window.cxx:1830
SAL_DLLPRIVATE void ImplInit(vcl::Window *pParent, WinBits nStyle, SystemParentData *pSystemParentData)
Definition: window.cxx:936
virtual void Paint(vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect)
Definition: paint.cxx:1019
virtual void StateChanged(StateChangedType nStateChange)
Definition: window.cxx:1935
virtual void DataChanged(const DataChangedEvent &rDCEvt)
Definition: event.cxx:35