| // Copyright (c) 2006-2008 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. |
| |
| // Throbbers display an animation, usually used as a status indicator. |
| |
| #ifndef CHROME_VIEWS_THROBBER_H__ |
| #define CHROME_VIEWS_THROBBER_H__ |
| |
| #include "base/basictypes.h" |
| #include "base/timer.h" |
| #include "chrome/views/view.h" |
| |
| class SkBitmap; |
| |
| namespace views { |
| |
| class 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); |
| virtual ~Throbber(); |
| |
| // Start and stop the throbber animation |
| virtual void Start(); |
| virtual void Stop(); |
| |
| // overridden from View |
| virtual gfx::Size GetPreferredSize(); |
| virtual void Paint(ChromeCanvas* canvas); |
| |
| protected: |
| // Specifies whether the throbber is currently animating or not |
| bool running_; |
| |
| private: |
| void Run(); |
| |
| bool paint_while_stopped_; |
| int frame_count_; |
| int last_frame_drawn_; |
| DWORD start_time_; |
| DWORD last_time_recorded_; |
| SkBitmap* frames_; |
| int frame_time_ms_; |
| base::RepeatingTimer<Throbber> timer_; |
| |
| DISALLOW_EVIL_CONSTRUCTORS(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 SmoothedThrobber : public Throbber { |
| public: |
| SmoothedThrobber(int frame_delay_ms); |
| |
| virtual void Start(); |
| virtual void Stop(); |
| |
| 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(); |
| |
| base::OneShotTimer<SmoothedThrobber> start_timer_; |
| base::OneShotTimer<SmoothedThrobber> stop_timer_; |
| |
| DISALLOW_EVIL_CONSTRUCTORS(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 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: |
| virtual void Paint(ChromeCanvas* canvas); |
| |
| private: |
| static const int kFrameTimeMs = 30; |
| |
| static void InitClass(); |
| |
| // Whether or not we should display a checkmark. |
| bool checked_; |
| |
| // The checkmark image. |
| static SkBitmap* checkmark_; |
| |
| DISALLOW_EVIL_CONSTRUCTORS(CheckmarkThrobber); |
| }; |
| |
| } // namespace views |
| |
| #endif // CHROME_VIEWS_THROBBER_H__ |
| |