1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef UI_VIEWS_CONTROLS_THROBBER_H_
#define UI_VIEWS_CONTROLS_THROBBER_H_
#include "base/basictypes.h"
#include "base/compiler_specific.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
#include "ui/views/view.h"
namespace gfx {
class ImageSkia;
}
namespace views {
// Throbbers display an animation, usually used as a status indicator.
class VIEWS_EXPORT Throbber : public View {
public:
// |frame_time_ms| is the amount of time that should elapse between frames
// (in milliseconds)
// If |paint_while_stopped| is false, this view will be invisible when not
// running.
Throbber(int frame_time_ms, bool paint_while_stopped);
Throbber(int frame_time_ms, bool paint_while_stopped, gfx::ImageSkia* frames);
~Throbber() override;
// Start and stop the throbber animation
virtual void Start();
virtual void Stop();
// Set custom throbber frames. Otherwise IDR_THROBBER is loaded.
void SetFrames(const gfx::ImageSkia* frames);
// Overridden from View:
gfx::Size GetPreferredSize() const override;
void OnPaint(gfx::Canvas* canvas) override;
protected:
// Specifies whether the throbber is currently animating or not
bool running_;
private:
void Run();
bool paint_while_stopped_;
int frame_count_; // How many frames we have.
base::Time start_time_; // Time when Start was called.
const gfx::ImageSkia* frames_; // Frames images.
base::TimeDelta frame_time_; // How long one frame is displayed.
base::RepeatingTimer<Throbber> timer_; // Used to schedule Run calls.
DISALLOW_COPY_AND_ASSIGN(Throbber);
};
// A SmoothedThrobber is a throbber that is representing potentially short
// and nonoverlapping bursts of work. SmoothedThrobber ignores small
// pauses in the work stops and starts, and only starts its throbber after
// a small amount of work time has passed.
class VIEWS_EXPORT SmoothedThrobber : public Throbber {
public:
explicit SmoothedThrobber(int frame_delay_ms);
SmoothedThrobber(int frame_delay_ms, gfx::ImageSkia* frames);
~SmoothedThrobber() override;
void Start() override;
void Stop() override;
void set_start_delay_ms(int value) { start_delay_ms_ = value; }
void set_stop_delay_ms(int value) { stop_delay_ms_ = value; }
private:
// Called when the startup-delay timer fires
// This function starts the actual throbbing.
void StartDelayOver();
// Called when the shutdown-delay timer fires.
// This function stops the actual throbbing.
void StopDelayOver();
// Delay after work starts before starting throbber, in milliseconds.
int start_delay_ms_;
// Delay after work stops before stopping, in milliseconds.
int stop_delay_ms_;
base::OneShotTimer<SmoothedThrobber> start_timer_;
base::OneShotTimer<SmoothedThrobber> stop_timer_;
DISALLOW_COPY_AND_ASSIGN(SmoothedThrobber);
};
// A CheckmarkThrobber is a special variant of throbber that has three states:
// 1. not yet completed (which paints nothing)
// 2. working (which paints the throbber animation)
// 3. completed (which paints a checkmark)
//
class VIEWS_EXPORT CheckmarkThrobber : public Throbber {
public:
CheckmarkThrobber();
// If checked is true, the throbber stops spinning and displays a checkmark.
// If checked is false, the throbber stops spinning and displays nothing.
void SetChecked(bool checked);
// Overridden from Throbber:
void OnPaint(gfx::Canvas* canvas) override;
private:
static const int kFrameTimeMs = 30;
// Whether or not we should display a checkmark.
bool checked_;
// The checkmark image.
const gfx::ImageSkia* checkmark_;
DISALLOW_COPY_AND_ASSIGN(CheckmarkThrobber);
};
} // namespace views
#endif // UI_VIEWS_CONTROLS_THROBBER_H_
|
