Skip to content

Latest commit

 

History

History
162 lines (109 loc) · 6.69 KB

classes.md

File metadata and controls

162 lines (109 loc) · 6.69 KB

zintBarcode classes

Overview

zintBarcode comprises a functional class (named ZintBarcode) and three support classes (ZintLibrary, ZintEnumerations, and ZintStructure).

ZintLibrary loads the required Zint library into VFP. It's instantiated in the preamble code of zintbarcode.prg.

ZintEnumerations holds the different enumerations used by Zint, and may be used to make the code easier to write and read.

That is:

m.ZS.SetSymbology(m.ZE.BARCODE_DATAMATRIX)
m.ZS.SetOption(3, m.ZE.DM_SQUARE)

instead of

m.ZS.SetSymbology(71)
m.ZS.SetOption(3, 100)

ZintStructure is a companion class that helps the operation of the Zint API in a version-independent fashion.

ZintBarcode methods

The production of a barcode is a three-step process:

  1. Configure the barcode (symbology, size, colors, and other Zint properties);
  2. Encode the barcode;
  3. Save it to an image file or to a memory buffer.

Functional methods

In alphabetical order:

Encode (InputData AS String[, Filename AS String]) AS Integer

Encodes a barcode according to some data (text or binary). If a filename is given, it sets the Outfile Zint property.

Returns an error condition (0 = no error).

EncodeSave (InputData AS String[, Filename AS String[, Angle AS Integer]]) AS Integer

Encodes a barcode according to some data, and saves it to a file or a memory buffer (if no filename is given, the value of Outfile Zint property is used when the output is not being sent to memory).

The barcode can be rotated at a given angle (at 0, 90, 180, or 270 degrees).

Returns an error condition (0 = no error).

GetGeneratedStatus () AS Logical

Returns generated status: true if a symbol was generated (even if a warning has been issued).

GetLastResult () AS Integer

Returns last result of an encoding or saving operation (enumerated as ZINT_WARN_* or ZINT_ERROR_*).

ImageFile (InputData AS String[, ImageFormat AS String[, Angle AS Integer]]) AS String

Encodes and saves a barcode to a temporary file, managed by the ZintBarcode class. Upon successful release of the ZintBarcode object, all temporary files are deleted.

m.ImageFormat is a graphic file extension (defaults to .DefaultImageFormat), and the angle can be set at 0, 90, 180, and 270 degrees.

Returns a full-path filename, or an empty string in case of error (more information given by the .GetErrorText() method).

IsSupported (Symbology AS Integer[, Feature AS Integer]) AS Logical

Checks if a given symbology identifier is supported by the library, or if a symbology supports a feature or group of features. Features are enumerated by the ZINT_CAP_* properties of the ZintEnumerarions class.

Returns logical.

LibrarySuport (Feature AS Integer) AS Logical

Checks if a generic feature of the library is available. Features enumerated as LIB_ZINT_*.

Returns logical.

Reset ()

Clears and resets the Zint properties to their initial value.

Save ([Angle AS Integer]) AS Integer

Saves an encoded barcode to a file, at a given angle (0, 90, 180, or 270 degrees).

The name of the file is the one stored in the Outfile Zint property.

Returns an error condition (0 = no error).

Configuration methods

In alphabetical order. All properties have a Get method (for instance, GetWhitespaceWidth()). The input properties also have Set methods (for instance, SetOption()). Additional properties - that is, not Zint properties - are italicized.

All Set methods have a single parameter of the indicated type, except the SetOption(), *BGColour(), and *FGColour() methods.

Property Set Get Type Obs
AlphamapPointer • I
BGColour • • I/C Translated as VFP color values or as a CMYK set. An additional optional parameter indicates if RGB use is forced, regardless of the CmyModel setting.
BitmapByteLength • I
BitmapHeight • I
BitmapPointer • I
BitmapWidth • I
BorderWidth • • I
CmykModel • • I 0 = RGB only; 1 = CMYK stored in properties, RGB as parameters or results of color functions; 2 = CMYK only.
Debug • • I
DefaultImageFormat • • C The default image format, as an extension ("gif", initially).
DotSize • • N
DotsPerMM • • N
ECI • • I
EncodedData • C
ErrorText • C
FGColour • • I/C Translated as VFP color values or as a CMYK set. An additional optional parameter indicates if RGB use is forced, regardless of the CmyModel setting.
FontSize • • I Unused.
GuardDescent • • N
Height • • N
InputMode • • I
MemFile • B A blob set when the output options include the BARCODE_MEMORY_FILE flag. The result may be used directly as a value of the PictureVal property. Image overlaying is not yet compatible with images stored in memory.
Option • • I Index of option (1-3) is indicated in the first parameter.
OutputOptions • • I
Outfile • • C Max. 254 length. Beginning at Zint version 2.13, filename is stored in UTF-8.
Overlay • • C/O Overlay image. A filename, or an Image object.
OverlayHeight • • I In pixels. When the height and the width of an overlay area are set, the overlay image is resized to fit.
OverlayIsometric • • L When .T., a resized overlay image retains its proportions. Otherwise, the image resizes to the overlay width and height.
OverlayMargin • • I Margin around an overlay image. Only for a resized overlay image.
OverlayPosition • • C Position of the overlay image: C, TL, TR, BL, BR (Center, Top, Bottom, Right, Left).
OverlayWidth • • I In pixels. When the width and the height of an overlay area are set, the overlay image is resized to fit.
Primary • • C
RowHeight • N GetRowHeight expects an index in the range 1-200.
Rows • I
Scale • • N
SingleFile • • L Used to indicate if a single temporary file is sufficient to store the barcodes required by the application.
ShowHumanReadableText • • L
Symbology • • I
Text • C
TextLength • I
TextGap • • N
VectorPointer • I
WarnLevel • • I
WhitespaceHeight • • I
WhitespaceWidth • • I
Width • I