eVision Python API
Loading...
Searching...
No Matches
eVision.EMailBarcode Class Reference

Manages a complete context for a Mail Barcode. More...

Public Member Functions

None __init__ (self, eVision.EMailBarcode other)
 Constructs an eVision.EMailBarcode.
None Draw (self, eVision.EDrawAdapter|None adapter, float zoomX, float zoomY, float panX, float panY)
 Draws the bounding box of the mail barcode.
None Draw (self, eVision.EDrawAdapter|None adapter, float zoomX, float zoomY, float panX)
 Draws the bounding box of the mail barcode.
None Draw (self, eVision.EDrawAdapter|None adapter, float zoomX, float zoomY)
 Draws the bounding box of the mail barcode.
None Draw (self, eVision.EDrawAdapter|None adapter, float zoomX)
 Draws the bounding box of the mail barcode.
None Draw (self, eVision.EDrawAdapter|None adapter)
 Draws the bounding box of the mail barcode.
None DrawDecodedString (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY, float panX, float panY)
 Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.
None DrawDecodedString (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY, float panX)
 Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.
None DrawDecodedString (self, eVision.EDrawAdapter|None drawAdapter, float zoomX, float zoomY)
 Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.
None DrawDecodedString (self, eVision.EDrawAdapter|None drawAdapter, float zoomX)
 Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.
None DrawDecodedString (self, eVision.EDrawAdapter|None drawAdapter)
 Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.
None DrawDecodedString (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
 Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.
None DrawDecodedString (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX)
 Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.
None DrawDecodedString (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY)
 Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.
None DrawDecodedString (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX)
 Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.
None DrawDecodedString (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame)
 Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.
eVision.EMailBarcodeSymbologies Symbology (self)
 Returns the symbology of the mail barcode.
eVision.EMailBarcodeOrientation Orientation (self)
 Returns the orientation of the mail barcode.
str Text (self)
 Returns the full decoded text, also called decoded string, of the mail barcode.
list[eVision._eVision.EStringPair] ComponentStrings (self)
 Returns the list of semantic parts included in the mail barcode text.
eVision.ERectangle Position (self)
 Returns the position of the mail barcode in the Image/ROI.
bool ChecksumOk (self)
 Returns if the checksum was successfully validated.

Detailed Description

Manages a complete context for a Mail Barcode.

Remarks:

License(s): EasyBarCode

Constructor & Destructor Documentation

◆ __init__()

None eVision.EMailBarcode.__init__ ( self,
eVision.EMailBarcode other )

Constructs an eVision.EMailBarcode.

Parameters
otherThe other eVision.EMailBarcode that we will copy into this one.

Member Function Documentation

◆ ChecksumOk()

bool eVision.EMailBarcode.ChecksumOk ( self)

Returns if the checksum was successfully validated.

◆ ComponentStrings()

list[eVision._eVision.EStringPair] eVision.EMailBarcode.ComponentStrings ( self)

Returns the list of semantic parts included in the mail barcode text.

◆ Draw() [1/5]

None eVision.EMailBarcode.Draw ( self,
eVision.EDrawAdapter | None adapter )

Draws the bounding box of the mail barcode.

Parameters
adaptereVision.EDrawAdapter that will be used to draw.

◆ Draw() [2/5]

None eVision.EMailBarcode.Draw ( self,
eVision.EDrawAdapter | None adapter,
float zoomX )

Draws the bounding box of the mail barcode.

Parameters
adaptereVision.EDrawAdapter that will be used to draw.
zoomXHorizontal zooming factor. By default, true scale is used.

◆ Draw() [3/5]

None eVision.EMailBarcode.Draw ( self,
eVision.EDrawAdapter | None adapter,
float zoomX,
float zoomY )

Draws the bounding box of the mail barcode.

Parameters
adaptereVision.EDrawAdapter that will be used to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

◆ Draw() [4/5]

None eVision.EMailBarcode.Draw ( self,
eVision.EDrawAdapter | None adapter,
float zoomX,
float zoomY,
float panX )

Draws the bounding box of the mail barcode.

Parameters
adaptereVision.EDrawAdapter that will be used to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [5/5]

None eVision.EMailBarcode.Draw ( self,
eVision.EDrawAdapter | None adapter,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the bounding box of the mail barcode.

Parameters
adaptereVision.EDrawAdapter that will be used to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

◆ DrawDecodedString() [1/10]

None eVision.EMailBarcode.DrawDecodedString ( self,
eVision.EDrawAdapter | None drawAdapter )

Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.

The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters
drawAdapterHandle of the graphics context on which to draw.

◆ DrawDecodedString() [2/10]

None eVision.EMailBarcode.DrawDecodedString ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame )

Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.

The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters
drawAdapterHandle of the graphics context on which to draw.
frameFrame associated with the bar code.

◆ DrawDecodedString() [3/10]

None eVision.EMailBarcode.DrawDecodedString ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX )

Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.

The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters
drawAdapterHandle of the graphics context on which to draw.
frameFrame associated with the bar code.
zoomXHorizontal zooming factor. By default, true scale is used.

◆ DrawDecodedString() [4/10]

None eVision.EMailBarcode.DrawDecodedString ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY )

Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.

The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters
drawAdapterHandle of the graphics context on which to draw.
frameFrame associated with the bar code.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

◆ DrawDecodedString() [5/10]

None eVision.EMailBarcode.DrawDecodedString ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY,
float panX )

Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.

The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters
drawAdapterHandle of the graphics context on which to draw.
frameFrame associated with the bar code.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

◆ DrawDecodedString() [6/10]

None eVision.EMailBarcode.DrawDecodedString ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EFrame frame,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.

The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters
drawAdapterHandle of the graphics context on which to draw.
frameFrame associated with the bar code.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

◆ DrawDecodedString() [7/10]

None eVision.EMailBarcode.DrawDecodedString ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX )

Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.

The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters
drawAdapterHandle of the graphics context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.

◆ DrawDecodedString() [8/10]

None eVision.EMailBarcode.DrawDecodedString ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX,
float zoomY )

Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.

The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters
drawAdapterHandle of the graphics context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

◆ DrawDecodedString() [9/10]

None eVision.EMailBarcode.DrawDecodedString ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX,
float zoomY,
float panX )

Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.

The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters
drawAdapterHandle of the graphics context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

◆ DrawDecodedString() [10/10]

None eVision.EMailBarcode.DrawDecodedString ( self,
eVision.EDrawAdapter | None drawAdapter,
float zoomX,
float zoomY,
float panX,
float panY )

Draws the decoded string (eVision.EMailBarcode.Text), below the position of the eVision.EMailBarcode.

The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters
drawAdapterHandle of the graphics context on which to draw.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

◆ Orientation()

eVision.EMailBarcodeOrientation eVision.EMailBarcode.Orientation ( self)

Returns the orientation of the mail barcode.

◆ Position()

eVision.ERectangle eVision.EMailBarcode.Position ( self)

Returns the position of the mail barcode in the Image/ROI.

◆ Symbology()

eVision.EMailBarcodeSymbologies eVision.EMailBarcode.Symbology ( self)

Returns the symbology of the mail barcode.

◆ Text()

str eVision.EMailBarcode.Text ( self)

Returns the full decoded text, also called decoded string, of the mail barcode.