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