blob: 4489900583642c7f599fd7a2c3445217183373b4 [file] [log] [blame]
// Copyright 2013 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.
#include "ash/ash_export.h"
#include "ash/shelf/shelf_button.h"
#include "base/macros.h"
#include "base/timer/timer.h"
#include "ui/gfx/shadow_value.h"
namespace views {
class ImageView;
namespace ash {
struct ShelfItem;
class ShelfView;
// Button used for app shortcuts on the shelf..
class ASH_EXPORT ShelfAppButton : public ShelfButton {
static const char kViewClassName[];
// Used to indicate the current state of the button.
enum State {
// Nothing special. Usually represents an app shortcut item with no running
// instance.
// Button has mouse hovering on it.
// Underlying ShelfItem has a running instance.
// Underlying ShelfItem needs user's attention.
// Hide the status (temporarily for some animations).
STATE_HIDDEN = 1 << 3,
// Button is being dragged.
// App has at least 1 notification.
// Underlying ShelfItem owns the window that is currently active.
STATE_ACTIVE = 1 << 6,
explicit ShelfAppButton(ShelfView* shelf_view);
~ShelfAppButton() override;
// Sets the image to display for this entry.
void SetImage(const gfx::ImageSkia& image);
// Retrieve the image to show proxy operations.
const gfx::ImageSkia& GetImage() const;
// |state| is or'd into the current state.
void AddState(State state);
void ClearState(State state);
int state() const { return state_; }
// Returns the bounds of the icon.
gfx::Rect GetIconBounds() const;
views::InkDrop* GetInkDropForTesting();
// Called when user started dragging the shelf button.
void OnDragStarted(const ui::LocatedEvent* event);
// Callback used when a menu for this ShelfAppButton is closed.
void OnMenuClosed();
// Overrides to views::Button:
void ShowContextMenu(const gfx::Point& p,
ui::MenuSourceType source_type) override;
// View override - needed by unit test.
void OnMouseCaptureLost() override;
// Update button state from ShelfItem.
void ReflectItemStatus(const ShelfItem& item);
// View overrides:
const char* GetClassName() const override;
bool OnMousePressed(const ui::MouseEvent& event) override;
void OnMouseReleased(const ui::MouseEvent& event) override;
void Layout() override;
void ChildPreferredSizeChanged(views::View* child) override;
// ui::EventHandler overrides:
void OnGestureEvent(ui::GestureEvent* event) override;
// views::Button overrides:
std::unique_ptr<views::InkDropRipple> CreateInkDropRipple() const override;
std::unique_ptr<views::InkDropMask> CreateInkDropMask() const override;
// Sets the icon image with a shadow.
void SetShadowedImage(const gfx::ImageSkia& bitmap);
class AppNotificationIndicatorView;
class AppStatusIndicatorView;
// Updates the parts of the button to reflect the current |state_| and
// alignment. This may add or remove views, layout and paint.
void UpdateState();
// Invoked when |touch_drag_timer_| fires to show dragging UI.
void OnTouchDragTimer();
// Invoked when |ripple_activation_timer_| fires to activate the ink drop.
void OnRippleTimer();
// Scales up app icon if |scale_up| is true, otherwise scales it back to
// normal size.
void ScaleAppIcon(bool scale_up);
// The icon part of a button can be animated independently of the rest.
views::ImageView* icon_view_;
// Draws an indicator underneath the image to represent the state of the
// application.
AppStatusIndicatorView* indicator_;
// Draws an indicator in the top right corner of the image to represent an
// active notification.
AppNotificationIndicatorView* notification_indicator_;
// The current application state, a bitfield of State enum values.
int state_;
gfx::ShadowValues icon_shadows_;
// If non-null the destuctor sets this to true. This is set while the menu is
// showing and used to detect if the menu was deleted while running.
bool* destroyed_flag_;
// Whether the notification indicator is enabled.
const bool is_notification_indicator_enabled_;
// A timer to defer showing drag UI when the shelf button is pressed.
base::OneShotTimer drag_timer_;
// A timer to activate the ink drop ripple during a long press.
base::OneShotTimer ripple_activation_timer_;
} // namespace ash