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

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

Разработчик

Ссылка платформы ApplicationServices ссылка CTLine

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

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

Ссылка CTLine

Непрозрачный тип CTLine представляет строку текста.

Объект CTLine содержит массив выполнений глифа. Объекты линии создаются наборным устройством во время framesetting работы и могут привлечь себя непосредственно в графический контекст.

Функции

  • Создает единственный неизменный объект линии непосредственно из приписанной строки.

    Объявление

    Swift

    func CTLineCreateWithAttributedString(_ string: CFAttributedString!) -> CTLine!

    Objective C

    CTLineRef CTLineCreateWithAttributedString ( CFAttributedStringRef string );

    Параметры

    string

    Строка, из которой создается строка.

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

    Ссылка на CTLine возражает, был ли вызов успешен; иначе, NULL.

    Обсуждение

    Эта функция позволяет клиентам, которым нужна очень простая генерация строки для создания строки, не создавая объект наборного устройства. Набор сделан под капотом. Без объекта наборного устройства не может быть должным образом повреждена строка. Однако для простых вещей как текстовые метки, повреждение строки не является проблемой.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Создает усеченную строку из существующей строки.

    Объявление

    Swift

    func CTLineCreateTruncatedLine(_ line: CTLine!, _ width: Double, _ truncationType: CTLineTruncationType, _ truncationToken: CTLine!) -> CTLine!

    Objective C

    CTLineRef CTLineCreateTruncatedLine ( CTLineRef line, double width, CTLineTruncationType truncationType, CTLineRef truncationToken );

    Параметры

    line

    Строка, из которой можно создать усеченную строку.

    width

    Ширина, в которой начинается усечение. Строка является усеченной, если ее ширина больше, чем ширина передала в этом параметре.

    truncationType

    Тип усечения для выполнения в случае необходимости. Посмотрите CTLineTruncationType для возможных значений.

    truncationToken

    Этот маркер добавляется в точке, где усечение имело место, чтобы указать, что строка была усеченной. Обычно, маркер усечения является символом замещающего знака (U+2026). Если этот параметр устанавливается на NULL, тогда никакой маркер усечения не используется, и строка просто отключена.

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

    Ссылка на усеченный CTLine возражает, был ли вызов успешен; иначе, NULL.

    Обсуждение

    Строка, указанная в truncationToken должен иметь ширину меньше, чем ширина, указанная width параметр. Если ширина строки, указанной в truncationToken больше, чем width и усечение необходимо, функциональные возвраты NULL.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Создает выровненную строку из существующей строки.

    Объявление

    Swift

    func CTLineCreateJustifiedLine(_ line: CTLine!, _ justificationFactor: CGFloat, _ justificationWidth: Double) -> CTLine!

    Objective C

    CTLineRef CTLineCreateJustifiedLine ( CTLineRef line, CGFloat justificationFactor, double justificationWidth );

    Параметры

    line

    Строка, из которой можно создать выровненную строку.

    justificationFactor

    Полное или частичное выравнивание. Когда установлено в 1.0 или большее, полное выравнивание выполняется. Если этот параметр устанавливается на меньше, чем 1.0, различные степени частичного выравнивания выполняются. Если это установлено в 0 или меньше, никакое выравнивание не выполняется.

    justificationWidth

    Ширина, к которой выровнена результирующая строка. Если justificationWidth меньше, чем фактическая ширина строки, тогда отрицательное выравнивание выполняется (т.е. глифы сжаты вместе).

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

    Ссылка на выровненный по ширине CTLine возражает, был ли вызов успешен; иначе, NULL.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Проводит полную линию.

    Объявление

    Swift

    func CTLineDraw(_ line: CTLine!, _ context: CGContext!)

    Objective C

    void CTLineDraw ( CTLineRef line, CGContextRef context );

    Параметры

    line

    Строка для рисования.

    context

    Контекст, в который проведена линия.

    Обсуждение

    Это - функция удобства, потому что строка могла быть нарисованным выполнением-управляемым путем получения выполнений глифа, вытаскивания глифов из них и вызывания функции такой как CGContextShowGlyphsAtPositions. Этот вызов может оставить графический контекст в любом состоянии и не сбрасывает контекст после работы получения.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Возвращается общий глиф значат объект линии.

    Объявление

    Swift

    func CTLineGetGlyphCount(_ line: CTLine!) -> CFIndex

    Objective C

    CFIndex CTLineGetGlyphCount ( CTLineRef line );

    Параметры

    line

    Строка, количество глифа которой возвращается.

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

    Общий глиф значит строку, переданную в.

    Обсуждение

    Общее количество глифа равно сумме всех глифов в выполнениях глифа, формирующих строку.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Возвращает массив выполнений глифа, составляющих объект линии.

    Объявление

    Swift

    func CTLineGetGlyphRuns(_ line: CTLine!) -> CFArray!

    Objective C

    CFArrayRef CTLineGetGlyphRuns ( CTLineRef line );

    Параметры

    line

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

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

    A CFArrayRef содержа объекты CTRun, составляющие строку.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Получает диапазон символов, первоначально породивших глифы в строке.

    Объявление

    Swift

    func CTLineGetStringRange(_ line: CTLine!) -> CFRange

    Objective C

    CFRange CTLineGetStringRange ( CTLineRef line );

    Параметры

    line

    Строка, из которой можно получить строковый диапазон.

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

    A CFRange структура, содержащая диапазон по строке запоминающего устройства, породившей глифы, или если функция перестала работать по какой-либо причине, пустому диапазону.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Получает перьевое смещение, требуемое составлять текст сброса.

    Объявление

    Swift

    func CTLineGetPenOffsetForFlush(_ line: CTLine!, _ flushFactor: CGFloat, _ flushWidth: Double) -> Double

    Objective C

    double CTLineGetPenOffsetForFlush ( CTLineRef line, CGFloat flushFactor, double flushWidth );

    Параметры

    line

    Строка, из которой можно получить позицию сброса.

    flushFactor

    Определяет тип выравнивания. A flushFactor из 0 или меньше указывает оставленный сброс. A flushFactor из 1.0 или больше указывает правильный сброс. Факторы сброса между 0 и 1.0 укажите различные степени центрального сброса со значением 0.5 будучи полностью центральным сбросом.

    flushWidth

    Указывает ширину, к которой должна применяться работа выравнивания.

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

    Смещение от текущей перьевой позиции для работы сброса.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Вычисляет границы изображения для строки.

    Объявление

    Swift

    func CTLineGetImageBounds(_ line: CTLine!, _ context: CGContext!) -> CGRect

    Objective C

    CGRect CTLineGetImageBounds ( CTLineRef line, CGContextRef context );

    Параметры

    line

    Строка, границы изображения которой вычисляются.

    context

    Контекст, для которого вычисляются границы изображения. Это требуется, потому что контекст мог иметь настройки в нем, которые вызовут изменения в границах изображения.

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

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

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Вычисляет типографские границы строки.

    Объявление

    Swift

    func CTLineGetTypographicBounds(_ line: CTLine!, _ ascent: UnsafeMutablePointer<CGFloat>, _ descent: UnsafeMutablePointer<CGFloat>, _ leading: UnsafeMutablePointer<CGFloat>) -> Double

    Objective C

    double CTLineGetTypographicBounds ( CTLineRef line, CGFloat *ascent, CGFloat *descent, CGFloat *leading );

    Параметры

    line

    Строка, типографские границы которой вычисляются.

    ascent

    На выводе, подъеме строки. Этот параметр может быть установлен на NULL если не необходимый.

    descent

    На выводе, спуске строки. Этот параметр может быть установлен на NULL если не необходимый.

    leading

    На выводе, продвижении строки. Этот параметр может быть установлен на NULL если не необходимый.

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

    Типографская ширина строки. Если строка недопустима, эта функция возвраты 0.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Возвращает запаздывающую пробельную ширину для строки.

    Объявление

    Swift

    func CTLineGetTrailingWhitespaceWidth(_ line: CTLine!) -> Double

    Objective C

    double CTLineGetTrailingWhitespaceWidth ( CTLineRef line );

    Параметры

    line

    Строка, запаздывающая пробельная ширина которой вычисляется.

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

    Ширина запаздывания строки пробела. Если строка будет недопустима, то эта функция будет всегда возвращать нуль.

    Обсуждение

    Создание строки для ширины может привести к строке, которая фактически более длинна, чем желаемая ширина вследствие запаздывающего пробела. Несмотря на то, что это обычно - не проблема вследствие пробела, являющегося невидимым, эта функция может использоваться для определения то, что сумма ширины строки вследствие запаздывающего пробела.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Выполняет тестирование хита.

    Объявление

    Swift

    func CTLineGetStringIndexForPosition(_ line: CTLine!, _ position: CGPoint) -> CFIndex

    Objective C

    CFIndex CTLineGetStringIndexForPosition ( CTLineRef line, CGPoint position );

    Параметры

    line

    Исследуемая строка.

    position

    Расположение щелчка мышью относительно источника строки.

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

    Индекс строк для позиции, или если строка не поддерживает строковый доступ, kCFNotFound. Относительно строкового диапазона строки это значение может быть не меньше, чем первым индексом строк и не больше, чем последний индекс строк плюс 1.

    Обсуждение

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

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Определяет графическое смещение или смещения для индекса строк.

    Объявление

    Swift

    func CTLineGetOffsetForStringIndex(_ line: CTLine!, _ charIndex: CFIndex, _ secondaryOffset: UnsafeMutablePointer<CGFloat>) -> CGFloat

    Objective C

    CGFloat CTLineGetOffsetForStringIndex ( CTLineRef line, CFIndex charIndex, CGFloat *secondaryOffset );

    Параметры

    line

    Строка, от которой требуют смещение.

    charIndex

    Индекс строк, соответствующий желаемой позиции.

    secondaryOffset

    На выводе, вторичном смещении вдоль базовой линии для charIndex. Когда единственное каре будет достаточно для индекса строк, это значение совпадет с основным смещением, которое является возвращаемым значением этой функции. Может быть NULL.

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

    Основное смещение вдоль базовой линии для charIndex, или 0.0 если строка не поддерживает строковый доступ.

    Обсуждение

    Эта функция возвращает графическое смещение или смещения, соответствующие индексу строк, подходящему для перемещения между смежными строками или для рисования пользовательского каре. Для перемещения между смежными строками основное смещение может быть приведено в соответствие с любым относительным добавлением отступа этих двух строк; a CGPoint созданный со скорректированным смещением для x значение и 0.0 для y значение подходит для передачи CTLineGetStringIndexForPosition. Для рисования пользовательского каре возвращенное основное смещение соответствует части каре, представляющего визуальное расположение вставки для символа, направление которого соответствует направление записи строки.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Возвращает Базовый идентификатор типа Основы объекта линии.

    Объявление

    Swift

    func CTLineGetTypeID() -> CFTypeID

    Objective C

    CFTypeID CTLineGetTypeID ( void );

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

Типы данных

  • Ссылка на объект линии.

    Объявление

    Swift

    typealias CTLineRef = CTLine

    Objective C

    typedef const struct __CTLine *CTLineRef;

    Доступность

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

Константы

  • Типы усечения, требуемые CTLineCreateTruncatedLine функция для сообщения механизма усечения, какой тип усечения требуют.

    Объявление

    Swift

    enum CTLineTruncationType : UInt32 { case Start case End case Middle }

    Objective C

    enum{ kCTLineTruncationStart = 0, kCTLineTruncationEnd = 1, kCTLineTruncationMiddle = 2 }; typedef uint32_t CTLineTruncationType;

    Константы

    • Start

      kCTLineTruncationStart

      Усеките начало строки, оставляя часть конца видимой.

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

    • End

      kCTLineTruncationEnd

      Усеките конец строки, оставив часть запуска видимой.

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

    • Middle

      kCTLineTruncationMiddle

      Усеките середину строки, уезжая и запуск и части конца видимый.

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

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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