1 // Copyright 2013 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_APP_LIST_COCOA_APPS_GRID_CONTROLLER_H_
6 #define UI_APP_LIST_COCOA_APPS_GRID_CONTROLLER_H_
8 #import <Cocoa/Cocoa.h>
10 #include "base/mac/scoped_nsobject.h"
11 #include "base/memory/scoped_ptr.h"
12 #include "ui/app_list/app_list_export.h"
13 #import "ui/app_list/cocoa/app_list_pager_view.h"
14 #import "ui/app_list/cocoa/scroll_view_with_no_scrollbars.h"
18 class AppListViewDelegate;
19 class AppsGridDelegateBridge;
22 @class AppsGridViewItem;
23 @protocol AppsPaginationModelObserver;
24 @class AppsCollectionViewDragManager;
26 // Controls a grid of views, representing AppListItemList sub models.
28 @interface AppsGridController : NSViewController<GestureScrollDelegate,
30 NSCollectionViewDelegate> {
32 scoped_ptr<app_list::AppListModel> model_;
33 app_list::AppListViewDelegate* delegate_; // Weak. Owned by view controller.
34 scoped_ptr<app_list::AppsGridDelegateBridge> bridge_;
36 base::scoped_nsobject<AppsCollectionViewDragManager> dragManager_;
37 base::scoped_nsobject<NSMutableArray> pages_;
38 base::scoped_nsobject<NSMutableArray> items_;
39 base::scoped_nsobject<NSTimer> scrollWhileDraggingTimer_;
41 id<AppsPaginationModelObserver> paginationObserver_;
43 // Index of the currently visible page.
45 // The page to which the view is currently animating a scroll.
46 size_t targetScrollPage_;
47 // The page to start scrolling to when the timer expires.
48 size_t scheduledScrollPage_;
50 // Whether we are currently animating a scroll to the nearest page.
51 BOOL animatingScroll_;
54 @property(assign, nonatomic) id<AppsPaginationModelObserver> paginationObserver;
56 + (void)setScrollAnimationDuration:(NSTimeInterval)duration;
58 // The amount the grid view has been extended to hold the sometimes present
59 // invisible scroller that allows for gesture scrolling.
60 + (CGFloat)scrollerPadding;
62 - (NSCollectionView*)collectionViewAtPageIndex:(size_t)pageIndex;
63 - (size_t)pageIndexForCollectionView:(NSCollectionView*)page;
65 - (AppsGridViewItem*)itemAtIndex:(size_t)itemIndex;
67 - (app_list::AppListModel*)model;
69 - (void)setModel:(scoped_ptr<app_list::AppListModel>)newModel;
71 - (void)setDelegate:(app_list::AppListViewDelegate*)newDelegate;
73 - (size_t)visiblePage;
75 // Calls item->Activate for the currently selected item by simulating a click.
76 - (void)activateSelection;
78 // Return the number of pages of icons in the grid.
81 // Return the number of items over all pages in the grid.
84 // Scroll to a page in the grid view with an animation.
85 - (void)scrollToPage:(size_t)pageIndex;
87 // Start a timer to scroll to a new page, if |locationInWindow| is to the left
88 // or the right of the view, or if it is over a pager segment. Cancels any
89 // existing timer if the target page changes.
90 - (void)maybeChangePageForPoint:(NSPoint)locationInWindow;
92 // Cancel a timer that may have been set by maybeChangePageForPoint().
93 - (void)cancelScrollTimer;
95 // Moves an item within the view only, for dragging or in response to model
97 - (void)moveItemInView:(size_t)fromIndex
98 toItemIndex:(size_t)toIndex;
100 // Moves an item in the item model. Does not adjust the view.
101 - (void)moveItemWithIndex:(size_t)itemIndex
102 toModelIndex:(size_t)modelIndex;
104 // Return the index of the selected item.
105 - (NSUInteger)selectedItemIndex;
107 // Moves the selection to the given index.
108 - (void)selectItemAtIndex:(NSUInteger)index;
110 // Handle key actions. Similar to doCommandBySelector from NSResponder but that
111 // requires this class to be in the responder chain. Instead this method is
112 // invoked by the AppListViewController.
113 // Returns YES if this handled navigation or launched an app.
114 - (BOOL)handleCommandBySelector:(SEL)command;
118 @interface AppsGridController(TestingAPI)
120 - (AppsCollectionViewDragManager*)dragManager;
121 - (size_t)scheduledScrollPage;
125 #endif // UI_APP_LIST_COCOA_APPS_GRID_CONTROLLER_H_