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

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

Разработчик

Ссылка платформы AppKit ссылка класса NSTextList

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

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

NSTextList

NSTextList объект представляет раздел текста, формирующего единственный список. Видимые элементы списка, включая маркеры списка, появляются в тексте, как они делают для списков, создаваемых вручную. Объект списка, однако, позволяет списку быть распознанным как таковой текстовой системой. Это включает автоматическое создание маркеров и интервал. Текстовые списки используются в импорте HTML и экспорте.

Текстовые списки появляются как атрибуты в абзацах как часть стиля абзаца. NSParagraphStyle может иметь массив текстовых списков, представляя вложенные списки, содержащие абзац, в порядке от наиболее удаленного до самого внутреннего. Например, если list1 содержит четыре абзаца, средние два из которых находятся также во внутреннем list2, тогда текстовый массив списков для первых и четвертых абзацев (list1), в то время как текстовый массив списков для вторых и третьих абзацев (list1, list2).

Методы, реализовывая это textLists на NSParagraphStyle, и setTextLists: на NSMutableParagraphStyle.

Кроме того, NSAttributedString имеет удобные методы для списков:rangeOfTextList:atIndex:, который определяет диапазон, охваченный списком, и itemNumberInTextList:atIndex:, который определяет порядковую позицию в списке определенного элемента.

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

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

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

Swift

import AppKit

Objective C

@import AppKit;

Доступность

Доступный в OS X v10.4 и позже.

Создание текстового списка
  • init (markerFormat:options:) - initWithMarkerFormat:options:

    Возвращает инициализированный текстовый список.

    Объявление

    Swift

    init(markerFormat format: String, options mask: Int)

    Objective C

    - (instancetype)initWithMarkerFormat:(NSString *)format options:(NSUInteger)mask

    Параметры

    format

    Формат маркера для текстового списка.

    mask

    Опции маркера для текстового списка. Значения для mask перечислены в Константах.

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

    Инициализированный текстовый список.

    Обсуждение

    Формат маркера указан как постоянная строка, за исключением спецификатора нумерации, принимающего форму {ключевое слово}. В настоящее время поддерживаемые значения для ключевого слова включают:

    • box

    • check

    • circle

    • diamond

    • disc

    • hyphen

    • square

    • lower-hexadecimal

    • upper-hexadecimal

    • octal

    • lower-alpha или lower-latin

    • upper-alpha или upper-latin

    • lower-roman

    • upper-roman

    • decimal

    Таким образом, например, @"({decimal})" указал бы, что формат для списка пронумеровал (1), (2), (3), и т.д., и @"{upper-roman}" указал бы, что формат для списка перечислил меня, II, III, IV, и т.д. (Все эти ключевые слова включены в спецификацию уровня 3 Каскадных таблиц стилей.)

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

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – markerFormat
    – listOptions

Работа с маркерами
  • markerFormat - markerFormat

    Возвращает строку формата маркера, используемую получателем.

    Объявление

    Swift

    var markerFormat: String { get }

    Objective C

    @property(readonly, copy) NSString *markerFormat

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

    Строка формата маркера используется получателем.

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

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – initWithMarkerFormat:options:

  • markerForItemNumber (_:) - markerForItemNumber:

    Возвращает вычисленное значение для определенной порядковой позиции в списке.

    Объявление

    Swift

    func markerForItemNumber(_ itemNum: Int) -> String

    Objective C

    - (NSString *)markerForItemNumber:(NSInteger)itemNum

    Параметры

    itemNum

    Порядковая позиция в списке, вычисленное значение маркера которого желаемо.

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

    Вычисленный производитель оценивает за itemNum.

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

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.4 и позже.

Получение опций списка
  • listOptions - listOptions

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

    Объявление

    Swift

    var listOptions: NSTextListOptions { get }

    Objective C

    @property(readonly) NSTextListOptions listOptions

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

    Значение маски опций списка получателя.

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

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.4 и позже.

Управление нумерацией элемента
  • startingItemNumber - startingItemNumber

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

    Объявление

    Swift

    var startingItemNumber: Int

    Objective C

    @property NSInteger startingItemNumber

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

    Номер изделия.

    Обсуждение

    Значение по умолчанию 1. Это значение будет использоваться только для упорядоченных списков и игнорироваться в других случаях.

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

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.6 и позже.

    См. также

    – setStartingItemNumber:

  • setStartingItemNumber: - setStartingItemNumber:

    Устанавливает стартовый номер изделия для текстового списка.

    Объявление

    Swift

    var startingItemNumber: Int

    Objective C

    @property NSInteger startingItemNumber

    Параметры

    itemNum

    Номер изделия.

    Обсуждение

    Значение по умолчанию 1. Это значение будет использоваться только для упорядоченных списков и игнорироваться в других случаях.

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

    Objective C

    @import AppKit;

    Swift

    import AppKit

    Доступность

    Доступный в OS X v10.6 и позже.

    См. также

    – startingItemNumber