CustomiOSApi 1.11
PrinterFont Class Reference

This the container class to hold various font attributes More...

#import <PrinterFont.h>

Public Types

enum  FontSize {
  FONT_SIZE_X1 = 0 , FONT_SIZE_X2 = 1 , FONT_SIZE_X3 = 2 , FONT_SIZE_X4 = 3 ,
  FONT_SIZE_X5 = 4 , FONT_SIZE_X6 = 5 , FONT_SIZE_X7 = 6 , FONT_SIZE_X8 = 7
}
 Font Size More...
 
enum  FontJustification { FONT_JUSTIFICATION_LEFT = 0 , FONT_JUSTIFICATION_CENTER = 1 , FONT_JUSTIFICATION_RIGHT = 2 }
 Font Justification More...
 
enum  FontType {
  FONT_TYPE_A = 0 , FONT_TYPE_B = 1 , FONT_TYPE_1 = 5 , FONT_TYPE_2 = 6 ,
  FONT_TYPE_3 = 7 , FONT_TYPE_4 = 8 , FONT_TYPE_5 = 9
}
 Font Type More...
 

Instance Methods

(enum FontSize) - GetCharWidth
 Get Character width ratio (default FONT_SIZE_X1) More...
 
(void) - SetCharWidth:value:
 Set Character width ratio More...
 
(enum FontSize) - GetCharHeight
 Get Character height ratio (default FONT_SIZE_X1) More...
 
(void) - SetCharHeight:value:
 Set Character height ratio More...
 
(Boolean) - GetEmphasized
 Get Font emphasied (default false) More...
 
(void) - SetEmphasized:
 Set Font emphasied More...
 
(Boolean) - GetItalic
 Get Font italic (default false) More...
 
(void) - SetItalic:
 Set Font italic More...
 
(Boolean) - GetUnderline
 Get Font underline (default false) More...
 
(void) - SetUnderline:
 Set Font underline More...
 
(enum FontJustification) - GetJustification
 Get Font justification: More...
 
(void) - SetJustification:value:
 Set Font justification: More...
 
(enum FontType) - GetCharFontType
 Get Font type: More...
 
(void) - SetCharFontType:value:
 Set Font type: More...
 
(NSInteger) - GetLineSpacing
 Returns current line spacing
More...
 
(void) - SetLineSpacing:value:
 Set the line spacing. Please refere to the device command manual for additional info. NOTE: All the values under the font height set line spacing to 0.
More...
 
(int) - GetInternationalCharSet
 Returns the international char set More...
 
(void) - SetInternationalCharSet:_interCharSet:
 Sets the international char set More...
 
(id) - init [implementation]
 

Detailed Description

This the container class to hold various font attributes

Member Enumeration Documentation

◆ FontJustification

Font Justification

Enumerator
FONT_JUSTIFICATION_LEFT 

Indicates that the Font Justification is Left

FONT_JUSTIFICATION_CENTER 

Indicates that the Font Justification is Center

FONT_JUSTIFICATION_RIGHT 

Indicates that the Font Justification is Right

◆ FontSize

- (enum) FontSize

Font Size

Enumerator
FONT_SIZE_X1 

Indicates that the Font Size is 1X

FONT_SIZE_X2 

Indicates that the Font Size is 2X

FONT_SIZE_X3 

Indicates that the Font Size is 3X

FONT_SIZE_X4 

Indicates that the Font Size is 4X

FONT_SIZE_X5 

Indicates that the Font Size is 5X

FONT_SIZE_X6 

Indicates that the Font Size is 6X

FONT_SIZE_X7 

Indicates that the Font Size is 7X

FONT_SIZE_X8 

Indicates that the Font Size is 8X

◆ FontType

- (enum) FontType

Font Type

Enumerator
FONT_TYPE_A 

Indicates that the Font Type is A

FONT_TYPE_B 

Indicates that the Font Type is B

FONT_TYPE_1 

Indicates that the Font 1

FONT_TYPE_2 

Indicates that the Font 2

FONT_TYPE_3 

Indicates that the Font 3

FONT_TYPE_4 

Indicates that the Font 4

FONT_TYPE_5 

Indicates that the Font 5

Method Documentation

◆ GetCharFontType

- (enum FontType) GetCharFontType

Get Font type:

  • FONT_TYPE_1 - Font Type 1.
  • FONT_TYPE_2 - Font Type 2.
  • FONT_TYPE_3 - Font Type 3.
  • FONT_TYPE_4 - Font Type 4.
  • FONT_TYPE_5 - Font Type 5.
  • FONT_TYPE_A - Font A.
  • FONT_TYPE_B - Font B.

◆ GetCharHeight

- (enum FontSize) GetCharHeight

Get Character height ratio (default FONT_SIZE_X1)

◆ GetCharWidth

- (enum FontSize) GetCharWidth

Get Character width ratio (default FONT_SIZE_X1)

◆ GetEmphasized

- (Boolean) GetEmphasized

Get Font emphasied (default false)

◆ GetInternationalCharSet

- (NSInteger) GetInternationalCharSet

Returns the international char set

◆ GetItalic

- (Boolean) GetItalic

Get Font italic (default false)

◆ GetJustification

- (enum FontJustification) GetJustification

Get Font justification:

  • FONT_JUSTIFICATION_LEFT - left
  • FONT_JUSTIFICATION_CENTER - center
  • FONT_JUSTIFICATION_RIGHT - right

◆ GetLineSpacing

- (NSInteger) GetLineSpacing

Returns current line spacing

◆ GetUnderline

- (Boolean) GetUnderline

Get Font underline (default false)

◆ init

- (id) init
implementation

◆ SetCharFontType:value:

- (void) SetCharFontType: (enum FontType) 
value: (NSError**)  error 

Set Font type:

Parameters
valueFont value:
  • FONT_TYPE_1 - Font Type 1.
  • FONT_TYPE_2 - Font Type 2.
  • FONT_TYPE_3 - Font Type 3.
  • FONT_TYPE_4 - Font Type 4.
  • FONT_TYPE_5 - Font Type 5.
  • FONT_TYPE_A - Font A.
  • FONT_TYPE_B - Font B.
errorError pointer

◆ SetCharHeight:value:

- (void) SetCharHeight: (enum FontSize) 
value: (NSError**)  error 

Set Character height ratio

Parameters
valueFont height ratio Size
errorError pointer

◆ SetCharWidth:value:

- (void) SetCharWidth: (enum FontSize) 
value: (NSError**)  error 

Set Character width ratio

Parameters
valueFont width ratio Size
errorError pointer

◆ SetEmphasized:

- (void) SetEmphasized: (Boolean)  value

Set Font emphasied

Parameters
valueEmphasized value

◆ SetInternationalCharSet:_interCharSet:

- (void) SetInternationalCharSet: (NSInteger) 
_interCharSet: (NSError**)  error 

Sets the international char set

Parameters
_interCharSetis the codepage value. Ex: 437 for "PC437 - USA". - 0 - Default.
Parameters
errorError pointer

◆ SetItalic:

- (void) SetItalic: (Boolean)  value

Set Font italic

Parameters
valueItalic value

◆ SetJustification:value:

- (void) SetJustification: (enum FontJustification) 
value: (NSError**)  error 

Set Font justification:

Parameters
valueJustification value:
  • FONT_JUSTIFICATION_LEFT - left
  • FONT_JUSTIFICATION_CENTER - center
  • FONT_JUSTIFICATION_RIGHT - right
errorError pointer

◆ SetLineSpacing:value:

- (void) SetLineSpacing: (NSInteger) 
value: (NSError**)  error 

Set the line spacing. Please refere to the device command manual for additional info. NOTE: All the values under the font height set line spacing to 0.

Parameters
valueline spacing
errorError pointer

◆ SetUnderline:

- (void) SetUnderline: (Boolean)  value

Set Font underline

Parameters
valueUnderline value