blob: ede32dc184ee2fb0e3b8362fd76edfa465afab9f [file] [log] [blame]
// Copyright (c) 2011 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/mac/scoped_nsobject.h"
namespace ui {
class ThemeProvider;
// Base class for button cells for toolbar and bookmark bar.
// This is a button cell that handles drawing/highlighting of buttons.
// The appearance is determined by setting the cell's tag (not the
// view's) to one of the constants below (ButtonType).
// Set this as the cell's tag.
enum {
kLeftButtonType = -1,
kLeftButtonWithShadowType = -2,
kStandardButtonType = 0,
kRightButtonType = 1,
kMiddleButtonType = 2,
// Draws like a standard button, except when clicked where the interior
// doesn't darken using the theme's "pressed" gradient. Instead uses the
// normal un-pressed gradient.
kStandardButtonTypeWithLimitedClickFeedback = 3,
kMaterialStandardButtonTypeWithLimitedClickFeedback = 4,
kMaterialMenuButtonTypeWithLimitedClickFeedback = 5,
typedef NSInteger ButtonType;
namespace gradient_button_cell {
// Pulsing state for this button.
typedef enum {
// Stable states.
// In motion which will end in a stable state.
// Continuously illuminated, used to highlight buttons.
} PulseState;
@interface GradientButtonCell : NSButtonCell {
// Custom drawing means we need to perform our own mouse tracking if
// the cell is setShowsBorderOnlyWhileMouseInside:YES.
BOOL isMouseInside_;
base::scoped_nsobject<NSTrackingArea> trackingArea_;
BOOL shouldTheme_;
CGFloat hoverAlpha_; // 0-1. Controls the alpha during mouse hover
NSTimeInterval lastHoverUpdate_;
base::scoped_nsobject<NSGradient> gradient_;
gradient_button_cell::PulseState pulseState_;
CGFloat outerStrokeAlphaMult_; // For pulsing.
// Returns the amount by which the control frame is inset on all sides for
// drawing.
+ (CGFloat)insetInView:(NSView*)view;
// Turn off theming. Temporary work-around.
- (void)setShouldTheme:(BOOL)shouldTheme;
- (void)drawBorderAndFillForTheme:(const ui::ThemeProvider*)themeProvider
// Let the view know when the mouse moves in and out. A timer will update
// the current hoverAlpha_ based on these events.
- (void)setMouseInside:(BOOL)flag animate:(BOOL)animate;
// Gets the path which tightly bounds the outside of the button. This is needed
// to produce images of clear buttons which only include the area inside, since
// the background of the button is drawn by someone else.
- (NSBezierPath*)clipPathForFrame:(NSRect)cellFrame
// Turn on or off pulse sticking. When turning off sticking, leave our pulse
// state in the correct ending position for our isMouseInside_ property. Public
// since it's called from the bookmark bubble.
- (void)setPulseIsStuckOn:(BOOL)continuous;
// Returns continuous pulse state.
- (BOOL)isPulseStuckOn;
// Safely stop continuous pulsing by turning off all timers.
// May leave the cell in an odd state.
// Needed by an owning control's dealloc routine.
- (void)safelyStopPulsing;
// Actually fetches current mouse position and does a hit test.
- (BOOL)isMouseReallyInside;
// Defines the top offset of text within the cell. Used by drawTitle and can
// be overriden by objects that inherit this class for placement of text.
- (int)verticalTextOffset;
// The amount by which the gradient button cell should nudge the path used to
// draw the hover (and pressed) state background path.
- (CGFloat)hoverBackgroundVerticalOffsetInControlView:(NSView*)controlView;
// Returns YES if the cell's tag indicates a Material Design button type.
- (BOOL)isMaterialDesignButtonType;
@property(assign, nonatomic) CGFloat hoverAlpha;
@interface GradientButtonCell(TestingAPI)
- (BOOL)isMouseInside;
- (BOOL)pulsing;
- (gradient_button_cell::PulseState)pulseState;
- (void)setPulseState:(gradient_button_cell::PulseState)pstate;
- (void)updateTrackingAreas;