components/schemes/Typography/src/MDCTypographyScheme.h

// 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 "MaterialTypographyScheme+Scheming.h"

API_DEPRECATED_BEGIN("🤖👀 Use Typescale tokens instead (go/material-ios-tokens#typescale-tokens). "
                     "This has go/material-ios-migrations#scriptable-potential 🤖👀",
                     ios(12, 12))

/**
 An enum of default typography schemes that are supported.
 */
typedef NS_ENUM(NSInteger, MDCTypographySchemeDefaults) {
  /**
   The Material defaults, circa April 2018.
   */
  MDCTypographySchemeDefaultsMaterial201804,

  /**
   The Material defaults, circa February 2019.

   This scheme implements fonts with the similar metrics as
   MDCTypographySchemeDefaultsMaterial201804 with the addition that vended fonts will have
   appropriate scalingCurves attached.
   */
  MDCTypographySchemeDefaultsMaterial201902,
};

/**
 A simple implementation of @c MDCTypographyScheming that provides Material default fonts
 from which basic customizations can be made.
 */
@interface MDCTypographyScheme : NSObject <MDCTypographyScheming, NSCopying>

// Redeclare protocol properties as readwrite
@property(nonatomic, nonnull, readwrite, copy) UIFont *headline1;
@property(nonatomic, nonnull, readwrite, copy) UIFont *headline2;
@property(nonatomic, nonnull, readwrite, copy) UIFont *headline3;
@property(nonatomic, nonnull, readwrite, copy) UIFont *headline4;
@property(nonatomic, nonnull, readwrite, copy) UIFont *headline5;
@property(nonatomic, nonnull, readwrite, copy) UIFont *headline6;
@property(nonatomic, nonnull, readwrite, copy) UIFont *subtitle1;
@property(nonatomic, nonnull, readwrite, copy) UIFont *subtitle2;
@property(nonatomic, nonnull, readwrite, copy) UIFont *body1;
@property(nonatomic, nonnull, readwrite, copy) UIFont *body2;
@property(nonatomic, nonnull, readwrite, copy) UIFont *caption;
@property(nonatomic, nonnull, readwrite, copy) UIFont *button;
@property(nonatomic, nonnull, readwrite, copy) UIFont *overline;

/**
 A hint for how fonts in this scheme should be applied to components in relation to Dynamic Type.

 @note Enabling this flag only has an effect if the fonts stored on this scheme are scalable. See
 MDCTypographySchemeDefaults for default versions that are scalable. Alternatively, you can specify
 custom scalable fonts using the MDCFontScaler API.

 When fonts are applied to components:

 - If this flag is disabled, make no changes to the font.
 - If this flag is enabled, adjust the font with respect to the current content size category.

 Default value is NO.
 */
@property(nonatomic, assign, readwrite) BOOL useCurrentContentSizeCategoryWhenApplied;

/**
 Initializes the typography scheme with the latest material defaults.
 */
- (nonnull instancetype)init;

/**
 Initializes the typography scheme with the values associated with the given defaults.
 */
- (nonnull instancetype)initWithDefaults:(MDCTypographySchemeDefaults)defaults;

@end

API_DEPRECATED_END