ui/app_list/views/app_list_item_view.h

   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.
   4
   5 #ifndef UI_APP_LIST_VIEWS_APP_LIST_ITEM_VIEW_H_
   6 #define UI_APP_LIST_VIEWS_APP_LIST_ITEM_VIEW_H_
   7
   8 #include <string>
   9
  10 #include "base/memory/ref_counted.h"
  11 #include "base/memory/scoped_ptr.h"
  12 #include "base/strings/string16.h"
  13 #include "base/timer/timer.h"
  14 #include "ui/app_list/app_list_export.h"
  15 #include "ui/app_list/app_list_item_observer.h"
  16 #include "ui/app_list/views/cached_label.h"
  17 #include "ui/views/context_menu_controller.h"
  18 #include "ui/views/controls/button/custom_button.h"
  19
  20 class SkBitmap;
  21
  22 namespace views {
  23 class ImageView;
  24 class Label;
  25 class MenuRunner;
  26 }
  27
  28 namespace app_list {
  29
  30 class AppListItem;
  31 class AppsGridView;
  32 class ProgressBarView;
  33
  34 class APP_LIST_EXPORT AppListItemView : public views::CustomButton,
  35                                         public views::ContextMenuController,
  36                                         public AppListItemObserver {
  37  public:
  38   // Internal class name.
  39   static const char kViewClassName[];
  40
  41   AppListItemView(AppsGridView* apps_grid_view, AppListItem* item);
  42   ~AppListItemView() override;
  43
  44   // Set the icon of this image, adding a drop shadow if |has_shadow|.
  45   void SetIcon(const gfx::ImageSkia& icon, bool has_shadow);
  46
  47   void SetItemName(const base::string16& display_name,
  48                    const base::string16& full_name);
  49   void SetItemIsInstalling(bool is_installing);
  50   bool is_highlighted() { return is_highlighted_; }  // for unit test
  51   void SetItemIsHighlighted(bool is_highlighted);
  52   void SetItemPercentDownloaded(int percent_downloaded);
  53
  54   void Prerender();
  55
  56   void CancelContextMenu();
  57
  58   gfx::ImageSkia GetDragImage();
  59   void OnDragEnded();
  60   gfx::Point GetDragImageOffset();
  61
  62   void SetAsAttemptedFolderTarget(bool is_target_folder);
  63
  64   AppListItem* item() const { return item_weak_; }
  65
  66   views::ImageView* icon() const { return icon_; }
  67
  68   const views::Label* title() const { return title_; }
  69
  70   // In a synchronous drag the item view isn't informed directly of the drag
  71   // ending, so the runner of the drag should call this.
  72   void OnSyncDragEnd();
  73
  74   // Returns the icon bounds relative to AppListItemView.
  75   const gfx::Rect& GetIconBounds() const;
  76
  77   // Sets UI state to dragging state.
  78   void SetDragUIState();
  79
  80   // Returns the icon bounds for the given |target_bounds| as
  81   // the assuming bounds of this view.
  82   gfx::Rect GetIconBoundsForTargetViewBounds(const gfx::Rect& target_bounds);
  83
  84   // views::CustomButton overrides:
  85   void OnGestureEvent(ui::GestureEvent* event) override;
  86
  87   // views::View overrides:
  88   bool GetTooltipText(const gfx::Point& p,
  89                       base::string16* tooltip) const override;
  90
  91  private:
  92   enum UIState {
  93     UI_STATE_NORMAL,    // Normal UI (icon + label)
  94     UI_STATE_DRAGGING,  // Dragging UI (scaled icon only)
  95     UI_STATE_DROPPING_IN_FOLDER,  // Folder dropping preview UI
  96   };
  97
  98   // Get icon from |item_| and schedule background processing.
  99   void UpdateIcon();
 100
 101   // Update the tooltip text from |item_|.
 102   void UpdateTooltip();
 103
 104   void SetUIState(UIState state);
 105
 106   // Sets |touch_dragging_| flag and updates UI.
 107   void SetTouchDragging(bool touch_dragging);
 108
 109   // Invoked when |mouse_drag_timer_| fires to show dragging UI.
 110   void OnMouseDragTimer();
 111
 112   // If the item is not in a folder, not highlighted, not being dragged, and not
 113   // having something dropped onto it, enables subpixel AA for the title.
 114   void SetTitleSubpixelAA();
 115
 116   // views::View overrides:
 117   const char* GetClassName() const override;
 118   void Layout() override;
 119   void SchedulePaintInRect(const gfx::Rect& r) override;
 120   void OnPaint(gfx::Canvas* canvas) override;
 121
 122   // views::ContextMenuController overrides:
 123   void ShowContextMenuForView(views::View* source,
 124                               const gfx::Point& point,
 125                               ui::MenuSourceType source_type) override;
 126
 127   // views::CustomButton overrides:
 128   void StateChanged() override;
 129   bool ShouldEnterPushedState(const ui::Event& event) override;
 130
 131   // views::View overrides:
 132   bool OnKeyPressed(const ui::KeyEvent& event) override;
 133   bool OnMousePressed(const ui::MouseEvent& event) override;
 134   void OnMouseReleased(const ui::MouseEvent& event) override;
 135   void OnMouseCaptureLost() override;
 136   bool OnMouseDragged(const ui::MouseEvent& event) override;
 137
 138   // AppListItemObserver overrides:
 139   void ItemIconChanged() override;
 140   void ItemNameChanged() override;
 141   void ItemIsInstallingChanged() override;
 142   void ItemPercentDownloadedChanged() override;
 143   void ItemBeingDestroyed() override;
 144
 145   const bool is_folder_;
 146   const bool is_in_folder_;
 147
 148   AppListItem* item_weak_;  // Owned by AppListModel. Can be NULL.
 149
 150   AppsGridView* apps_grid_view_;   // Parent view, owns this.
 151   views::ImageView* icon_;         // Strongly typed child view.
 152   CachedLabel* title_;             // Strongly typed child view.
 153   ProgressBarView* progress_bar_;  // Strongly typed child view.
 154
 155   scoped_ptr<views::MenuRunner> context_menu_runner_;
 156
 157   UIState ui_state_;
 158
 159   // True if scroll gestures should contribute to dragging.
 160   bool touch_dragging_;
 161
 162   bool is_installing_;
 163   bool is_highlighted_;
 164
 165   base::string16 tooltip_text_;
 166
 167   // A timer to defer showing drag UI when mouse is pressed.
 168   base::OneShotTimer<AppListItemView> mouse_drag_timer_;
 169
 170   DISALLOW_COPY_AND_ASSIGN(AppListItemView);
 171 };
 172
 173 }  // namespace app_list
 174
 175 #endif  // UI_APP_LIST_VIEWS_APP_LIST_ITEM_VIEW_H_