Foxit PDF SDK  9.1
FSTextPageCharInfo Class Reference
Inheritance diagram for FSTextPageCharInfo:

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 
(id) - initWithChar_info:
 Constructor, with another character information object.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithFont:flag:font_size:origin_x:origin_y:char_box:char_outbox:matrix:
 Constructor, with parameters.
More...
 
(void) - set:flag:font_size:origin_x:origin_y:char_box:char_outbox:matrix:
 Set value.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Properties

FSRectFchar_box
 The glyph bounding box in page space.
More...
 
FSRectFchar_outbox
 The typographic(display and printing) bounding box in page space.
More...
 
FSTextPageCharInfoTextCharFlag flag
 Flags to indicate which properties of textpage character flag are meaningful.
More...
 
FSFontfont
 A font for character.
More...
 
float font_size
 Font size for character.
More...
 
FSMatrix2Dmatrix
 The matrix of the character.
More...
 
float origin_x
 The x-coordinate of the origin position.
More...
 
float origin_y
 The y-coordinate of the origin position.
More...
 

Detailed Description

This class represents textpage character information.

Method Documentation

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

◆ initWithChar_info:

- (id) initWithChar_info: (FSTextPageCharInfo*)  char_info

Constructor, with another character information object.

Parameters
[in]char_infoAnother character information object.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

◆ initWithFont:flag:font_size:origin_x:origin_y:char_box:char_outbox:matrix:

- (id) initWithFont: (FSFont*)  font
flag: (FSTextPageCharInfoTextCharFlag flag
font_size: (float)  font_size
origin_x: (float)  origin_x
origin_y: (float)  origin_y
char_box: (FSRectF*)  char_box
char_outbox: (FSRectF*)  char_outbox
matrix: (FSMatrix2D*)  matrix 

Constructor, with parameters.

Parameters
[in]fontA valid font object.
[in]flagFlags to indicate which properties of textpage character flag are meaningful. Please refer to values starting from FSTextPageCharInfoNormal and this should be one of these values except FSTextPageCharInfoUnknown.
[in]font_sizeFont size. This should be a positive value.
[in]origin_xThe x-coordinate of the origin position.
[in]origin_yThe y-coordinate of the origin position.
[in]char_boxThe glyph bounding box in page space.
[in]char_outboxThe typographic (display and printing) bounding box in page space. The width is advance width, and the height is the sum of the ascent and descent.
[in]matrixThe matrix.

◆ set:flag:font_size:origin_x:origin_y:char_box:char_outbox:matrix:

- (void) set: (FSFont*)  font
flag: (FSTextPageCharInfoTextCharFlag flag
font_size: (float)  font_size
origin_x: (float)  origin_x
origin_y: (float)  origin_y
char_box: (FSRectF*)  char_box
char_outbox: (FSRectF*)  char_outbox
matrix: (FSMatrix2D*)  matrix 

Set value.

Parameters
[in]fontA valid font object.
[in]flagFlags to indicate which properties of textpage character flag are meaningful. Please refer to values starting from FSTextPageCharInfoNormal and this should be one of these values except FSTextPageCharInfoUnknown.
[in]font_sizeFont size. This should be a positive value.
[in]origin_xThe x-coordinate of the origin position.
[in]origin_yThe y-coordinate of the origin position.
[in]char_boxThe glyph bounding box in page space.
[in]char_outboxThe typographic (display and printing) bounding box in page space. The width is advance width, and the height is the sum of the ascent and descent.
[in]matrixThe matrix.
Returns
None.

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ char_box

- (FSRectF *) char_box
readwritenonatomiccopy

The glyph bounding box in page space.

◆ char_outbox

- (FSRectF *) char_outbox
readwritenonatomiccopy

The typographic(display and printing) bounding box in page space.

◆ flag

- (FSTextPageCharInfoTextCharFlag) flag
readwritenonatomicassign

Flags to indicate which properties of textpage character flag are meaningful.

Please refer to values starting from FSTextPageCharInfoNormal and this should be one of these values.

◆ font

- (FSFont *) font
readwritenonatomiccopy

A font for character.

◆ font_size

- (float) font_size
readwritenonatomicassign

Font size for character.

This value would a positive value.

◆ matrix

- (FSMatrix2D *) matrix
readwritenonatomiccopy

The matrix of the character.

◆ origin_x

- (float) origin_x
readwritenonatomicassign

The x-coordinate of the origin position.

◆ origin_y

- (float) origin_y
readwritenonatomicassign

The y-coordinate of the origin position.