doxygenAutoDocs
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
LabelMakerSDK.LabelMakerSDK Class Reference

Public Member Functions

 __init__ (self)
 
 CreateLabel (self, iPrintLanguageTyp, LabelName, dotsPerUnit, unit)
 
 CreateTexts (self, x_start, y_start, fontsize_x, fontsize_y, data, scale, FontSizeUnit, FontStyle, Alignment, fontName, rotation)
 
 CreateBarcode1D (self, start_x, start_y, content, scale, narrowBar, wideBar, Height, BcdTyp, PrintHumanReadable, rotation, PdfLocTop)
 
 CreateLines (self, start_x, start_y, end_x, end_y, lineThickness, scale)
 
 CreateBoxs (self, start_x, start_y, end_x, end_y, lineThickness, scale)
 
 CreateMaxicodeBarcodes (self, iMaxicodeTyp, mode, postalCode, countryCode, serviceClass, remainingMsg, year, primaryMsg, start_x, start_y, scale, ZipperPattern, rotation)
 
 CreatePdf417Bcodes (self, start_x, start_y, content, scale, xdim, ydim, ErrorCorrection, row, col, rotation)
 
 CreateAztecBarcodes (self, start_x, start_y, content, scale, xdim, CodeType, iFixedErrCorrection, iLayers, rotation)
 
 CreateDataMatrixBarcodes (self, start_x, start_y, content, scale, xdim, Rotation, UseRectangle, MatrixMultiLine, CtrlChar1, CtrlChar2, row, col)
 
 CreateQRBarcodes (self, start_x, start_y, content, scale, xdim, Mask, dataManuallyEncoded, errEnum, modelEnum, rotation)
 
 ToHexString (self, input_str)
 
 CreateRfidEncode (self, a32BitField, a16BitField, a6CharAsciiString, MemBlock, iOffsetFromStart, _10BytesUserData, _4BytesHexUserData, PasswordEnum, Password)
 
 LabelToString (self, str)
 
 CloseLabel (self)
 

Public Attributes

 gpLabel
 
 gpTextType
 
 gpMexiCodeBarcodeType
 
 gpPdf417BarcodeType
 
 gpDataMatrixBarcodeType
 
 gpAztecBarcodeType
 
 gpQRBarcodeType
 
 gpRfidWriteType
 
 gpLineType
 
 gpBoxType
 
 gpBarcode1DType
 
 gpPrinterResolution
 
 gpRuler
 
 gpCellRect
 
 gpCellSquare
 
 ObjectsPtr
 
 ObjRulerPtr
 
 ObjStartPtr
 
 ObjEndPtr
 
 ObjCellSquarePtr
 
 ObjCellRectPtr
 
 ObjTextItemPtr
 
 giPrintLanguageTyp
 

Constructor & Destructor Documentation

◆ __init__()

LabelMakerSDK.LabelMakerSDK.__init__ ( self)

Member Function Documentation

◆ CloseLabel()

LabelMakerSDK.LabelMakerSDK.CloseLabel ( self)
Release a resource

Return: None

Sample:

CloseLabel()

◆ CreateAztecBarcodes()

LabelMakerSDK.LabelMakerSDK.CreateAztecBarcodes ( self,
start_x,
start_y,
content,
scale,
xdim,
CodeType,
iFixedErrCorrection,
iLayers,
rotation )
Create aztec barcodes in a Label

Param: 
start_x: start point for x coordinate
start_y: start point for y coordinate
content: aztec content
scale: set a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
xdim: set a cellsize for x coordinate
CodeType: set a code type (e.g. AztecCodeTypeEnum.Compact)
iFixedErrCorrection: set the FixedErrCorrection (e.g. AztecCodeTypeEnum.FixedErrCorrection)
iLayers: set the layers
rotation: set a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)

Return: None

Sample:

CreateAztecBarcodes(0.25, 2.25, "Mr. AirTraveler, seat A, flight 200", ScaleEnum.Inch, 0.025, AztecCodeTypeEnum.Compact, NON_USED, 4, RotateEnum.None)

◆ CreateBarcode1D()

LabelMakerSDK.LabelMakerSDK.CreateBarcode1D ( self,
start_x,
start_y,
content,
scale,
narrowBar,
wideBar,
Height,
BcdTyp,
PrintHumanReadable,
rotation,
PdfLocTop )
Create barcode 1D in a Label

Param: 
x_start: start point for x coordinate
y_start: start point for y coordinate
content: barcode 1D content
scale: set a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
narrowBar: text content
wideBar: set a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
Height: set a font size unit (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
BcdTyp: set a barcode type (e.g. BarcodeTypeEnum_1D.Code_128)
PrintHumanReadable: a flag to set PrintHumanReadable
rotation: set a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)
PdfLocTop: set a flag to print human-readable data above the barcode. (Default value is below)

Return: None

Sample:

CreateBarcode1D(0.5, 1.0 + 1.5 + 1 / 4 + 1.2, "Code 128", ScaleEnum.Inch, 0.015, 0.015 * 4.1, 1.2, BarcodeTypeEnum_1D.Code_128,
                True, RotateEnum.None, False)

◆ CreateBoxs()

LabelMakerSDK.LabelMakerSDK.CreateBoxs ( self,
start_x,
start_y,
end_x,
end_y,
lineThickness,
scale )
Create boxes in a Label

Param: 
start_x: start point for x coordinate
start_y: start point for y coordinate
end_x: end point for x coordinate
end_y: end point for y coordinate
lineThickness: set a lineThickness
scale: set a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)

Return: None

Sample:

CreateBoxs(0.5, 1.25, 3.5, 2.25, 1/16, ScaleEnum.Inch)

◆ CreateDataMatrixBarcodes()

LabelMakerSDK.LabelMakerSDK.CreateDataMatrixBarcodes ( self,
start_x,
start_y,
content,
scale,
xdim,
Rotation,
UseRectangle,
MatrixMultiLine,
CtrlChar1,
CtrlChar2,
row,
col )
Create data matrix barcodes in a Label

Param: 
start_x: start point for x coordinate
start_y: start point for y coordinate
content: data matrix content
scale: set a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
xdim: set a cellsize for x coordinate
Rotation: set a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)
UseRectangle: set a flag to use rectangle
MatrixMultiLine: set a multiline string
CtrlChar1: set a CtrlChar1
CtrlChar2: set a CtrlChar2
row: set the number of rows can be used to limit the height of the barcode.
col: set the number of columns can be used to limit the width of the barcode.

Return: None

Sample:

CreateDataMatrixBarcodes(2.25, 0.25, "Line 1 DataMatrix", ScaleEnum.Inch, NON_USED, RotateEnum.None, False, "Line 2 content/r/nLine 3 content", 0x0D, 0x0A, 0, 0)

◆ CreateLabel()

LabelMakerSDK.LabelMakerSDK.CreateLabel ( self,
iPrintLanguageTyp,
LabelName,
dotsPerUnit,
unit )
Create a label 

Param: 
iPrintLanguageTyp: select TSPL or PGL
LabelName: set a label name
dotsPerUnit: set DPI (203/300/600)
unit: set unit (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)

Return: None

Sample:

CreateLabel(TSPL, "SimpleLabel", 300, ScaleEnum.Inch)

◆ CreateLines()

LabelMakerSDK.LabelMakerSDK.CreateLines ( self,
start_x,
start_y,
end_x,
end_y,
lineThickness,
scale )
Create lines in a Label

Param: 
start_x: start point for x coordinate
start_y: start point for y coordinate
end_x: end point for x coordinate
end_y: end point for y coordinate
lineThickness: set a lineThickness
scale: set a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)

Return: None

Sample:

CreateLines(2.5, 1/16, 2.5, 1.0, 1/32, ScaleEnum.Inch)

◆ CreateMaxicodeBarcodes()

LabelMakerSDK.LabelMakerSDK.CreateMaxicodeBarcodes ( self,
iMaxicodeTyp,
mode,
postalCode,
countryCode,
serviceClass,
remainingMsg,
year,
primaryMsg,
start_x,
start_y,
scale,
ZipperPattern,
rotation )
Create Maxicode barcodes in a Label
    
Param: 
iMaxicodeTyp: select a maxicode type (e.g. _MaxicodeMsgStructured)
mode: set a maxicode (e.g. MaxicodeModeEnum.MODE_2)
postalCode: set a postal code string
countryCode: set a country code string
serviceClass: set a service class string
remainingMsg: set a remaining message string
year: set a year string
primaryMsg: set a primary message string
start_x: start point for x coordinate
start_y: start point for y coordinate
scale: set a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
ZipperPattern: set a flag for zipper pattern or not
rotation: set a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)

Return: None

Sample:

CreateMaxicodeBarcodes(_MaxicodeMsgStructured, MaxicodeModeEnum.MODE_2, "902557317", "800", "200", "Maxicode Carrier Standard", "", "", 0.5, 0.5, ScaleEnum.Inch, False, RotateEnum.None)

◆ CreatePdf417Bcodes()

LabelMakerSDK.LabelMakerSDK.CreatePdf417Bcodes ( self,
start_x,
start_y,
content,
scale,
xdim,
ydim,
ErrorCorrection,
row,
col,
rotation )
Create PDF417 barcodes in a Label

Param: 
start_x: start point for x coordinate
start_y: start point for y coordinate
content: PDF417 content
scale: set a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
xdim: set a cellsize for x coordinate
ydim: set a cellsize for y coordinate

 The cell size can be thought of as the width and height of the narrowest bar element within a PDF417 row.
 Changing the dimensions of the smallest element affects the overall width and height of the barcode.

ErrorCorrection: set a error correction (e.g. Pdf417ErrCorrectionEnum.LEVEL_5)
row: set the number of rows can be used to limit the height of the barcode.
col: set the number of columns can be used to limit the width of the barcode.
rotation: set a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)

Return: None

Sample:

CreatePdf417Bcodes(0.25, 2.0, someShortText, ScaleEnum.Inch, 0.015, 0.05, Pdf417ErrCorrectionEnum.LEVEL_5, NON_USED, NON_USED, RotateEnum.None)

◆ CreateQRBarcodes()

LabelMakerSDK.LabelMakerSDK.CreateQRBarcodes ( self,
start_x,
start_y,
content,
scale,
xdim,
Mask,
dataManuallyEncoded,
errEnum,
modelEnum,
rotation )
Create data QR barcodes in a Label

Param: 
start_x: start point for x coordinate
start_y: start point for y coordinate
content: QR content
scale: set a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
xdim: set a cellsize for x coordinate
Mask: set a mask (e.g. QRCodeMaskEnum.Mask_4)
dataManuallyEncoded: set a dataManuallyEncoded
errEnu: set an error enum (e.g. QRCodeErrorCorrectionEnum.EC_15)
modelEnum: set a model enum (e.g. QRCodeModelEnumz.MODEL_1)
rotation: set a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)

Return: None

Sample:

CreateQRBarcodes(1.75, 3.75, "", ScaleEnum.Inch, 0.025, QRCodeMaskEnum.Mask_4, dataManuallyEncoded,
                QRCodeErrorCorrectionEnum.NON_USED, QRCodeModelEnum.NON_USED, RotateEnum.None)

◆ CreateRfidEncode()

LabelMakerSDK.LabelMakerSDK.CreateRfidEncode ( self,
a32BitField,
a16BitField,
a6CharAsciiString,
MemBlock,
iOffsetFromStart,
_10BytesUserData,
_4BytesHexUserData,
PasswordEnum,
Password )
Create RFID in a Label

Param: 
a32BitField: set RFID 32 bit field
a16BitField: set RFID 16 bit field
a6CharAsciiString: set RFID 6 characters ASCII string 
MemBlock: set a memory block (e.g. RfidMemBlockEnum.EPC)
iOffsetFromStart: set an offset from start
_10BytesUserData: set a RFID 10 bytes string 
_4BytesHexUserData: set a RFID 4 bytes string 
PasswordEnum: set a password enum (e.g. RfidPasswordTypeEnum.Lock)
Password: set a password string

Return: None

Sample:

CreateRfidEncode(a32BitField, a16BitField, a6CharAsciiString, RfidMemBlockEnum.User, 2, "MyUserData", "0ABCDE0F", RfidPasswordTypeEnum.None, "")
Here is the call graph for this function:

◆ CreateTexts()

LabelMakerSDK.LabelMakerSDK.CreateTexts ( self,
x_start,
y_start,
fontsize_x,
fontsize_y,
data,
scale,
FontSizeUnit,
FontStyle,
Alignment,
fontName,
rotation )
Create texts in a Label

Param:
x_start: start point for x coordinate
y_start: start point for y coordinate
fontsize_x: font size for x coordinate
fontsize_y: font size for y coordinate
data: text content
scale: set a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
FontSizeUnit: set a font size unit (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
FontStyle: set a font style (FontSizeUnitsEnum.Ruler/FontSizeUnitsEnum.Points/FontSizeUnitsEnum.Percent)
Alignment: set a alignment for text (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
fontName: set font name
rotation: set a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)

Return: None

Sample:

CreateTexts(2.0, 1.25 + 7 / 16, 3 / 16, 7 / 16, "MY MAGIC", ScaleEnum.Inch, FontSizeUnitsEnum.Ruler,
            (FontStyleEnum)NON_USED, AlignEnum.Center, "93952.sf", RotateEnum.None)

◆ LabelToString()

LabelMakerSDK.LabelMakerSDK.LabelToString ( self,
str )
Create a label with TSPL or PGL

Param 
str: TSPL or PGL strings

Return: None

Sample:

LabelToString(LabelString)

◆ ToHexString()

LabelMakerSDK.LabelMakerSDK.ToHexString ( self,
input_str )
Here is the caller graph for this function:

Member Data Documentation

◆ giPrintLanguageTyp

LabelMakerSDK.LabelMakerSDK.giPrintLanguageTyp

◆ gpAztecBarcodeType

LabelMakerSDK.LabelMakerSDK.gpAztecBarcodeType

◆ gpBarcode1DType

LabelMakerSDK.LabelMakerSDK.gpBarcode1DType

◆ gpBoxType

LabelMakerSDK.LabelMakerSDK.gpBoxType

◆ gpCellRect

LabelMakerSDK.LabelMakerSDK.gpCellRect

◆ gpCellSquare

LabelMakerSDK.LabelMakerSDK.gpCellSquare

◆ gpDataMatrixBarcodeType

LabelMakerSDK.LabelMakerSDK.gpDataMatrixBarcodeType

◆ gpLabel

LabelMakerSDK.LabelMakerSDK.gpLabel

◆ gpLineType

LabelMakerSDK.LabelMakerSDK.gpLineType

◆ gpMexiCodeBarcodeType

LabelMakerSDK.LabelMakerSDK.gpMexiCodeBarcodeType

◆ gpPdf417BarcodeType

LabelMakerSDK.LabelMakerSDK.gpPdf417BarcodeType

◆ gpPrinterResolution

LabelMakerSDK.LabelMakerSDK.gpPrinterResolution

◆ gpQRBarcodeType

LabelMakerSDK.LabelMakerSDK.gpQRBarcodeType

◆ gpRfidWriteType

LabelMakerSDK.LabelMakerSDK.gpRfidWriteType

◆ gpRuler

LabelMakerSDK.LabelMakerSDK.gpRuler

◆ gpTextType

LabelMakerSDK.LabelMakerSDK.gpTextType

◆ ObjCellRectPtr

LabelMakerSDK.LabelMakerSDK.ObjCellRectPtr

◆ ObjCellSquarePtr

LabelMakerSDK.LabelMakerSDK.ObjCellSquarePtr

◆ ObjectsPtr

LabelMakerSDK.LabelMakerSDK.ObjectsPtr

◆ ObjEndPtr

LabelMakerSDK.LabelMakerSDK.ObjEndPtr

◆ ObjRulerPtr

LabelMakerSDK.LabelMakerSDK.ObjRulerPtr

◆ ObjStartPtr

LabelMakerSDK.LabelMakerSDK.ObjStartPtr

◆ ObjTextItemPtr

LabelMakerSDK.LabelMakerSDK.ObjTextItemPtr

The documentation for this class was generated from the following file: