1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
// Copyright (c) 2010 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.
#import <Cocoa/Cocoa.h>
#include "base/scoped_nsobject.h"
#import "chrome/browser/cocoa/bookmark_button.h"
@class BookmarkBarController;
@class BookmarkBarFolderView;
@class BookmarkFolderTarget;
// A controller for the pop-up windows from bookmark folder buttons
// which look sort of like menus.
@interface BookmarkBarFolderController :
NSWindowController<BookmarkButtonDelegate,
BookmarkButtonControllerProtocol> {
@private
// Enumeration of the valid states that the |hoverButton_| member can be in.
// Because the opening and closing of hover views can be done asyncronously
// there are periods where the hover state is in transtion between open and
// closed. During those times of transition the opening or closing operation
// can be cancelled. We serialize the opening and closing of the
// |hoverButton_| using this state information. This serialization is to
// avoid race conditions where one hover button is being opened while another
// is closing.
enum HoverState {
kHoverStateClosed = 0,
kHoverStateOpening = 1,
kHoverStateOpen = 2,
kHoverStateClosing = 3
};
// The button whose click opened us.
scoped_nsobject<BookmarkButton> parentButton_;
// Bookmark bar folder controller chains are torn down in two ways:
// 1. Clicking "outside" the folder (see use of
// CrApplicationEventHookProtocol in the bookmark bar controller).
// 2. Engaging a different folder (via hover over or explicit click).
//
// In either case, the BookmarkButtonControllerProtocol method
// closeAllBookmarkFolders gets called. For bookmark bar folder
// controllers, this is passed up the chain so we begin with a top
// level "close".
// When any bookmark folder window closes, it necessarily tells
// subcontroller windows to close (down the chain), and autoreleases
// the controller. (Must autorelease since the controller can still
// get delegate events such as windowDidClose).
//
// Bookmark bar folder controllers own their buttons. When doing
// drag and drop of a button from one sub-sub-folder to a different
// sub-sub-folder, we need to make sure the button's pointers stay
// valid until we've dropped (or cancelled). Note that such a drag
// causes the source sub-sub-folder (previous parent window) to go
// away (windows close, controllers autoreleased) since you're
// hovering over a different folder chain for dropping. To keep
// things valid (like the button's target, its delegate, the parent
// cotroller that we have a pointer to below [below], etc), we heep
// strong pointers to our owning controller, so the entire chain
// stays owned.
// Our parent controller, if we are a nested folder, otherwise nil.
// Strong to insure the object lives as long as we need it.
scoped_nsobject<BookmarkBarFolderController> parentController_;
// The main bar controller from whence we or a parent sprang.
BookmarkBarController* barController_; // WEAK: It owns us.
// Our buttons. We do not have buttons for nested folders.
scoped_nsobject<NSMutableArray> buttons_;
// The scroll view that contains our main button view (below).
IBOutlet NSScrollView* scrollView_;
// Are we scrollable? If no, the full contents of the folder are
// always visible.
BOOL scrollable_;
// The main view of this window (where the buttons go).
IBOutlet BookmarkBarFolderView* mainView_;
// Weak; we keep track to work around a
// setShowsBorderOnlyWhileMouseInside bug.
BookmarkButton* buttonThatMouseIsIn_;
// The context menu for a bookmark button which represents an URL.
IBOutlet NSMenu* buttonMenu_;
// The context menu for a bookmark button which represents a folder.
IBOutlet NSMenu* folderMenu_;
// Like normal menus, hovering over a folder button causes it to
// open. This variable is set when a hover is initiated (but has
// not necessarily fired yet).
scoped_nsobject<BookmarkButton> hoverButton_;
// We model hover state as a state machine with specific allowable
// transitions. |hoverState_| is the state of this machine at any
// given time.
HoverState hoverState_;
// Logic for dealing with a click on a bookmark folder button.
scoped_nsobject<BookmarkFolderTarget> folderTarget_;
// A controller for a pop-up bookmark folder window (custom menu).
// We (self) are the parentController_ for our folderController_.
// This is not a scoped_nsobject because it owns itself (when its
// window closes the controller gets autoreleased).
BookmarkBarFolderController* folderController_;
// Implement basic menu scrolling through this tracking area.
scoped_nsobject<NSTrackingArea> scrollTrackingArea_;
// Timer to continue scrolling as needed. We own the timer but
// don't release it when done (we invalidate it).
NSTimer* scrollTimer_;
// Amount to scroll by on each timer fire. Can be + or -.
CGFloat verticalScrollDelta_;
}
// Designated initializer.
- (id)initWithParentButton:(BookmarkButton*)button
parentController:(BookmarkBarFolderController*)parentController
barController:(BookmarkBarController*)barController;
// Return the parent button that owns the bookmark folder we represent.
- (BookmarkButton*)parentButton;
// Actions from a context menu over a button or folder.
- (IBAction)cutBookmark:(id)sender;
- (IBAction)copyBookmark:(id)sender;
- (IBAction)pasteBookmark:(id)sender;
- (IBAction)deleteBookmark:(id)sender;
// Forwarded to the associated BookmarkBarController.
- (IBAction)addFolder:(id)sender;
- (IBAction)addPage:(id)sender;
- (IBAction)editBookmark:(id)sender;
- (IBAction)openAllBookmarks:(id)sender;
- (IBAction)openAllBookmarksIncognitoWindow:(id)sender;
- (IBAction)openAllBookmarksNewWindow:(id)sender;
- (IBAction)openBookmarkInIncognitoWindow:(id)sender;
- (IBAction)openBookmarkInNewForegroundTab:(id)sender;
- (IBAction)openBookmarkInNewWindow:(id)sender;
@end
@interface BookmarkBarFolderController(TestingAPI)
- (NSView*)mainView;
- (NSPoint)windowTopLeft;
- (NSArray*)buttons;
- (BookmarkBarFolderController*)folderController;
- (id)folderTarget;
- (void)configureWindowLevel;
- (void)performOneScroll:(CGFloat)delta;
// Internal interface for hover button management.
- (void)scheduleCloseBookmarkFolderOnHoverButton;
- (void)cancelPendingCloseBookmarkFolderOnHoverButton;
- (void)scheduleOpenBookmarkFolderOnHoverButton;
- (void)cancelPendingOpenBookmarkFolderOnHoverButton;
- (BookmarkButton*)hoverButton;
- (void)setHoverButton:(BookmarkButton*)button;
- (HoverState)hoverState;
@end
|
