components/Ripple/src/private/MDCRippleLayerDelegate.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 MDCRippleLayer;

/**
 The ripple layer delegate protocol to let MDCRippleView know of the layer's
 ripple animation timeline.
 */
NS_SWIFT_UI_ACTOR
@protocol MDCRippleLayerDelegate <CALayerDelegate>

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

 @param rippleLayer The MDCRippleLayer.
 */
- (void)rippleLayerTouchDownAnimationDidBegin:(nonnull MDCRippleLayer *)rippleLayer;

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

 @param rippleLayer The MDCRippleLayer.
 */
- (void)rippleLayerTouchDownAnimationDidEnd:(nonnull MDCRippleLayer *)rippleLayer;

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

 @param rippleLayer The MDCRippleLayer.
 */
- (void)rippleLayerTouchUpAnimationDidBegin:(nonnull MDCRippleLayer *)rippleLayer;

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

 @param rippleLayer The MDCRippleLayer.
 */
- (void)rippleLayerTouchUpAnimationDidEnd:(nonnull MDCRippleLayer *)rippleLayer;

@end