Deprecated CGPDFDocument Functions

A function identified as deprecated has been superseded and may become unsupported in the future.

Deprecated in OS X version 10.3 and later

CGPDFDocumentGetArtBox

Returns the art box of a page in a PDF document. (Deprecated in OS X version 10.3 and later.)

CGRect CGPDFDocumentGetArtBox (
   CGPDFDocumentRef document,
   int page
);
Parameters
document

The PDF document to examine.

page

An integer that specifies the number of the page to examine.

Return Value

A rectangle that represents the art box for the specified page, expressed in default PDF user space units (points).

Discussion

The replacement function for this one is CGPDFPageGetBoxRect, which gets the rectangle associated with a type of box (art, media, crop, bleed trim) that represents a content region or page dimensions of a PDF page. For more information see CGPDFPage Reference.

The art box defines the extent of the page’s meaningful content (including potential white space) as intended by the document creator. The default value is the page’s crop box.

Availability
  • Available in OS X version 10.0 and later.
  • Deprecated in OS X version 10.3 and later.
Declared In
CGPDFDocument.h

CGPDFDocumentGetBleedBox

Returns the bleed box of a page in a PDF document. (Deprecated in OS X version 10.3 and later.)

CGRect CGPDFDocumentGetBleedBox (
   CGPDFDocumentRef document,
   int page
);
Parameters
document

The PDF document to examine.

page

An integer that specifies the number of the page to examine.

Return Value

A rectangle that represents the bleed box for the specified page, expressed in default PDF user space units (points).

Discussion

The replacement function for this one is CGPDFPageGetBoxRect, which gets the rectangle associated with a type of box (art, media, crop, bleed trim) that represents a content region or page dimensions of a PDF page. For more information see CGPDFPage Reference.

The bleed box defines the bounds to which the contents of the page should be clipped when output in a production environment. The default value is the page’s crop box.

Availability
  • Available in OS X version 10.0 and later.
  • Deprecated in OS X version 10.3 and later.
Declared In
CGPDFDocument.h

CGPDFDocumentGetCropBox

Returns the crop box of a page in a PDF document. (Deprecated in OS X version 10.3 and later.)

CGRect CGPDFDocumentGetCropBox (
   CGPDFDocumentRef document,
   int page
);
Parameters
document

The PDF document to examine.

page

An integer that specifies the number of the page to examine.

Return Value

A rectangle that represents the crop box for the specified page, expressed in default PDF user space units (points).

Discussion

The replacement function for this one is CGPDFPageGetBoxRect, which gets the rectangle associated with a type of box (art, media, crop, bleed trim) that represents a content region or page dimensions of a PDF page. For more information see CGPDFPage Reference.

The crop box defines the region to which the contents of the page are to be clipped (or cropped) when displayed or printed. Unlike the other boxes, the crop box has no defined meaning in terms of physical page geometry or intended use—it merely suggests where the page should be clipped.

Availability
  • Available in OS X version 10.0 and later.
  • Deprecated in OS X version 10.3 and later.
Declared In
CGPDFDocument.h

CGPDFDocumentGetMediaBox

Returns the media box of a page in a PDF document. (Deprecated in OS X version 10.3 and later.)

CGRect CGPDFDocumentGetMediaBox (
   CGPDFDocumentRef document,
   int page
);
Parameters
document

The PDF document to examine.

page

An integer that specifies the number of the page to examine.

Return Value

A rectangle that represents the media box for the specified page, expressed in default PDF user space units (points).

Discussion

The replacement function for this one is CGPDFPageGetBoxRect, which gets the rectangle associated with a type of box (art, media, crop, bleed trim) that represents a content region or page dimensions of a PDF page. For more information see CGPDFPage Reference.

The media box defines the location and size of the physical medium on which the page is intended to be displayed or printed. For example, if the page size is 8.5 by 11 inches, this function returns the coordinate pairs (0,0) and (612,792).

Availability
  • Available in OS X version 10.0 and later.
  • Deprecated in OS X version 10.3 and later.
Declared In
CGPDFDocument.h

CGPDFDocumentGetRotationAngle

Returns the rotation angle of a page in a PDF document. (Deprecated in OS X version 10.3 and later.)

int CGPDFDocumentGetRotationAngle (
   CGPDFDocumentRef document,
   int page
);
Parameters
document

The PDF document to examine.

page

An integer that specifies the number of the page to examine.

Return Value

The rotation angle of the page, expressed in degrees. If the specified page does not exist, returns 0.

Discussion

The replacement function for this one is CGPDFPageGetRotationAngle. For more information see CGPDFPage Reference.

Availability
  • Available in OS X version 10.0 and later.
  • Deprecated in OS X version 10.3 and later.
Declared In
CGPDFDocument.h

CGPDFDocumentGetTrimBox

Returns the trim box of a page in a PDF document. (Deprecated in OS X version 10.3 and later.)

CGRect CGPDFDocumentGetTrimBox (
   CGPDFDocumentRef document,
   int page
);
Parameters
document

The PDF document to examine.

page

A value specifying the number of the page to examine.

Return Value

Returns a rectangle that represents the trim box for the specified page, expressed in default PDF user space units (points).

Discussion

The replacement function for this one is CGPDFPageGetBoxRect, which gets the rectangle associated with a type of box (art, media, crop, bleed trim) that represents a content region or page dimensions of a PDF page. For more information see CGPDFPage Reference.

The trim box defines the intended dimensions of the finished page after trimming. It may be smaller than the media box, to allow for production-related content such as printing instructions, cut marks, or color bars. The default value is the page’s crop box.

Availability
  • Available in OS X version 10.0 and later.
  • Deprecated in OS X version 10.3 and later.
Declared In
CGPDFDocument.h


© 2003, 2006 Apple Computer, Inc. All Rights Reserved. (Last updated: 2006-12-22)

Did this document help you? Yes It's good, but... Not helpful...