Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <LibGUI/Frame.h>
30
31namespace GUI {
32
33class ProgressBar : public Frame {
34 C_OBJECT(ProgressBar)
35public:
36 virtual ~ProgressBar() override;
37
38 void set_range(int min, int max);
39 void set_min(int min) { set_range(min, max()); }
40 void set_max(int max) { set_range(min(), max); }
41 void set_value(int);
42
43 int value() const { return m_value; }
44 int min() const { return m_min; }
45 int max() const { return m_max; }
46
47 String caption() const { return m_caption; }
48 void set_caption(const StringView& caption) { m_caption = caption; }
49
50 enum Format {
51 NoText,
52 Percentage,
53 ValueSlashMax
54 };
55 Format format() const { return m_format; }
56 void set_format(Format format) { m_format = format; }
57
58protected:
59 ProgressBar();
60
61 virtual void paint_event(PaintEvent&) override;
62
63private:
64 Format m_format { Percentage };
65 int m_min { 0 };
66 int m_max { 100 };
67 int m_value { 0 };
68 String m_caption;
69};
70
71}