components/ActionSheet/src/MDCActionSheetController.h - external/github.com/material-components/material-components-ios - Git at Google

 // Copyright 2018-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>

 #import "MaterialBottomSheet.h"
 #import "MaterialElevation.h"

 @class MDCActionSheetAction;
 @class MDCActionSheetController;

 /**
  Defines methods that allows the adopting delegate to respond to messages from an
  @c MDCActionSheetController.
  */
 @protocol MDCActionSheetControllerDelegate <NSObject>
 @optional

 /**
  Tells the delegate that the action sheet was dismissed.
  */
 - (void)actionSheetControllerDidDismiss:(nonnull MDCActionSheetController *)actionSheetController;
 @end

 /**
  MDCActionSheetController displays an alert message to the user, similar to
  UIAlertControllerStyleActionSheet.

  A Material Action Sheet consists of a title, message and a list of actions.

  The [Material Guidelines article for Bottom
  Sheets](https://material.io/design/components/sheets-bottom.html) and the
  [Material Guidelines article for Lists](https://material.io/design/components/lists.html) have more
  detailed guidance about how to style and use Action Sheets.

  To learn more about
  [UIAlertController](https://developer.apple.com/documentation/uikit/uialertcontroller)
  or
  [UIAlertControllerStyleActionSheet](https://developer.apple.com/documentation/uikit/uialertcontrollerstyle/uialertcontrollerstyleactionsheet)

  MDCActionSheetController does not support UIPopoverController, instead it will always be presented
  in a sheet from the bottom.

  */
 __attribute__((objc_subclassing_restricted)) @interface MDCActionSheetController
     : UIViewController<MDCElevatable, MDCElevationOverriding>

 /**
  Designated initializer to create and return a view controller for displaying an alert to the user.

  After creating the alert controller, add actions to the controller by calling -addAction.

  @param title The title of the alert.
  @param message Descriptive text that summarizes a decision in a sentence or two.
  @return An initialized MDCActionSheetController object.
  */
 + (nonnull instancetype)actionSheetControllerWithTitle:(nullable NSString *)title
                                                message:(nullable NSString *)message;

 /**
  Convenience initializer to create and return a view controller for displaying an alert to the user.

  After creating the alert controller, add actions to the controller by calling -
  addAction.

  @param title The title of the alert.
  @return An initialized MDCActionSheetController object.
  */
 + (nonnull instancetype)actionSheetControllerWithTitle:(nullable NSString *)title;

 /**
  Action sheet controllers must be created with actionSheetControllerWithTitle: or
  with actionSheetControllerWithTitle:message:
  */
 - (nonnull instancetype)initWithNibName:(nullable NSString *)nibNameOrNil
                                  bundle:(nullable NSBundle *)nibBundleOrNil NS_UNAVAILABLE;

 /**
  Action sheet controllers must be created with actionSheetControllerwithTitle:
  or with actionSheetControllerWithTitle:message:
  */
 - (nullable instancetype)initWithCoder:(nonnull NSCoder *)aDecoder NS_UNAVAILABLE;

 /**
  Adds an action to the action sheet.

  Actions are the possible reactions of the user to the presented alert. Actions
  are added as a list item in the list of the action sheet.
  Action buttons will be laid out from top to bottom depending on the order they
  were added.

  @param action Will be added to the end of MDCActionSheetController.actions.
  */
 - (void)addAction:(nonnull MDCActionSheetAction *)action;

 /**
  The object that acts as the delegate of the @c MDCActionSheetController
 */
 @property(nonatomic, weak, nullable) id<MDCActionSheetControllerDelegate> delegate;

 /**
  The actions that the user can take in response to the action sheet.

  The order of the actions in the array matches the order in which they were added
  to the action sheet.
  */
 @property(nonatomic, nonnull, readonly, copy) NSArray<MDCActionSheetAction *> *actions;

 /**
  The title of the action sheet controller.

  If this is updated after presentation the view will be updated to match the
  new value.
  */
 @property(nonatomic, nullable, copy) NSString *title;

 /**
  The message of the action sheet controller.

  If this is updated after presentation the view will be updated to match the new value.
  */
 @property(nonatomic, nullable, copy) NSString *message;

 /**
  A block that is invoked when the @c MDCActionSheetController receives a call to @c
  traitCollectionDidChange:. The block is called after the call to the superclass.
  */
 @property(nonatomic, copy, nullable) void (^traitCollectionDidChangeBlock)
     (MDCActionSheetController *_Nonnull actionSheet,
      UITraitCollection *_Nullable previousTraitCollection);

 /**
  Indicates whether the button should automatically update its font when the device’s
  UIContentSizeCategory is changed.

  This property is modeled after the adjustsFontForContentSizeCategory property in the
  UIContentSizeCategoryAdjusting protocol added by Apple in iOS 10.0.

  If set to YES, this button will base its text font on MDCFontTextStyleButton.

  Defaults value is NO.
  */
 @property(nonatomic, setter=mdc_setAdjustsFontForContentSizeCategory:)
     BOOL mdc_adjustsFontForContentSizeCategory;

 /**
   The font applied to the title of the action sheet controller.
  */
 @property(nonatomic, nonnull, strong) UIFont *titleFont;

 /**
   The font applied to the message of the action sheet controller.
  */
 @property(nonatomic, nonnull, strong) UIFont *messageFont;

 /**
    The font applied to the action items of the action sheet controller.
  */
 @property(nonatomic, nullable, strong) UIFont *actionFont;

 /**
  The color applied to the sheet view of the action sheet controller.
  */
 @property(nonatomic, nonnull, strong) UIColor *backgroundColor;

 /**
  The color applied to the title of the action sheet controller.

  @note If only using a title and the actions have no icons make sure they are different colors so
  there is a distinction between the title and actions.
  */
 @property(nonatomic, strong, nullable) UIColor *titleTextColor;

 /**
  The color applied to the message of the action sheet controller.

  @note To make for a better user experience we recommend using a different color for the message and
  actions if there are no icons so there is a distinction between the message and actions.
  */
 @property(nonatomic, strong, nullable) UIColor *messageTextColor;

 /**
  The color for the text for all action items within an action sheet.
  */
 @property(nonatomic, strong, nullable) UIColor *actionTextColor;

 /**
  The tint color for the action items within an action sheet.
  */
 @property(nonatomic, strong, nullable) UIColor *actionTintColor;

 /**
  The ripple color for the action items within an action sheet.
  */
 @property(nonatomic, strong, nullable) UIColor *rippleColor;

 /**
  The image rendering mode for all actions within an action sheet.
  */
 @property(nonatomic) UIImageRenderingMode imageRenderingMode;

 /**
  Determines if a divider should be shown between the header and actions. To customize the divider
  color see @c headerDividerColor.

  Defaults to NO.
  */
 @property(nonatomic, assign) BOOL showsHeaderDivider;

 /**
  The color of the divider between the header and actions.

  Defaults to a semi transparent black.
  */
 @property(nonatomic, copy, nonnull) UIColor *headerDividerColor;

 /**
  The elevation of the action sheet. Defaults to @c MDCShadowElevationModalBottomSheet.
  */
 @property(nonatomic, assign) MDCShadowElevation elevation;

 /**
  The inset or outset margins for the rectangle surrounding all of each action's content.

  Defaults to @c UIEdgeInsetsZero.
  */
 @property(nonatomic, assign) UIEdgeInsets contentEdgeInsets;

 /**
  Determines the alignment behavior of all title leading edges.

  When YES, all title leading edges will be aligned with one another.

  When NO, each title will be positioned individually based on whether it has an image or not.

  Defaults to NO.
  */
 @property(nonatomic, assign) BOOL alwaysAlignTitleLeadingEdges;

 @property(nonatomic, strong, readonly, nonnull)
     MDCBottomSheetTransitionController *transitionController;

 - (void)setTransitioningDelegate:
     (nullable id<UIViewControllerTransitioningDelegate>)transitioningDelegate NS_UNAVAILABLE;

 - (void)setModalPresentationStyle:(UIModalPresentationStyle)modalPresentationStyle NS_UNAVAILABLE;

 @end

 /**
  MDCActionSheetActionHandler is a block that will be invoked when the action is
  selected.
  */
 typedef void (^MDCActionSheetHandler)(MDCActionSheetAction *_Nonnull action);

 /**
  An instance of MDCActionSheetAction is passed to MDCActionSheetController to
  add an action to the action sheet.
  */
 @interface MDCActionSheetAction : NSObject <NSCopying, UIAccessibilityIdentification>

 /**
  Returns an action sheet action with the populated given values.

  @param title The title of the list item shown in the list
  @param image The icon of the list item shown in the list
  @param handler A block to execute when the user selects the action.
  @return An initialized MDCActionSheetAction object.
  */
 + (nonnull instancetype)actionWithTitle:(nonnull NSString *)title
                                   image:(nullable UIImage *)image
                                 handler:(__nullable MDCActionSheetHandler)handler;

 /**
  Action sheet actions must be created with actionWithTitle:image:handler:
  */
 - (nonnull instancetype)init NS_UNAVAILABLE;

 /**
  Title of the list item shown on the action sheet.

  Action sheet actions must have a title that will be set within actionWithTitle:image:handler:
  method.
  */
 @property(nonatomic, nonnull, readonly) NSString *title;

 /**
  Image of the list item shown on the action sheet.

  Action sheet actions must have an image that will be set within actionWithTitle:image:handler:
  method.
 */
 @property(nonatomic, nullable, readonly) UIImage *image;

 /**
  The @c accessibilityIdentifier for the view associated with this action.
  */
 @property(nonatomic, nullable, copy) NSString *accessibilityIdentifier;

 /**
  The color of the action title.

  @note If no @c titleColor is provided then the @c actionTextColor from the controller will be used.
  */
 @property(nonatomic, copy, nullable) UIColor *titleColor;

 /**
  The tint color of the action.

  @note If no @c tintColor is provided then the @c actionTintColor from the controller will be used.
  */
 @property(nonatomic, copy, nullable) UIColor *tintColor;

 /**
  The color of the divider at the top of the action.

  @note Defaults to clear.
  */
 @property(nonatomic, copy, nonnull) UIColor *dividerColor;

 /**
  Controls whether a divider is shown at the top of the action.

  @note Defaults to @c NO.
  */
 @property(nonatomic, assign) BOOL showsDivider;

 @end
	// Copyright 2018-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>

	#import "MaterialBottomSheet.h"
	#import "MaterialElevation.h"

	@class MDCActionSheetAction;
	@class MDCActionSheetController;

	/**
	Defines methods that allows the adopting delegate to respond to messages from an
	@c MDCActionSheetController.
	*/
	@protocol MDCActionSheetControllerDelegate <NSObject>
	@optional

	/**
	Tells the delegate that the action sheet was dismissed.
	*/
	- (void)actionSheetControllerDidDismiss:(nonnull MDCActionSheetController *)actionSheetController;
	@end

	/**
	MDCActionSheetController displays an alert message to the user, similar to
	UIAlertControllerStyleActionSheet.

	A Material Action Sheet consists of a title, message and a list of actions.

	The [Material Guidelines article for Bottom
	Sheets](https://material.io/design/components/sheets-bottom.html) and the
	[Material Guidelines article for Lists](https://material.io/design/components/lists.html) have more
	detailed guidance about how to style and use Action Sheets.

	To learn more about
	[UIAlertController](https://developer.apple.com/documentation/uikit/uialertcontroller)
	or
	[UIAlertControllerStyleActionSheet](https://developer.apple.com/documentation/uikit/uialertcontrollerstyle/uialertcontrollerstyleactionsheet)

	MDCActionSheetController does not support UIPopoverController, instead it will always be presented
	in a sheet from the bottom.

	*/
	__attribute__((objc_subclassing_restricted)) @interface MDCActionSheetController
	: UIViewController<MDCElevatable, MDCElevationOverriding>

	/**
	Designated initializer to create and return a view controller for displaying an alert to the user.

	After creating the alert controller, add actions to the controller by calling -addAction.

	@param title The title of the alert.
	@param message Descriptive text that summarizes a decision in a sentence or two.
	@return An initialized MDCActionSheetController object.
	*/
	+ (nonnull instancetype)actionSheetControllerWithTitle:(nullable NSString *)title
	message:(nullable NSString *)message;

	/**
	Convenience initializer to create and return a view controller for displaying an alert to the user.

	After creating the alert controller, add actions to the controller by calling -
	addAction.

	@param title The title of the alert.
	@return An initialized MDCActionSheetController object.
	*/
	+ (nonnull instancetype)actionSheetControllerWithTitle:(nullable NSString *)title;

	/**
	Action sheet controllers must be created with actionSheetControllerWithTitle: or
	with actionSheetControllerWithTitle:message:
	*/
	- (nonnull instancetype)initWithNibName:(nullable NSString *)nibNameOrNil
	bundle:(nullable NSBundle *)nibBundleOrNil NS_UNAVAILABLE;

	/**
	Action sheet controllers must be created with actionSheetControllerwithTitle:
	or with actionSheetControllerWithTitle:message:
	*/
	- (nullable instancetype)initWithCoder:(nonnull NSCoder *)aDecoder NS_UNAVAILABLE;

	/**
	Adds an action to the action sheet.

	Actions are the possible reactions of the user to the presented alert. Actions
	are added as a list item in the list of the action sheet.
	Action buttons will be laid out from top to bottom depending on the order they
	were added.

	@param action Will be added to the end of MDCActionSheetController.actions.
	*/
	- (void)addAction:(nonnull MDCActionSheetAction *)action;

	/**
	The object that acts as the delegate of the @c MDCActionSheetController
	*/
	@property(nonatomic, weak, nullable) id<MDCActionSheetControllerDelegate> delegate;

	/**
	The actions that the user can take in response to the action sheet.

	The order of the actions in the array matches the order in which they were added
	to the action sheet.
	*/
	@property(nonatomic, nonnull, readonly, copy) NSArray<MDCActionSheetAction > actions;

	/**
	The title of the action sheet controller.

	If this is updated after presentation the view will be updated to match the
	new value.
	*/
	@property(nonatomic, nullable, copy) NSString *title;

	/**
	The message of the action sheet controller.

	If this is updated after presentation the view will be updated to match the new value.
	*/
	@property(nonatomic, nullable, copy) NSString *message;

	/**
	A block that is invoked when the @c MDCActionSheetController receives a call to @c
	traitCollectionDidChange:. The block is called after the call to the superclass.
	*/
	@property(nonatomic, copy, nullable) void (^traitCollectionDidChangeBlock)
	(MDCActionSheetController *_Nonnull actionSheet,
	UITraitCollection *_Nullable previousTraitCollection);

	/**
	Indicates whether the button should automatically update its font when the device’s
	UIContentSizeCategory is changed.

	This property is modeled after the adjustsFontForContentSizeCategory property in the
	UIContentSizeCategoryAdjusting protocol added by Apple in iOS 10.0.

	If set to YES, this button will base its text font on MDCFontTextStyleButton.

	Defaults value is NO.
	*/
	@property(nonatomic, setter=mdc_setAdjustsFontForContentSizeCategory:)
	BOOL mdc_adjustsFontForContentSizeCategory;

	/**
	The font applied to the title of the action sheet controller.
	*/
	@property(nonatomic, nonnull, strong) UIFont *titleFont;

	/**
	The font applied to the message of the action sheet controller.
	*/
	@property(nonatomic, nonnull, strong) UIFont *messageFont;

	/**
	The font applied to the action items of the action sheet controller.
	*/
	@property(nonatomic, nullable, strong) UIFont *actionFont;

	/**
	The color applied to the sheet view of the action sheet controller.
	*/
	@property(nonatomic, nonnull, strong) UIColor *backgroundColor;

	/**
	The color applied to the title of the action sheet controller.

	@note If only using a title and the actions have no icons make sure they are different colors so
	there is a distinction between the title and actions.
	*/
	@property(nonatomic, strong, nullable) UIColor *titleTextColor;

	/**
	The color applied to the message of the action sheet controller.

	@note To make for a better user experience we recommend using a different color for the message and
	actions if there are no icons so there is a distinction between the message and actions.
	*/
	@property(nonatomic, strong, nullable) UIColor *messageTextColor;

	/**
	The color for the text for all action items within an action sheet.
	*/
	@property(nonatomic, strong, nullable) UIColor *actionTextColor;

	/**
	The tint color for the action items within an action sheet.
	*/
	@property(nonatomic, strong, nullable) UIColor *actionTintColor;

	/**
	The ripple color for the action items within an action sheet.
	*/
	@property(nonatomic, strong, nullable) UIColor *rippleColor;

	/**
	The image rendering mode for all actions within an action sheet.
	*/
	@property(nonatomic) UIImageRenderingMode imageRenderingMode;

	/**
	Determines if a divider should be shown between the header and actions. To customize the divider
	color see @c headerDividerColor.

	Defaults to NO.
	*/
	@property(nonatomic, assign) BOOL showsHeaderDivider;

	/**
	The color of the divider between the header and actions.

	Defaults to a semi transparent black.
	*/
	@property(nonatomic, copy, nonnull) UIColor *headerDividerColor;

	/**
	The elevation of the action sheet. Defaults to @c MDCShadowElevationModalBottomSheet.
	*/
	@property(nonatomic, assign) MDCShadowElevation elevation;

	/**
	The inset or outset margins for the rectangle surrounding all of each action's content.

	Defaults to @c UIEdgeInsetsZero.
	*/
	@property(nonatomic, assign) UIEdgeInsets contentEdgeInsets;

	/**
	Determines the alignment behavior of all title leading edges.

	When YES, all title leading edges will be aligned with one another.

	When NO, each title will be positioned individually based on whether it has an image or not.

	Defaults to NO.
	*/
	@property(nonatomic, assign) BOOL alwaysAlignTitleLeadingEdges;

	@property(nonatomic, strong, readonly, nonnull)
	MDCBottomSheetTransitionController *transitionController;

	- (void)setTransitioningDelegate:
	(nullable id<UIViewControllerTransitioningDelegate>)transitioningDelegate NS_UNAVAILABLE;

	- (void)setModalPresentationStyle:(UIModalPresentationStyle)modalPresentationStyle NS_UNAVAILABLE;

	@end

	/**
	MDCActionSheetActionHandler is a block that will be invoked when the action is
	selected.
	*/
	typedef void (^MDCActionSheetHandler)(MDCActionSheetAction *_Nonnull action);

	/**
	An instance of MDCActionSheetAction is passed to MDCActionSheetController to
	add an action to the action sheet.
	*/
	@interface MDCActionSheetAction : NSObject <NSCopying, UIAccessibilityIdentification>

	/**
	Returns an action sheet action with the populated given values.

	@param title The title of the list item shown in the list
	@param image The icon of the list item shown in the list
	@param handler A block to execute when the user selects the action.
	@return An initialized MDCActionSheetAction object.
	*/
	+ (nonnull instancetype)actionWithTitle:(nonnull NSString *)title
	image:(nullable UIImage *)image
	handler:(__nullable MDCActionSheetHandler)handler;

	/**
	Action sheet actions must be created with actionWithTitle:image:handler:
	*/
	- (nonnull instancetype)init NS_UNAVAILABLE;

	/**
	Title of the list item shown on the action sheet.

	Action sheet actions must have a title that will be set within actionWithTitle:image:handler:
	method.
	*/
	@property(nonatomic, nonnull, readonly) NSString *title;

	/**
	Image of the list item shown on the action sheet.

	Action sheet actions must have an image that will be set within actionWithTitle:image:handler:
	method.
	*/
	@property(nonatomic, nullable, readonly) UIImage *image;

	/**
	The @c accessibilityIdentifier for the view associated with this action.
	*/
	@property(nonatomic, nullable, copy) NSString *accessibilityIdentifier;

	/**
	The color of the action title.

	@note If no @c titleColor is provided then the @c actionTextColor from the controller will be used.
	*/
	@property(nonatomic, copy, nullable) UIColor *titleColor;

	/**
	The tint color of the action.

	@note If no @c tintColor is provided then the @c actionTintColor from the controller will be used.
	*/
	@property(nonatomic, copy, nullable) UIColor *tintColor;

	/**
	The color of the divider at the top of the action.

	@note Defaults to clear.
	*/
	@property(nonatomic, copy, nonnull) UIColor *dividerColor;

	/**
	Controls whether a divider is shown at the top of the action.

	@note Defaults to @c NO.
	*/
	@property(nonatomic, assign) BOOL showsDivider;

	@end