components/Ripple/src/MDCRippleViewDelegate.h

// Copyright 2020-present the Material Components for iOS authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#import <UIKit/UIKit.h>

@class MDCRippleView;

/**
 The ripple view delegate protocol. Clients may implement this protocol to receive updates on
 the ripple's animation lifecycle.
 */
@protocol MDCRippleViewDelegate <NSObject>

@optional

/**
 Called when the ripple view began its touch down animation.

 @param rippleView The MDCRippleView.
 */
- (void)rippleTouchDownAnimationDidBegin:(nonnull MDCRippleView *)rippleView;

/**
 Called when the ripple view ended its touch down animation.

 @param rippleView The MDCRippleView.
 */
- (void)rippleTouchDownAnimationDidEnd:(nonnull MDCRippleView *)rippleView;

/**
 Called when the ripple view began its touch up animation.

 @param rippleView The MDCRippleView.
 */
- (void)rippleTouchUpAnimationDidBegin:(nonnull MDCRippleView *)rippleView;

/**
 Called when the ripple view ended its touch up animation.

 @param rippleView The MDCRippleView.
 */
- (void)rippleTouchUpAnimationDidEnd:(nonnull MDCRippleView *)rippleView;

@end