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

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

Разработчик

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

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

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

Ссылка CTFrame

Непрозрачный тип CTFrame представляет кадр, содержащий многократные строки текста. Объект кадра является выводом, следующим из структурирующего текст процесса, выполняемого объектом framesetter.

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

Функции

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

    Объявление

    Swift

    func CTFrameGetStringRange(_ frame: CTFrame!) -> CFRange

    Objective C

    CFRange CTFrameGetStringRange ( CTFrameRef frame );

    Параметры

    frame

    Кадр, диапазон символов которого возвращается.

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

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

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

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

    Объявление

    Swift

    func CTFrameGetVisibleStringRange(_ frame: CTFrame!) -> CFRange

    Objective C

    CFRange CTFrameGetVisibleStringRange ( CTFrameRef frame );

    Параметры

    frame

    Кадр, диапазон видимого символа которого возвращается.

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

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

    Обсуждение

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

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

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

    Объявление

    Swift

    func CTFrameGetPath(_ frame: CTFrame!) -> CGPath!

    Objective C

    CGPathRef CTFrameGetPath ( CTFrameRef frame );

    Параметры

    frame

    Кадр, путь которого возвращается.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

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

    Объявление

    Swift

    func CTFrameGetFrameAttributes(_ frame: CTFrame!) -> CFDictionary!

    Objective C

    CFDictionaryRef CTFrameGetFrameAttributes ( CTFrameRef frame );

    Параметры

    frame

    Кадр, атрибуты которого возвращаются.

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

    Ссылка на объект CFDictionary, содержащий атрибуты кадра, использовавшиеся для создания кадра, или, если кадр создавался без каких-либо атрибутов кадра, NULL.

    Обсуждение

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

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Возвращает массив строк, сохраненных в кадре.

    Объявление

    Swift

    func CTFrameGetLines(_ frame: CTFrame!) -> CFArray!

    Objective C

    CFArrayRef CTFrameGetLines ( CTFrameRef frame );

    Параметры

    frame

    Кадр, массив строки которого возвращается.

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

    Объект CFArray, содержащий объекты CTLine, составляющие кадр, или, при отсутствии строк в кадре, массиве без элементов.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Копирует диапазон источников строки для кадра.

    Объявление

    Swift

    func CTFrameGetLineOrigins(_ frame: CTFrame!, _ range: CFRange, _ origins: UnsafeMutablePointer<CGPoint>)

    Objective C

    void CTFrameGetLineOrigins ( CTFrameRef frame, CFRange range, CGPoint origins[] );

    Параметры

    frame

    Кадр, массив источника строки которого копируется.

    range

    Диапазон источников строки Вы хотите скопировать. Если длина диапазона 0, то работа копии продолжается от индекса запуска диапазона к последнему источнику строки.

    origins

    Буфер, в который копируются источники. Буфер должен иметь, по крайней мере, столько же элементов, сколько указано длиной диапазона. Каждый CGPoint в этом массиве источник соответствующей строки в массиве строк, возвращенных CTFrameGetLines относительно источника ограничительной рамки пути, которая может быть получена из CGPathGetPathBoundingBox.

    Обсуждение

    Эта функция копирует диапазон CGPoint структуры в origins буфер. Максимальное количество источников строки эта функция скопирует в origins буфер является количеством массива строк (длина range параметр).

    Специальные замечания

    Если кадр не является прямоугольным, в версиях OS X до 10,7 и версиях iOS до 4,2, эта функция может функционировать непредсказуемо.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Вовлекает весь кадр в контекст.

    Объявление

    Swift

    func CTFrameDraw(_ frame: CTFrame!, _ context: CGContext!)

    Objective C

    void CTFrameDraw ( CTFrameRef frame, CGContextRef context );

    Параметры

    frame

    Кадр для рисования.

    context

    Контекст, в котором можно нарисовать кадр.

    Обсуждение

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

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Возвращает идентификатор типа для непрозрачного типа CTFrame.

    Объявление

    Swift

    func CTFrameGetTypeID() -> CFTypeID

    Objective C

    CFTypeID CTFrameGetTypeID ( void );

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

    Идентификатор типа для непрозрачного типа CTFrame.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

Типы данных

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

    Объявление

    Swift

    typealias CTFrameRef = CTFrame

    Objective C

    typedef const struct __CTFrame *CTFrameRef;

    Доступность

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

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

    Объявление

    Swift

    enum CTFramePathFillRule : UInt32 { case EvenOdd case WindingNumber }

    Objective C

    enum { kCTFramePathFillEvenOdd = 0, kCTFramePathFillWindingNumber = 1 }; typedef uint32_t CTFramePathFillRule;

    Обсуждение

    Для описаний констант посмотрите Константы CTFramePathFillRule.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

Константы

  • Эти константы указывают типы прогрессии кадра.

    Объявление

    Swift

    enum CTFrameProgression : UInt32 { case TopToBottom case RightToLeft case LeftToRight }

    Objective C

    enum{ kCTFrameProgressionTopToBottom = 0, kCTFrameProgressionRightToLeft = 1 }; typedef uint32_t CTFrameProgression;

    Константы

    • TopToBottom

      kCTFrameProgressionTopToBottom

      Строки сложены от начала до конца для горизонтального текста.

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

    • RightToLeft

      kCTFrameProgressionRightToLeft

      Строки сложены справа налево для вертикального текста.

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

    Обсуждение

    Строки текста в кадре могут быть сложены или для горизонтального или для вертикального текста. Значения перечисляются для каждого типа укладки, поддерживаемого CTFrame. Кадры, создаваемые с типом прогрессии, указывающим вертикальный текст, поворачивают строки 90 градусов против часовой стрелки при рисовании.

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

    Objective C

    @import CoreText;

    Swift

    import CoreText

    Доступность

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

  • Эти константы указывают правило заливки, используемое кадром

    Объявление

    Swift

    enum CTFramePathFillRule : UInt32 { case EvenOdd case WindingNumber }

    Objective C

    enum { kCTFramePathFillEvenOdd = 0, kCTFramePathFillWindingNumber = 1 }; typedef uint32_t CTFramePathFillRule;

    Константы

    • EvenOdd

      kCTFramePathFillEvenOdd

      Текст заполнен в области, которая была бы нарисована, если бы пути дали CGContextEOFillPath.

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

    • WindingNumber

      kCTFramePathFillWindingNumber

      Текст, заполняют область, которая была бы нарисована, если бы пути дали CGContextFillPath.

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

    Обсуждение

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

  • Указывает прогрессию для кадра.

    Объявление

    Swift

    let kCTFrameProgressionAttributeName: CFString!

    Objective C

    const CFStringRef kCTFrameProgressionAttributeName;

    Константы

    • kCTFrameProgressionAttributeName

      kCTFrameProgressionAttributeName

      A CFNumberRef объект, содержащий постоянный CTFrameProgression. Значение по умолчанию kCTFrameProgressionTopToBottom.

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

    Обсуждение

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

  • Ключ раньше указывал правило заливки для кадра.

    Объявление

    Swift

    let kCTFramePathFillRuleAttributeName: CFString!

    Objective C

    extern const CFStringRef kCTFramePathFillRuleAttributeName;

    Константы

  • Ключ раньше указывал ширину кадра.

    Объявление

    Swift

    let kCTFramePathWidthAttributeName: CFString!

    Objective C

    extern const CFStringRef kCTFramePathWidthAttributeName;

    Константы

    • kCTFramePathWidthAttributeName

      kCTFramePathWidthAttributeName

      Значение должно быть a CFNumberRef объект, содержащий значение, указывающее ширину кадра. Значение ширины по умолчанию является нулем.

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

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

    Объявление

    Swift

    let kCTFrameClippingPathsAttributeName: CFString!

    Objective C

    extern const CFStringRef kCTFrameClippingPathsAttributeName CT_AVAILABLE_STARTING( __MAC_10_7, __IPHONE_4_3);

    Константы

    • kCTFrameClippingPathsAttributeName

      kCTFrameClippingPathsAttributeName

      Значение должно быть a CFArrayRef содержа CFDictionaryRefs. Каждый словарь должен иметь a kCTFramePathClippingPathAttributeName пара ключ/значение, и может иметь a kCTFramePathFillRuleAttributeName пара ключ/значение и kCTFramePathFillRuleAttributeName пара ключ/значение как дополнительные параметры.

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

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

    Объявление

    Swift

    let kCTFramePathClippingPathAttributeName: CFString!

    Objective C

    extern const CFStringRef kCTFramePathClippingPathAttributeName CT_AVAILABLE_STARTING( __MAC_10_7, __IPHONE_4_3);

    Константы

    • kCTFramePathClippingPathAttributeName

      kCTFramePathClippingPathAttributeName

      Значение должно быть a CGPathRef указание кусочка отсечения. См. kCTFrameClippingPathsAttributeName.

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