Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека Разработчика iOS

Разработчик

Ссылка платформы основы ссылка класса NSEnergyFormatter

Опции
Развертывание Target:

На этой странице
Язык:

NSEnergyFormatter

Наследование

Соответствует

Оператор импорта

Swift

import Foundation

Objective C

@import Foundation;

Доступность

Доступный в iOS 8.0 и позже.

NSEnergyFormatter класс предоставляет должным образом отформатированные, локализованные описания энергетической ценности. Используйте этот класс для создания локализованных строк при отображении информации об энергии (например, джоули или калории) пользователям.

Форматирование энергетических строк
  • forFoodEnergyUse Свойство

    Булево значение, указывающее, используется ли энергетическая ценность для измерения продовольственной энергии.

    Объявление

    Swift

    var forFoodEnergyUse: Bool

    Objective C

    @property(getter=isForFoodEnergyUse) BOOL forFoodEnergyUse

    Обсуждение

    YEStrue если энергия используется для измерения продовольственной энергии; иначе, NOfalse. Это свойство значения по умолчанию к NOfalse. Если установлено в YEStrue, NSEnergyFormatterUnitKilocalorie может быть представлен с помощью «C» вместо «kcal».

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 8.0 и позже.

  • getObjectValue (_: forString:errorDescription:) - getObjectValue:forString:errorDescription:

    Этот метод не поддерживается для NSEnergyFormatter класс.

    Объявление

    Swift

    func getObjectValue(_ obj: AutoreleasingUnsafeMutablePointer<AnyObject?>, forString string: String, errorDescription error: AutoreleasingUnsafeMutablePointer<NSString?>) -> Bool

    Objective C

    - (BOOL)getObjectValue:(out id *)obj forString:(NSString *)string errorDescription:(out NSString **)error

    Параметры

    obj

    Выходной параметр. Если переопределено, этот параметр должен содержать объект, создаваемый из предоставленной строки.

    string

    Строковое представление объекта.

    error

    Выходной параметр. Если переопределено, этот параметр должен содержать описание любых происходящих ошибок. Если Вы не хотите получать сообщения об ошибках, установите этот параметр на NULL.

    Возвращаемое значение

    YEStrue если преобразование из строки было успешно; иначе, NOfalse.

    Обсуждение

    Можно переопределить этот метод в подклассе. Для получения дополнительной информации см. Ссылку класса NSFormatter.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 8.0 и позже.

    См. также

    – getObjectValue:forString:errorDescription:

  • numberFormatter Свойство

    Средство форматирования числа раньше форматировало числа в энергетических строках.

    Объявление

    Swift

    @NSCopying var numberFormatter: NSNumberFormatter

    Objective C

    @property(copy) NSNumberFormatter *numberFormatter

    Обсуждение

    Это свойство значения по умолчанию к средству форматирования числа с помощью NSNumberFormatterDecimalStyle стиль. Можно обеспечить различное средство форматирования числа для настройки энергетического появления строки.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 8.0 и позже.

  • stringFromJoules (_:) - stringFromJoules:

    Возвращает энергетическую строку для предоставленного значения.

    Объявление

    Swift

    func stringFromJoules(_ numberInJoules: Double) -> String

    Objective C

    - (NSString *)stringFromJoules:(double)numberInJoules

    Параметры

    numberInJoules

    Энергетическая ценность в джоулях.

    Возвращаемое значение

    Строка, комбинирующая значение и строку модуля, подходящую для локали средства форматирования.

    Обсуждение

    Этот метод преобразовывает предоставленное значение в джоулях в модули, надлежащие локали средства форматирования.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 8.0 и позже.

  • stringFromValue (_: модуль:) - stringFromValue:unit:

    Возвращает должным образом отформатированную энергетическую строку для данного значения и модуля.

    Объявление

    Swift

    func stringFromValue(_ value: Double, unit unit: NSEnergyFormatterUnit) -> String

    Objective C

    - (NSString *)stringFromValue:(double)value unit:(NSEnergyFormatterUnit)unit

    Параметры

    value

    Энергетическая ценность в данном модуле.

    unit

    Модуль используется в получающейся энергетической строке.

    Возвращаемое значение

    Локализованная строка, комбинирующая предоставленное значение и модуль.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 8.0 и позже.

  • unitStringFromJoules (_: usedUnit:) - unitStringFromJoules:usedUnit:

    Возвращает строку модуля для предоставленного значения.

    Объявление

    Swift

    func unitStringFromJoules(_ numberInJoules: Double, usedUnit unitp: UnsafeMutablePointer<NSEnergyFormatterUnit>) -> String

    Objective C

    - (NSString *)unitStringFromJoules:(double)numberInJoules usedUnit:(NSEnergyFormatterUnit *)unitp

    Параметры

    numberInJoules

    Энергетическая ценность в джоулях.

    unitp

    Выходной параметр. Это будет содержать NSEnergyFormatterUnit значение, соответствующее возвращенным модулям.

    Возвращаемое значение

    Локализованная строка, представляющая модуль.

    Обсуждение

    Этот метод выбирает корректный модуль на основе локали средства форматирования, величины значения, и forFoodEnergyUse свойство.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 8.0 и позже.

  • unitStringFromValue (_: модуль:) - unitStringFromValue:unit:

    Возвращает строку модуля на основе предоставленного значения и модуля.

    Объявление

    Swift

    func unitStringFromValue(_ value: Double, unit unit: NSEnergyFormatterUnit) -> String

    Objective C

    - (NSString *)unitStringFromValue:(double)value unit:(NSEnergyFormatterUnit)unit

    Параметры

    value

    Энергетическая ценность в предоставленном модуле.

    unit

    Модуль для использования в получающейся энергетической строке.

    Возвращаемое значение

    Локализованная строка, представляющая данный модуль. Предоставленное значение определяет, является ли модуль множественным числом или исключительный.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 8.0 и позже.

  • unitStyle Свойство

    Стиль модуля используется этим средством форматирования.

    Объявление

    Swift

    var unitStyle: NSFormattingUnitStyle

    Objective C

    @property NSFormattingUnitStyle unitStyle

    Обсуждение

    Это свойство значения по умолчанию к NSFormattingUnitStyleMedium. Для полного списка стилей модуля посмотрите Formatting Units.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 8.0 и позже.

Константы
  • NSEnergyFormatterUnit

    Модули, поддерживаемые NSEnergyFormatter класс.

    Объявление

    Swift

    enum NSEnergyFormatterUnit : Int { case Joule case Kilojoule case Calorie case Kilocalorie }

    Objective C

    typedef enum : NSInteger { NSEnergyFormatterUnitJoule = 11, NSEnergyFormatterUnitKilojoule = 14, NSEnergyFormatterUnitCalorie = (7 << 8) + 1, NSEnergyFormatterUnitKilocalorie = (7 << 8) + 2, } NSEnergyFormatterUnit;

    Константы

    • Joule

      NSEnergyFormatterUnitJoule

      Джоулев модуль.

      Доступный в iOS 8.0 и позже.

    • Kilojoule

      NSEnergyFormatterUnitKilojoule

      Модуль килоджоуля.

      Доступный в iOS 8.0 и позже.

    • Calorie

      NSEnergyFormatterUnitCalorie

      Модуль калории. Этот модуль часто используется в химии. Это сокращено как «cal».

      Доступный в iOS 8.0 и позже.

    • Kilocalorie

      NSEnergyFormatterUnitKilocalorie

      Модуль килокалории. Этот модуль используется для продовольственных калорий в некоторых локалях. В целом это сокращено как «kcal». Однако это может быть сокращено как «C», когда используется представлять продовольственные калории.

      Доступный в iOS 8.0 и позже.

    Оператор импорта

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в iOS 8.0 и позже.