blob: 806114b75016006df893ff1e992c838e1be79029 [file] [log] [blame]
// Copyright (c) 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.
#import <Cocoa/Cocoa.h>
#include <set>
#include "base/mac/scoped_block.h"
#import "base/mac/scoped_nsobject.h"
#import "base/memory/scoped_ptr.h"
#include "ui/message_center/message_center_export.h"
namespace message_center {
class MessageCenter;
class MessageCenterObserver;
namespace message_center {
typedef void(^AnimationEndedCallback)();
// A popup collection interfaces with the MessageCenter as an observer. It will
// arrange notifications on the screen as popups, starting in the upper-right
// corner, going to the bottom of the screen. This class maintains ownership of
// the Cocoa controllers and windows of the notifications.
@interface MCPopupCollection : NSObject {
// The message center that is responsible for the notifications. Weak, global.
message_center::MessageCenter* messageCenter_;
// MessageCenterObserver implementation.
scoped_ptr<message_center::MessageCenterObserver> observer_;
// Array of all on-screen popup notifications.
base::scoped_nsobject<NSMutableArray> popups_;
// Array of all on-screen popup notifications that are being faded out
// for removal.
base::scoped_nsobject<NSMutableArray> popupsBeingRemoved_;
// For testing only. If not a zero rect, this is the screen size to use
// for laying out popups.
NSRect testingScreenFrame_;
// The duration of the popup animation, in the number of seconds.
NSTimeInterval popupAnimationDuration_;
// Set of notification IDs for those popups to be updated when all existing
// animations end.
std::set<std::string> pendingUpdateNotificationIDs_;
// Set of notification IDs for those popups to be closed when all existing
// animations end.
std::set<std::string> pendingRemoveNotificationIDs_;
// Set of notification IDs for those popups that are being animated due to
// showing, bounds change or closing.
std::set<std::string> animatingNotificationIDs_;
// For testing only. If set, the callback will be called when the animation
// ends.
// Designated initializer that construct an instance to observe |messageCenter|.
- (id)initWithMessageCenter:(message_center::MessageCenter*)messageCenter;
// Returns true if an animation is being played.
- (BOOL)isAnimating;
// Returns the duration of the popup animation.
- (NSTimeInterval)popupAnimationDuration;
// Called when the animation of a popup ends.
- (void)onPopupAnimationEnded:(const std::string&)notificationID;
@interface MCPopupCollection (ExposedForTesting)
- (NSArray*)popups;
// Setter for the testingScreenFrame_.
- (void)setScreenFrame:(NSRect)frame;
// Setter for changing the animation duration. The testing code could set it
// to a very small value to expedite the test running.
- (void)setAnimationDuration:(NSTimeInterval)duration;
// Setter for testingAnimationEndedCallback_. The testing code could set it
// to get called back when the animation ends.
- (void)setAnimationEndedCallback: