| // Copyright (c) 2011 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. |
| // |
| // A helper class for animating the display of native widget content. |
| // Currently only handle vertical sliding, but could be extended to handle |
| // horizontal slides or other types of animations. |
| // |
| // NOTE: This does not handle clipping. If you are not careful, you will |
| // wind up with visibly overlapping widgets. If you need clipping, you can |
| // extend the constructor to take an option to give |fixed| its own GdkWindow |
| // (via gtk_fixed_set_has_window). |
| |
| #ifndef CHROME_BROWSER_UI_GTK_SLIDE_ANIMATOR_GTK_H_ |
| #define CHROME_BROWSER_UI_GTK_SLIDE_ANIMATOR_GTK_H_ |
| |
| #include <gtk/gtk.h> |
| |
| #include "base/compiler_specific.h" |
| #include "base/memory/scoped_ptr.h" |
| #include "ui/base/gtk/owned_widget_gtk.h" |
| #include "ui/gfx/animation/animation_delegate.h" |
| |
| namespace gfx { |
| class SlideAnimation; |
| } |
| |
| class SlideAnimatorGtk : public gfx::AnimationDelegate { |
| public: |
| class Delegate { |
| public: |
| // Called when a call to Close() finishes animating. |
| virtual void Closed() = 0; |
| |
| protected: |
| virtual ~Delegate() {} |
| }; |
| |
| enum Direction { |
| DOWN, |
| UP |
| }; |
| |
| // |child| is the widget we pack into |widget_|. |
| // |direction| indicates which side the contents will appear to come from. |
| // |duration| is the duration of the slide in milliseconds, or 0 for default. |
| // |linear| controls how the animation progresses. If true, the |
| // velocity of the slide is constant over time, otherwise it goes a bit faster |
| // at the beginning and slows to a halt. |
| // |delegate| may be NULL. |
| SlideAnimatorGtk(GtkWidget* child, |
| Direction direction, |
| int duration, |
| bool linear, |
| bool control_child_size, |
| Delegate* delegate); |
| |
| virtual ~SlideAnimatorGtk(); |
| |
| GtkWidget* widget() { return widget_.get(); } |
| |
| // Slide open. |
| void Open(); |
| |
| // Immediately show the widget. |
| void OpenWithoutAnimation(); |
| |
| // Slide shut. |
| void Close(); |
| |
| // End the current animation. |
| void End(); |
| |
| // Immediately hide the widget. |
| void CloseWithoutAnimation(); |
| |
| // Returns whether the widget is visible. |
| bool IsShowing(); |
| |
| // Returns whether the widget is currently showing the close animation. |
| bool IsClosing(); |
| |
| // Returns whether the widget is currently showing the open or close |
| // animation. |
| bool IsAnimating(); |
| |
| // gfx::AnimationDelegate implementation. |
| virtual void AnimationProgressed(const gfx::Animation* animation) OVERRIDE; |
| virtual void AnimationEnded(const gfx::Animation* animation) OVERRIDE; |
| |
| // Used during testing; disable or enable animations (default is enabled). |
| static void SetAnimationsForTesting(bool enable); |
| |
| private: |
| static void OnChildSizeAllocate(GtkWidget* child, |
| GtkAllocation* allocation, |
| SlideAnimatorGtk* slider); |
| |
| scoped_ptr<gfx::SlideAnimation> animation_; |
| |
| // The top level widget of the SlideAnimatorGtk. It is a GtkFixed. |
| ui::OwnedWidgetGtk widget_; |
| |
| // The widget passed to us at construction time, and the only direct child of |
| // |widget_|. |
| GtkWidget* child_; |
| |
| // The direction of the slide. |
| Direction direction_; |
| |
| // The object to inform about certain events. It may be NULL. |
| Delegate* delegate_; |
| |
| // We need to move the child widget to (0, -height), but we don't know its |
| // height until it has been allocated. This variable will be true until the |
| // child widget has been allocated, at which point we will move it, and then |
| // set this variable to false to indicate it should not be moved again. |
| bool child_needs_move_; |
| |
| static bool animations_enabled_; |
| }; |
| |
| #endif // CHROME_BROWSER_UI_GTK_SLIDE_ANIMATOR_GTK_H_ |