![]() |
CustomiOSApi 1.11
|
Class definition for CUSTOM printers. Defines functionality to print text/image, read/write data to printer, etc More...
#import <CustomPrinter.h>
Instance Methods | |
| (Boolean) | - IsPrinterOnline: |
| Returns if the printer is ready or not More... | |
| (NSInteger) | - GetPrinterId: |
| Returns the printer ID More... | |
| (NSString *) | - GetFirmwareVersion: |
| Returns the printer FW Release More... | |
| (NSString *) | - GetAPIVersion |
| Returns current API version More... | |
| (NSData *) | - GetPrinterFullStatusBuffer: |
| Returns the status of the printer More... | |
| (CustomPrinterStatus *) | - GetPrinterFullStatus: |
| Returns the status of the printer More... | |
| (NSString *) | - GetPrinterName |
| Returns name/type of the Printer More... | |
| (NSInteger) | - GetPageWidth |
| Returns the max printable width in pixels / dots More... | |
| (void) | - SetPageWidth:iNewPageWidth: |
| Override the default paper width in piexels / dots with a new value. Check on the device manual the allowed values. More... | |
| (NSInteger) | - GetResolution |
| Returns printer resolution More... | |
| (NSInteger) | - GetReadTimeout: |
| Returns the Timeout for Communication Port Read More... | |
| (void) | - SetReadTimeout:msecs: |
| Sets the Timeout for Communication Port Read More... | |
| (NSInteger) | - GetWriteTimeout: |
| Returns the Timeout for Communication Port Write More... | |
| (void) | - SetWriteTimeout:msecs: |
| Sets the Timeout for Communication Port Write More... | |
| (void) | - Close: |
| Disconnect the link, close the communication port and release attached resources More... | |
| (enum CommPortType) | - GetPortType |
| Returns the communication port type More... | |
| (void) | - ClearReadBuffer: |
| Clears the Read Buffer of Communication Port More... | |
| (NSData *) | - ReadData: |
| Read Data Buffer from printer. It will return all available data in buffer More... | |
| (void) | - WriteData:data: |
| Write Data Buffer to printer More... | |
| (void) | - Feed:nFeeds: |
| Sends Feeds to the printer More... | |
| (void) | - Cut:cutType: |
| Sends a Cut command to the printer More... | |
| (void) | - Eject:ejectType: |
| Sends a Eject command to the printer More... | |
| (void) | - Present:presentMM: |
| Sends a present command to the printer More... | |
| (void) | - Align:alignType: |
| Sends a Align command to the printer More... | |
| (void) | - OpenCashDrawer:drawerType:dwTimeOn:dwTimeOff: |
| Generate pulse on the drawer connector More... | |
| (void) | - PrintText:text:pixel_la:pixel_w:font: |
| (void) | - PrintTextLF:text:pixel_la:pixel_w:font: |
| Sends the text data to printer to print and adds a LF at the end More... | |
| (void) | - PrintText:text:font: |
| Sends the text data to printer to print. It will print data on full page width with 0 margin More... | |
| (void) | - PrintTextLF:text:font: |
| Sends the text data to printer to print and adds a LF at the end. It will print data on full page width with 0 margin More... | |
| (void) | - PrintTextArrayLF:textarray:font: |
| Sends the text data to printer to print and adds a LF at the end. It will print data on full page width with 0 margin More... | |
| (void) | - PrintText:text: |
| Sends the text data to printer to print. It will print data on full page width with 0 margin using the last font attributes More... | |
| (void) | - PrintTextLF:text: |
| Sends the text data to printer to print and adds a LF at the end. It will print data on full page width with 0 margin using the last font attributes More... | |
| (void) | - PrintTextArrayLF:textarray: |
| Sends the text data to printer to print and adds a LF at the end. It will print data on full page width with 0 margin using the last font attributes More... | |
| (void) | - PrintImage:image:leftAlign:widthOption:imgWidth: |
| Sends the Bitmap data to printer to print More... | |
| (void) | - PrintImage:image: |
| Sends the Bitmap data to printer to print fit to paper width More... | |
| (void) | - PrintBarcodeText:brcText:brcType:brcHriType:brcJustification:brcWidth:brcHeight: |
| Sends barcode Text to printer to print More... | |
| (void) | - PrintBarcodeData:brcData:brcType:brcHriType:brcJustification:brcWidth:brcHeight: |
| Sends barcode data to printer to print More... | |
| (void) | - PrintBarcode2DText:brcText:brcType:brcJustification:brcWidth: |
| Sends barcode 2D Text to printer to print More... | |
| (void) | - PrintBarcode2DData:brcData:brcType:brcJustification:brcWidth: |
| Sends barcode 2D data to printer to print More... | |
Class definition for CUSTOM printers. Defines functionality to print text/image, read/write data to printer, etc
| - (enum) AlignType |
| - (enum) Barcode2DType |
Barcode 2D Type
| - (enum) BarcodeHriType |
| - (enum) BarcodeJustification |
| - (enum) BarcodeType |
Barcode Type
| - (enum) CommPortType |
Communication Port Type
| - (enum) CutType |
| - (enum) DrawerType |
| - (enum) EjectType |
| - (enum) ImageJustification |
| - (enum) ImageScale |
Print Image Scale
| - (void) Align: | (enum AlignType) | ||
| alignType: | (NSError**) | error | |
Sends a Align command to the printer
| alignType | Align Type:
|
| error | Error pointer |
| - (void) ClearReadBuffer: | (NSError**) | error |
Clears the Read Buffer of Communication Port
| error | Error pointer |
| - (void) Close: | (NSError**) | error |
Disconnect the link, close the communication port and release attached resources
| error | Error pointer |
| - (void) Cut: | (enum CutType) | ||
| cutType: | (NSError**) | error | |
Sends a Cut command to the printer
| cutType | Cut Type:
|
| error | Error pointer |
| - (void) Eject: | (enum EjectType) | ||
| ejectType: | (NSError**) | error | |
Sends a Eject command to the printer
| ejectType | Eject type:
|
| error | Error pointer |
| - (void) Feed: | (NSInteger) | ||
| nFeeds: | (NSError**) | error | |
Sends Feeds to the printer
| error | Error pointer |
| nFeeds | Number of LF to send |
| - (NSString *) GetAPIVersion |
Returns current API version
| - (NSString *) GetFirmwareVersion: | (NSError**) | error |
Returns the printer FW Release
| error | Error pointer |
| - (NSInteger) GetPageWidth |
Returns the max printable width in pixels / dots
| - (enum CommPortType) GetPortType |
Returns the communication port type
| - (CustomPrinterStatus *) GetPrinterFullStatus: | (NSError**) | error |
Returns the status of the printer
| error | Error pointer |
| - (NSData *) GetPrinterFullStatusBuffer: | (NSError**) | error |
Returns the status of the printer
| error | Error pointer |
| - (NSInteger) GetPrinterId: | (NSError**) | error |
Returns the printer ID
| error | Error pointer |
| - (NSString *) GetPrinterName |
Returns name/type of the Printer
| - (NSInteger) GetReadTimeout: | (NSError**) | error |
Returns the Timeout for Communication Port Read
| error | Error pointer |
| - (NSInteger) GetResolution |
Returns printer resolution
| - (NSInteger) GetWriteTimeout: | (NSError**) | error |
Returns the Timeout for Communication Port Write
| error | Error pointer |
| - (Boolean) IsPrinterOnline: | (NSError**) | error |
Returns if the printer is ready or not
| error | Error pointer |
| - (void) OpenCashDrawer: | (enum DrawerType) | ||
| drawerType: | (NSInteger) | ||
| dwTimeOn: | (NSInteger) | ||
| dwTimeOff: | (NSError**) | error | |
Generate pulse on the drawer connector
| drawerType | Connector pin type:
|
| dwTimeOn | the pulse ON time in milliseconds. |
| dwTimeOff | the pulse OFF time in milliseconds. |
| error | Error pointer |
| - (void) Present: | (NSInteger) | ||
| presentMM: | (NSError**) | error | |
Sends a present command to the printer
| presentMM | mm of paper to present |
| error | Error pointer |
| - (void) PrintBarcode2DData: | (NSData*) | ||
| brcData: | (enum Barcode2DType) | ||
| brcType: | (enum BarcodeJustification) | ||
| brcJustification: | (NSInteger) | ||
| brcWidth: | (NSError**) | error | |
Sends barcode 2D data to printer to print
| brcData | Barcode Data |
| brcType | Barcode 2D Type |
| brcJustification | Barcode Justification |
| brcWidth | Barcode Width |
| error | Error pointer |
| - (void) PrintBarcode2DText: | (NSString*) | ||
| brcText: | (enum Barcode2DType) | ||
| brcType: | (enum BarcodeJustification) | ||
| brcJustification: | (NSInteger) | ||
| brcWidth: | (NSError**) | error | |
Sends barcode 2D Text to printer to print
| brcText | Barcode Text |
| brcType | Barcode 2D Type |
| brcJustification | Barcode Justification |
| brcWidth | Barcode Width |
| error | Error pointer |
| - (void) PrintBarcodeData: | (NSData*) | ||
| brcData: | (enum BarcodeType) | ||
| brcType: | (enum BarcodeHriType) | ||
| brcHriType: | (enum BarcodeJustification) | ||
| brcJustification: | (NSInteger) | ||
| brcWidth: | (NSInteger) | ||
| brcHeight: | (NSError**) | error | |
Sends barcode data to printer to print
| brcData | Barcode Data |
| brcType | Barcode Type |
| brcHriType | Barcode HRI (Human Readable Information) Type |
| brcJustification | Barcode Justification |
| brcWidth | Barcode Width (referred to the narrow bar) |
| brcHeight | Barcode Height |
| error | Error pointer |
| - (void) PrintBarcodeText: | (NSString*) | ||
| brcText: | (enum BarcodeType) | ||
| brcType: | (enum BarcodeHriType) | ||
| brcHriType: | (enum BarcodeJustification) | ||
| brcJustification: | (NSInteger) | ||
| brcWidth: | (NSInteger) | ||
| brcHeight: | (NSError**) | error | |
Sends barcode Text to printer to print
| brcText | Barcode Text |
| brcType | Barcode Type |
| brcHriType | Barcode HRI (Human Readable Information) Type |
| brcJustification | Barcode Justification |
| brcWidth | Barcode Width (referred to the narrow bar) |
| brcHeight | Barcode Height |
| error | Error pointer |
| - (void) PrintImage: | (UIImage*) | ||
| image: | (NSError**) | error | |
Sends the Bitmap data to printer to print fit to paper width
| image | Bitmap image to print |
| error | Error pointer |
| - (void) PrintImage: | (UIImage*) | ||
| image: | (NSInteger) | ||
| leftAlign: | (enum ImageScale) | ||
| widthOption: | (NSInteger) | ||
| imgWidth: | (NSError**) | error | |
Sends the Bitmap data to printer to print
| image | Bitmap image to print |
| leftAlign | If the value is > 0, the value is the align Left align in pixel. Otherwise it can be
|
| widthOption | Scaling options:
|
| imgWidth | Printed Image width in pixel / dots (used only if widthOption=IMAGE_SCALE_TO_WIDTH) |
| error | Error pointer |
| - (void) PrintText: | (NSString*) | ||
| text: | (NSError**) | error | |
Sends the text data to printer to print. It will print data on full page width with 0 margin using the last font attributes
| text | String to print |
| error | Error pointer |
| - (void) PrintText: | (NSString*) | ||
| text: | (PrinterFont*) | ||
| font: | (NSError**) | error | |
Sends the text data to printer to print. It will print data on full page width with 0 margin
| text | String to print |
| font | Holds various font attributes |
| error | Error pointer |
| - (void) PrintText: | (NSString*) | ||
| text: | (NSInteger) | ||
| pixel_la: | (NSInteger) | ||
| pixel_w: | (PrinterFont*) | ||
| font: | (NSError**) | error | |
Sends the text data to printer to print
| text | String to print |
| pixel_la | Left align in pixel |
| pixel_w | Print area width in pixel. Pass -1 to use max available print width |
| font | Holds various font attributes |
| error | Error pointer |
| - (void) PrintTextArrayLF: | (NSArray*) | ||
| textarray: | (NSError**) | error | |
Sends the text data to printer to print and adds a LF at the end. It will print data on full page width with 0 margin using the last font attributes
| textarray | Array of Strings to print |
| error | Error pointer |
| - (void) PrintTextArrayLF: | (NSArray*) | ||
| textarray: | (PrinterFont*) | ||
| font: | (NSError**) | error | |
Sends the text data to printer to print and adds a LF at the end. It will print data on full page width with 0 margin
| textarray | Array of Strings to print |
| font | Holds various font attributes |
| error | Error pointer |
| - (void) PrintTextLF: | (NSString*) | ||
| text: | (NSError**) | error | |
Sends the text data to printer to print and adds a LF at the end. It will print data on full page width with 0 margin using the last font attributes
| text | String to print |
| error | Error pointer |
| - (void) PrintTextLF: | (NSString*) | ||
| text: | (PrinterFont*) | ||
| font: | (NSError**) | error | |
Sends the text data to printer to print and adds a LF at the end. It will print data on full page width with 0 margin
| text | String to print |
| font | Holds various font attributes |
| error | Error pointer |
| - (void) PrintTextLF: | (NSString*) | ||
| text: | (NSInteger) | ||
| pixel_la: | (NSInteger) | ||
| pixel_w: | (PrinterFont*) | ||
| font: | (NSError**) | error | |
Sends the text data to printer to print and adds a LF at the end
| text | String to print |
| pixel_la | Left align in pixel |
| pixel_w | Print area width in pixel. Pass -1 to use max available print width |
| font | Holds various font attributes |
| error | Error pointer |
| - (NSData *) ReadData: | (NSError**) | error |
Read Data Buffer from printer. It will return all available data in buffer
| error | Error pointer |
| - (void) SetPageWidth: | (NSInteger) | ||
| iNewPageWidth: | (NSError**) | error | |
Override the default paper width in piexels / dots with a new value. Check on the device manual the allowed values.
| error | Error pointer |
| iNewPageWidth | New paper width (pixels / dots) |
| - (void) SetReadTimeout: | (NSInteger) | ||
| msecs: | (NSError**) | error | |
Sets the Timeout for Communication Port Read
| error | Error pointer |
| msecs | Timeout for Communication Port Read(msec) |
| - (void) SetWriteTimeout: | (NSInteger) | ||
| msecs: | (NSError**) | error | |
Sets the Timeout for Communication Port Write
| error | Error pointer |
| msecs | Timeout for Communication Port Write(msec) |
| - (void) WriteData: | (NSData *) | ||
| data: | (NSError**) | error | |
Write Data Buffer to printer
| error | Error pointer |
| data | Data Buffer to write to the printer |