Ссылка CGPDFContext

Заголовочный файл CGPDFContext определяет функции, создающие и получающие информацию о Кварце контекст PDF. Объект CGPDFContext является типом CGContextRef это используется для рисования содержания PDF. Функции в этой ссылке воздействуют только на Кварц, контексты графики PDF создали использование функций CGPDFContextCreate или CGPDFContextCreateWithURL.

Когда Вы рисуете к контексту PDF с помощью функций CGContext, операции рисования зарегистрированы в Формате PDF. Команды PDF, представляющие получение, записаны в место назначения, указанное при создании контекста графики PDF.

Функции

Создание контекста


    
    CGPDFContextCreate (_: _: _:)
    CGPDFContextCreate

Создает контекст графики PDF.

Объявление

Swift

func CGPDFContextCreate(_ consumer: CGDataConsumer!, _ mediaBox: UnsafePointer<CGRect>, _ auxiliaryInfo: CFDictionary!) -> CGContext!

Objective C

CGContextRef CGPDFContextCreate ( CGDataConsumerRef consumer, const CGRect *mediaBox, CFDictionaryRef auxiliaryInfo );

Параметры

`consumer`	Потребитель данных для получения выходных данных PDF.
`mediaBox`	Указатель на прямоугольник, определяющий размер и расположение страницы PDF, или `NULL`. Источник прямоугольника должен обычно быть `(0,0)`. Кварц использует этот прямоугольник в качестве границ по умолчанию поля носителей страницы. Если Вы передаете `NULL`, Кварц использует размер страницы по умолчанию 8,5 на 11 дюймов (612 792 точками).
`auxiliaryInfo`	Словарь, указывающий любую дополнительную информацию, которая будет использоваться контекстом PDF при генерации файла PDF, или `NULL`. Словарь сохраняется новым контекстом, таким образом, по возврату можно безопасно выпустить его. Посмотрите Вспомогательные Ключи Словаря для ключей, которые можно включать в словарь.

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

Новый контекст PDF, или NULL если не может быть создан контекст. Вы ответственны за выпуск этого объектного использования CGContextRelease.

Обсуждение

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

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

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

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


    
    CGPDFContextCreateWithURL (_: _: _:)
    CGPDFContextCreateWithURL

Создает ОСНОВАННЫЙ НА URL контекст графики PDF.

Объявление

Swift

func CGPDFContextCreateWithURL(_ url: CFURL!, _ mediaBox: UnsafePointer<CGRect>, _ auxiliaryInfo: CFDictionary!) -> CGContext!

Objective C

CGContextRef CGPDFContextCreateWithURL ( CFURLRef url, const CGRect *mediaBox, CFDictionaryRef auxiliaryInfo );

Параметры

`url`	Базовый URL Основы, указывающий, где Вы хотите поместить получающийся файл PDF.
`mediaBox`	Прямоугольник, указывающий границы PDF. Источник прямоугольника должен обычно быть `(0,0)`. `CGPDFContextCreateWithURL` функционируйте использует этот прямоугольник в качестве ограничительной рамки носителей страницы по умолчанию. Если Вы передаете `NULL`, `CGPDFContextCreateWithURL` использует размер страницы по умолчанию 8,5 на 11 дюймов (612 792 точками).
`auxiliaryInfo`	Словарь, указывающий любую дополнительную информацию, которая будет использоваться контекстом PDF при генерации файла PDF, или `NULL`. Словарь сохраняется новым контекстом, таким образом, по возврату можно безопасно выпустить его.

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

Новый контекст PDF, или NULL если не мог бы быть создан контекст. Вы ответственны за выпуск этого объектного использования CGContextRelease.

Обсуждение

Когда Вы вызываете эту функцию, Кварц создает среду рисования PDF — т.е. графический контекст — к Вашим спецификациям. Когда Вы вовлекаете получающийся контекст, Кварц представляет Ваше получение как ряд команд рисования PDF, сохраненных в указанном расположении.

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

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

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

Начало и конечные страницы


    
    CGPDFContextBeginPage (_: _:)
    CGPDFContextBeginPage

Начинает новую страницу в контексте графики PDF.

Объявление

Swift

func CGPDFContextBeginPage(_ context: CGContext!, _ pageInfo: CFDictionary!)

Objective C

void CGPDFContextBeginPage ( CGContextRef context, CFDictionaryRef pageInfo );

Параметры

`context`	Контекст графики PDF.
`pageInfo`	Словарь, содержащий пары ключ/значение, определяющие свойства страницы.

Обсуждение

Необходимо вызвать функцию CGPDFContextEndPage сигнализировать конец страницы.

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

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

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

CGPDFContextEndPage (_:) CGPDFContextEndPage

Заканчивает текущую страницу в контексте графики PDF.

Объявление

Swift

func CGPDFContextEndPage(_ context: CGContext!)

Objective C

void CGPDFContextEndPage ( CGContextRef context );

Параметры

context

Контекст графики PDF.

Обсуждение

Можно вызвать CGPDFContextEndPage только после того, как Вы вызываете функцию CGPDFContextBeginPage.

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

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

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

Работа с местами назначения


    
    CGPDFContextAddDestinationAtPoint (_: _: _:)
    CGPDFContextAddDestinationAtPoint

Устанавливает место назначения для перехода к тому, когда щелкают по точке на текущей странице контекста графики PDF.

Объявление

Swift

func CGPDFContextAddDestinationAtPoint(_ context: CGContext!, _ name: CFString!, _ point: CGPoint)

Objective C

void CGPDFContextAddDestinationAtPoint ( CGContextRef context, CFStringRef name, CGPoint point );

Параметры

`context`	Контекст графики PDF.
`name`	Целевое имя.
`point`	Расположение на текущей странице контекста графики PDF.

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

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

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


    
    CGPDFContextSetDestinationForRect (_: _: _:)
    CGPDFContextSetDestinationForRect

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

Объявление

Swift

func CGPDFContextSetDestinationForRect(_ context: CGContext!, _ name: CFString!, _ rect: CGRect)

Objective C

void CGPDFContextSetDestinationForRect ( CGContextRef context, CFStringRef name, CGRect rect );

Параметры

`context`	Контекст графики PDF.
`name`	Целевое имя.
`rect`	Прямоугольник, указывающий область текущей страницы контекста графики PDF. Прямоугольник указан в пространстве пользователя по умолчанию (не пространство устройства).

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

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

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


    
    CGPDFContextSetURLForRect (_: _: _:)
    CGPDFContextSetURLForRect

Устанавливает URL, связанный с прямоугольником в контексте графики PDF.

Объявление

Swift

func CGPDFContextSetURLForRect(_ context: CGContext!, _ url: CFURL!, _ rect: CGRect)

Objective C

void CGPDFContextSetURLForRect ( CGContextRef context, CFURLRef url, CGRect rect );

Параметры

`context`	Контекст графики PDF.
`url`	Объект CFURL, указывающий место назначения содержания, связанного с прямоугольником.
`rect`	Прямоугольник, указанный в пространстве пользователя по умолчанию (не пространство устройства).

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

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

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

Работа с метаданными


    
    CGPDFContextAddDocumentMetadata (_: _:)
    CGPDFContextAddDocumentMetadata

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

Объявление

Swift

func CGPDFContextAddDocumentMetadata(_ context: CGContext!, _ metadata: CFData!)

Objective C

void CGPDFContextAddDocumentMetadata ( CGContextRef context, CFDataRef metadata );

Параметры

`context`	Контекст графики PDF.
`metadata`	Поток данных XML, отформатированный согласно Расширяемой платформе метаданных, как описано в разделе 10.2.2., “Потоки Метаданных”, из спецификации PDF 1.7.

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

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

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

Закрытие контекста PDF

CGPDFContextClose (_:) CGPDFContextClose

Закрывает документ в формате PDF.

Объявление

Swift

func CGPDFContextClose(_ context: CGContext!)

Objective C

void CGPDFContextClose ( CGContextRef context );

Параметры

context

Контекст графики PDF.

Обсуждение

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

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

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

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

Константы

Вспомогательные ключи словаря
Ключи, раньше устанавливавшие контекст PDF.

Объявление

Swift

let kCGPDFContextAuthor: CFString! let kCGPDFContextCreator: CFString! let kCGPDFContextTitle: CFString! let kCGPDFContextOwnerPassword: CFString! let kCGPDFContextUserPassword: CFString! let kCGPDFContextAllowsPrinting: CFString! let kCGPDFContextAllowsCopying: CFString! let kCGPDFContextOutputIntent: CFString! let kCGPDFContextOutputIntents: CFString! let kCGPDFContextSubject: CFString! let kCGPDFContextKeywords: CFString! let kCGPDFContextEncryptionKeyLength: CFString!

Objective C

CFStringRef kCGPDFContextAuthor; CFStringRef kCGPDFContextCreator; CFStringRef kCGPDFContextTitle; CFStringRef kCGPDFContextOwnerPassword; CFStringRef kCGPDFContextUserPassword; CFStringRef kCGPDFContextAllowsPrinting; CFStringRef kCGPDFContextAllowsCopying; CFStringRef kCGPDFContextOutputIntent; CFStringRef kCGPDFContextOutputIntents; CFStringRef kCGPDFContextSubject; CFStringRef kCGPDFContextKeywords; CFStringRef kCGPDFContextEncryptionKeyLength;

Константы
- kCGPDFContextAuthor
  
  kCGPDFContextAuthor
  
  Соответствующее значение является строкой, представляющей имя лица, создавшего документ. Этот ключ является дополнительным.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFContextCreator
  
  kCGPDFContextCreator
  
  Соответствующее значение является строкой, представляющей имя приложения, используемого для представления документа. Этот ключ является дополнительным.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFContextTitle
  
  kCGPDFContextTitle
  
  Соответствующее значение является строкой, представляющей заголовок документа. Этот ключ является дополнительным.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFContextOwnerPassword
  
  kCGPDFContextOwnerPassword
  
  Пароль владельца документа в формате PDF. Если этот ключ указан, документ шифруется с помощью значения в качестве пароля владельца; иначе, документ не будет зашифрован. Значение этого ключа должно быть объектом CFString, который может быть представлен в кодировании ASCII. Только первые 32 байта используются для пароля. Нет никакого значения по умолчанию для этого ключа. Если значение этого ключа не может быть представлено в ASCII, документ не создается и возвраты функции создания NULL.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFContextUserPassword
  
  kCGPDFContextUserPassword
  
  Пароль пользователя документа в формате PDF. Если документ будет зашифрован, то значение этого ключа будет паролем пользователя для документа. Если не указанный, пароль пользователя является пустой строкой. Значение этого ключа должно быть объектом CFString, который может быть представлен в кодировании ASCII; только первые 32 байта будут использоваться для пароля. Если значение этого ключа не может быть представлено в ASCII, документ не создается и возвраты функции создания NULL.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFContextAllowsPrinting
  
  kCGPDFContextAllowsPrinting
  
  Позволяет ли документ распечатывать, когда разблокировано с паролем пользователя. Значение этого ключа должно быть значением CFBoolean. Значение по умолчанию этого ключа kCFBooleanTrue.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFContextAllowsCopying
  
  kCGPDFContextAllowsCopying
  
  Позволяет ли документ копировать, когда разблокировано с паролем пользователя. Значение этого ключа должно быть объектом CFBoolean. Значение по умолчанию этого ключа kCFBooleanTrue.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFContextOutputIntent
  
  kCGPDFContextOutputIntent
  
  Выходное намерение PDF/X. Этот ключ является дополнительным. Если настоящее, значение этого ключа должно быть объектом CFDictionary. Словарь добавляется к /OutputIntents запись в каталоге документа файла PDF. Ключи и значения, содержавшиеся в словаре, должны соответствовать указанных в разделе 9.10.4 из спецификации PDF 1.4, ISO/DIS 15930-3 документа, опубликованные ISO/TC 130, и Adobe Technical Note № 5413.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFContextOutputIntents
  
  kCGPDFContextOutputIntents
  
  Выходные словари намерения. Этот ключ является дополнительным. Если настоящее, значение должно быть массивом один или больше kCGPDFContextOutputIntent словари. Массив добавляется к документу в формате PDF в /OutputIntents запись в каталоге документа файла PDF. Каждый словарь в массиве должен иметь форму, указанную для kCGPDFContextOutputIntent ключ, за исключением того, что только первый словарь в массиве требуется, чтобы содержать ключ «S» со значением GTS_PDFX. Если оба kCGPDFContextOutputIntent и kCGPDFContextOutputIntents ключи указаны, прежний проигнорирован.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFContextSubject
  
  kCGPDFContextSubject
  
  Предмет документа. Дополнительный; если настоящее, значение этого ключа должно быть a CFString объект.
  
  Доступный в OS X v10.5 и позже.
- kCGPDFContextKeywords
  
  kCGPDFContextKeywords
  
  Ключевые слова для этого документа. Этот ключ является дополнительным. Если значение этого ключа является a CFString объект, /Keywords запись будет указанной строкой. Если значение этого ключа является a CFArray объект, тогда это должен быть массив CFString объекты. /Keywords запись, в этом случае, будет связью указанных строк, разделенных запятыми (","). Кроме того, запись с ключом "/AAPL:Keywords" сохранен в словаре информации о документе; его значение является массивом, состоящим из каждой из указанных строк. Значение этого ключа должно быть в одной из вышеупомянутых форм; иначе, этот ключ проигнорирован.
  
  Доступный в OS X v10.5 и позже.
- kCGPDFContextEncryptionKeyLength
  
  kCGPDFContextEncryptionKeyLength
  
  Длина ключа шифрования в битах; посмотрите Таблицу 3.18 «Записи, характерные для всех словарей шифрования», Ссылка PDF: версия 1.5 Adobe PDF (4-й редактор) для получения дополнительной информации. Дополнительный; если настоящее, значение этого ключа должно быть a CFNumber объект со значением, которое является кратным числом 8 между 40 и 128, включительно. Если этот ключ отсутствует или недопустим, значения по умолчанию длины ключа шифрования к 40 битам.
  
  Доступный в OS X v10.5 и позже.
Обсуждение

Для получения дополнительной информации об использовании этих ключей в контексте PDF посмотрите CGPDFContextCreate и CGPDFContextCreateWithURL.

Доступность

Доступный в OS X v10.4 и позже.
Ключи словаря поля
Ключи, указывающие различные поля PDF.

Объявление

Swift

let kCGPDFContextMediaBox: CFString! let kCGPDFContextCropBox: CFString! let kCGPDFContextBleedBox: CFString! let kCGPDFContextTrimBox: CFString! let kCGPDFContextArtBox: CFString!

Objective C

CFStringRef kCGPDFContextMediaBox CFStringRef kCGPDFContextCropBox CFStringRef kCGPDFContextBleedBox CFStringRef kCGPDFContextTrimBox CFStringRef kCGPDFContextArtBox

Константы
- kCGPDFContextMediaBox
  
  kCGPDFContextMediaBox
  
  Поле носителей для документа или для данной страницы. Этот ключ является дополнительным. Если настоящее, значение этого ключа должно быть объектом CFData, содержащим a CGRect (сохраненный значением, не ссылкой).
  
  Доступный в OS X v10.4 и позже.
- kCGPDFContextCropBox
  
  kCGPDFContextCropBox
  
  Поле обрезки для документа или для данной страницы. Этот ключ является дополнительным. Если настоящее, значение этого ключа должно быть объектом CFData, содержащим a CGRect (сохраненный значением, не ссылкой).
  
  Доступный в OS X v10.4 и позже.
- kCGPDFContextBleedBox
  
  kCGPDFContextBleedBox
  
  Поле выхода за край для документа или для данной страницы. Этот ключ является дополнительным. Если настоящее, значение этого ключа должно быть объектом CFData, содержащим a CGRect (сохраненный значением, не ссылкой).
  
  Доступный в OS X v10.4 и позже.
- kCGPDFContextTrimBox
  
  kCGPDFContextTrimBox
  
  Поле для обрезки для документа или для данной страницы. Этот ключ является дополнительным. Если настоящее, значение этого ключа должно быть объектом CFData, содержащим a CGRect (сохраненный значением, не ссылкой).
  
  Доступный в OS X v10.4 и позже.
- kCGPDFContextArtBox
  
  kCGPDFContextArtBox
  
  Художественное поле для документа или для данной страницы. Этот ключ является дополнительным. Если настоящее, значение этого ключа должно быть объектом CFData, содержащим a CGRect (сохраненный значением, не ссылкой).
  
  Доступный в OS X v10.4 и позже.
Обсуждение

Для получения дополнительной информации об использовании этих ключей в контексте PDF посмотрите CGPDFContextCreate и CGPDFContextCreateWithURL.

Доступность

Доступный в OS X v10.4 и позже.
Выходные ключи словаря намерения
Ключи для указания выходных опций намерения.

Объявление

Swift

let kCGPDFXOutputIntentSubtype: CFString! let kCGPDFXOutputConditionIdentifier: CFString! let kCGPDFXOutputCondition: CFString! let kCGPDFXRegistryName: CFString! let kCGPDFXInfo: CFString! let kCGPDFXDestinationOutputProfile: CFString!

Objective C

CFStringRef kCGPDFXOutputIntentSubtype; CFStringRef kCGPDFXOutputConditionIdentifier; CFStringRef kCGPDFXOutputCondition; CFStringRef kCGPDFXRegistryName; CFStringRef kCGPDFXInfo; CFStringRef kCGPDFXDestinationOutputProfile;

Константы
- kCGPDFXOutputIntentSubtype
  
  kCGPDFXOutputIntentSubtype
  
  Выходной подтип намерения. Этот ключ требуется. Значение этого ключа должно быть объектом CFString, равным "GTS_PDFX"; иначе, словарь проигнорирован.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFXOutputConditionIdentifier
  
  kCGPDFXOutputConditionIdentifier
  
  Строка, идентифицирующая намеченное устройство вывода или производственное условие в человеке - или машиночитаемая форма. Этот ключ требуется. Значение этого ключа должно быть объектом CFString. Для лучших результатов строка должна быть ограничена символами в наборе символов ASCII.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFXOutputCondition
  
  kCGPDFXOutputCondition
  
  Текстовая строка, идентифицирующая намеченное устройство вывода или производственное условие в человекочитаемой форме. Этот ключ является дополнительным. Если настоящее, значение этого ключа должно быть объектом CFString.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFXRegistryName
  
  kCGPDFXRegistryName
  
  Строка та, идентифицирующая реестр, в который условие, определяемое kCGPDFXOutputConditionIdentifier определяется. Этот ключ является дополнительным. Если настоящее, значение этого ключа должно быть объектом CFString. Для лучших результатов строка должна быть без потерь в кодировании ASCII.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFXInfo
  
  kCGPDFXInfo
  
  Человекочитаемая текстовая строка, содержащая дополнительную информацию или комментарии о намеченном целевом устройстве или производственном условии. Этот ключ требуется если значение kCGPDFXOutputConditionIdentifier не указывает стандартное производственное условие. Это является дополнительным иначе. Если настоящее, значение этого ключа должно быть объектом CFString.
  
  Доступный в OS X v10.4 и позже.
- kCGPDFXDestinationOutputProfile
  
  kCGPDFXDestinationOutputProfile
  
  ICC профилирует поток, определяющий трансформацию от исходных цветов документа в формате PDF до красителей устройства вывода. Этот ключ требуется если значение kCGPDFXOutputConditionIdentifier не указывает стандартное производственное условие. Это является дополнительным иначе. Если настоящее, значение этого ключа должно быть основанным на ICC цветовым пространством, указанным как a CGColorSpace объект.
  
  Доступный в OS X v10.4 и позже.
Обсуждение

Для получения дополнительной информации об использовании этих ключей в контексте PDF посмотрите CGPDFContextCreate и CGPDFContextCreateWithURL.

Доступность

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