Class representing Zint barcode objects. More...

#include <pdfbarcodezint.h>

Inheritance diagram for wxPdfBarcodeZint:

Public Member Functions
	wxPdfBarcodeZint ()
	Constructor.

	~wxPdfBarcodeZint ()
	Destructor.

wxPdfBarcode::Symbology	GetSymbology () const
	Get symbology in use.

void	SetSymbology (wxPdfBarcode::Symbology symbol)
	Set symbology to use.

int	GetInputMode () const
	Get the input data encoding. Default UNICODE_MODE.

void	SetInputMode (int inputMode)
	Set the input data encoding. Default UNICODE_MODE.

wxString	GetText () const
	Get the input data.

void	SetText (const wxString &text)
	Set the input data.

std::vector< wxPdfZintSeg >	GetSegments () const
	Get the segments.

void	SetSegments (const std::vector< wxPdfZintSeg > &segs)
	Set the segments.

wxString	GetPrimaryMessage () const
	Get the primary message (Maxicode, Composite)

void	SetPrimaryMessage (const wxString &primaryMessage)
	Set the primary message (Maxicode, Composite)

double	GetHeight () const
	Get the symbol height in X-dimensions.

void	SetHeight (double height)
	Set the symbol height in X-dimensions.

int	GetOption1 () const
	Get symbol-specific option 1.

void	SetOption1 (int option)
	Set symbol-specific option 1.

int	GetOption2 () const
	Get symbol-specific option 2.

void	SetOption2 (int option)
	Set symbol-specific option 2.

int	GetOption3 () const
	Get symbol-specific option 3.

void	SetOption3 (int option)
	Set symbol-specific option 3.

double	GetScale () const
	Get scale factor when printing barcode, i.e. adjusts X-dimension.

void	SetScale (double scale)
	Set scale factor when printing barcode, i.e. adjusts X-dimension.

double	GetDpmm () const
	Get the resolution of output in dots per mm (BMP/EMF/PCX/PNG/TIF only)

void	SetDpmm (double dpmm)
	Set the resolution of output in dots per mm (BMP/EMF/PCX/PNG/TIF only)

bool	GetDotty () const
	Get dotty mode.

void	SetDotty (bool dotty)
	Set dotty mode.

double	GetDotSize () const
	Get size of dots used in dotty mode.

void	SetDotSize (double dotSize)
	Set size of dots used in dotty mode.

double	GetGuardDescent () const
	Get the height in X-dimensions that EAN/UPC guard bars descend.

void	SetGuardDescent (double guardDescent)
	Set the height in X-dimensions that EAN/UPC guard bars descend.

int	GetStructAppCount () const

int	GetStructAppIndex () const

wxString	GetStructAppID () const

void	SetStructApp (const int count, const int index, const wxString &id)

void	ClearStructApp ()

wxString	GetFgColourStr () const
	Get the foreground colour (may be RGB(A) hex string or CMYK decimal "C,M,Y,K" percentage string)

bool	SetFgColourStr (const wxString &fgStr)
	Set the foreground colour (may be RGB(A) hex string or CMYK decimal "C,M,Y,K" percentage string)

wxColour	GetFgColour () const
	Get the foreground colour as wxColour.

void	SetFgColour (const wxColour &fgColor)
	Set the foreground colour as wxColour.

wxString	GetBgColourStr () const
	Get the background colour (may be RGB(A) hex string or CMYK decimal "C,M,Y,K" percentage string)

bool	SetBgColourStr (const wxString &bgStr)
	Set the background colour (may be RGB(A) hex string or CMYK decimal "C,M,Y,K" percentage string)

wxColour	GetBgColour () const
	Get the background colour as wxColour.

void	SetBgColour (const wxColour &bgColor)
	Set the background colour as wxColour.

bool	GetCMYK () const
	Get flag whether CMYK colour space is used (Encapsulated PostScript and TIF)

void	SetCMYK (bool cmyk)
	Enable or disable the use of CMYK colour space (Encapsulated PostScript and TIF)

int	GetBorderType () const
	Get the type of border above/below/around barcode.

void	SetBorderType (int borderTypeIndex)
	Set the type of border above/below/around barcode.

int	GetBorderWidth () const
	Get the border width in X-dimensions.

void	SetBorderWidth (int borderWidth)
	Set the border width in X-dimensions.

int	GetWhitespace () const
	Get the width in X-dimensions of whitespace to left & right of barcode.

void	SetWhitespace (int whitespace)
	Set the width in X-dimensions of whitespace to left & right of barcode.

int	GetVerticalWhitespace () const
	Get the height in X-dimensions of whitespace above & below the barcode.

void	SetVerticalWhitespace (int vWhitespace)
	Get the height in X-dimensions of whitespace above & below the barcode.

int	GetFontSetting () const
	Type of font to use i.e. normal, small, bold or (vector only) small bold.

void	SetFontSetting (int fontSetting)
	Set the type of font to use i.e. normal, small, bold or (vector only) small bold.

double	GetTextGap () const
	Get the text gap.

void	SetTextGap (double textGap)
	Set the text gap.

bool	ShowText () const
	Show (true) or hide (false) Human Readable Text.

void	SetShowText (bool showText)
	Enable (true) or disable (false) Human Readable Text.

bool	HasSeparatorGS () const
	Check whether GS (Group Separator) is used instead of FNC1 as GS1 separator (Data Matrix)

void	SetSeparatorGS (bool gsSep)
	Use GS (Group Separator) instead of FNC1 as GS1 separator (Data Matrix)

bool	HasQuietZones () const
	Add compliant quiet zones (additional to any specified whitespace)

void	SetQuietZones (bool quietZones)
	Enable or disable compliant quiet zones (additional to any specified whitespace)

bool	HasNoQuietZones () const
	Disable quiet zones, notably those with defaults.

void	SetNoQuietZones (bool noQuietZones)
	Enable or disable quiet zones, notably those with defaults.

bool	GetCompliantHeight () const
	Get compliant height flag.

void	SetCompliantHeight (bool compliantHeight)
	Set compliant height.

int	GetRotateAngle () const
	Rotate barcode by angle (degrees 0, 90, 180 and 270)

void	SetRotateAngle (int rotateAngle)
	Rotate barcode by angle (degrees 0, 90, 180 and 270)

int	GetECI () const
	Get Extended Channel Interpretation (segment 0 eci)

void	SetECIFromIndex (int ECIIndex)
	Set Extended Channel Interpretation (segment 0 eci)

void	SetECI (int eci)
	Set Extended Channel Interpretation (segment 0 eci)

bool	HasGS1ParensMode () const
	Get flag whether parentheses are processed as GS1 AI delimiters (instead of square brackets)

void	SetGS1ParensMode (bool gs1Parens)
	Set flag whether parentheses are processed as GS1 AI delimiters (instead of square brackets)

bool	GetGS1NoCheckMode () const
	Get flag whether validity of GS1 data is not checked (except that printable ASCII only)

void	SetGS1NoCheckMode (bool gs1NoCheck)
	Set flag whether validity of GS1 data is not checked (except that printable ASCII only)

bool	HasReaderInit () const
	Check whether Reader Initialisation (Programming) is used.

void	SetReaderInit (bool readerInit)
	Set Reader Initialisation (Programming)

bool	HasGuardWhitespace () const
	Check whether quiet zone indicators will be added.

void	SetGuardWhitespace (bool guardWhitespace)
	Set flag whether to add quiet zone indicators ("<", ">") to HRT (EAN/UPC)

bool	HasEmbedVectorFont () const
	Check whether the font will be embedded in vector output - currently only for SVG output of EAN/UPC.

void	SetEmbedVectorFont (bool embedVectorFont)
	Set flag whether to embed the font in vector output - currently only for SVG output of EAN/UPC.

int	GetWarnLevel () const
	Get the warning level.

void	SetWarnLevel (int warnLevel)
	Set the warning level.

bool	HasDebugFlag () const
	Check the debugging flag.

void	SetDebugFlag (bool debug)
	Debugging flags.

int	GetEncodedWidth () const
	Get the encoded width after successful rendering.

int	GetEncodedRows () const
	Get the number of encoded rows after successful rendering.

double	GetEncodedHeight () const
	Get the encoded height after successful rendering.

double	GetVectorWidth () const
	Get the vector width after successful rendering.

double	GetVectorHeight () const
	Get the vector height after successful rendering.

void	SetWidth (int width)
	Set barcode width (option 1)

int	GetWidth () const
	Get barcode width (option 1)

void	SetSecurityLevel (int securityLevel)
	Set the security level (option 2)

int	GetSecurityLevel () const
	Get the security level (option 2)

int	GetError () const
	Get the error or warning code returned by Zint on `render()` or `save_to_file()`

const wxString &	GetLastError () const
	Get the error message returned by Zint on `render()` or `save_to_file()`

bool	HasErrors () const
	Check whether errors occurred.

bool	SaveToFile (const wxString &filename)
	Encode and print barcode to file.

void	Render (wxPdfDocument &pdfDoc, double x, double y)
	Encode and render barcode to a PDF document.

double	GetDefaultXdim () const
	Get the default X-dimension of current barcode symbology.

Static Public Member Functions
static bool	HasHRT (wxPdfBarcode::Symbology symbology)
	Check whether the symbology has human readable text.

static bool	IsStackable (wxPdfBarcode::Symbology symbology)
	Check whether symbology is stackable.

static bool	IsExtendable (wxPdfBarcode::Symbology symbology)
	Check whether symbology is extendable.

static bool	IsComposite (wxPdfBarcode::Symbology symbology)
	Check whether symbology is composite.

static bool	SupportsECI (wxPdfBarcode::Symbology symbology)
	Check whether symbology supports ECI.

static bool	SupportsGS1 (wxPdfBarcode::Symbology symbology)
	Check whether symbology supports GS1.

static bool	IsDotty (wxPdfBarcode::Symbology symbology)
	Check whether symbology is dotty.

static bool	HasDefaultQuietZones (wxPdfBarcode::Symbology symbology)
	Check whether symbology has default quiet zones.

static bool	HasFixedRatio (wxPdfBarcode::Symbology symbology)
	Check whether symbology has a fixed ratio.

static bool	SupportsReaderInit (wxPdfBarcode::Symbology symbology)
	Check whether symbology supports reader init.

static bool	SupportsFullMultibyte (wxPdfBarcode::Symbology symbology)
	Check whether symbology supports full multibyte.

static bool	HasMask (wxPdfBarcode::Symbology symbology)
	Check whether symbology has a mask.

static bool	SupportsStructApp (wxPdfBarcode::Symbology symbology)
	Check whether symbology supports structured apps.

static bool	HasCompliantHeight (wxPdfBarcode::Symbology symbology)
	Check whether symbology has a compliant height.

static bool	TakesGS1AIData (wxPdfBarcode::Symbology symbology)
	Check whether symbology takes GS1 AI-delimited data.

static double	GetDefaultXdim (wxPdfBarcode::Symbology symbology)
	Get the default X-dimension.

static wxString	GetBarcodeName (const wxPdfBarcode::Symbology symbology)
	Return the name of a symbology.

static bool	NoPNG ()
	Check whether PNG support is available.

static bool	IsValidSymbology (int symbolId)
	Check validity of symbology.

static int	GetVersion ()
	Version of Zint library "libzint" linked to.

Detailed Description

Class representing Zint barcode objects.

All supported barcodes are drawn directly in PDF.

Constructor & Destructor Documentation

◆ wxPdfBarcodeZint()

wxPdfBarcodeZint::wxPdfBarcodeZint ( )

Constructor.

◆ ~wxPdfBarcodeZint()

wxPdfBarcodeZint::~wxPdfBarcodeZint ( )

Destructor.

Member Function Documentation

◆ ClearStructApp()

void wxPdfBarcodeZint::ClearStructApp ( )

◆ GetBarcodeName()

static wxString wxPdfBarcodeZint::GetBarcodeName ( const wxPdfBarcode::Symbology symbology )

static

Return the name of a symbology.

Parameters

symbology symbology for which the name should be returned

Returns: the name of the symbology

◆ GetBgColour()

wxColour wxPdfBarcodeZint::GetBgColour ( ) const

Get the background colour as wxColour.

Returns: the background colour

◆ GetBgColourStr()

wxString wxPdfBarcodeZint::GetBgColourStr ( ) const

inline

Get the background colour (may be RGB(A) hex string or CMYK decimal "C,M,Y,K" percentage string)

Returns: the background colour as a string

◆ GetBorderType()

int wxPdfBarcodeZint::GetBorderType ( ) const

inline

Get the type of border above/below/around barcode.

Returns: the border type

◆ GetBorderWidth()

int wxPdfBarcodeZint::GetBorderWidth ( ) const

inline

Get the border width in X-dimensions.

Returns: the border width

◆ GetCMYK()

bool wxPdfBarcodeZint::GetCMYK ( ) const

inline

Get flag whether CMYK colour space is used (Encapsulated PostScript and TIF)

Returns: TRUE if CMYK colour space is used, FALSE otherwise

◆ GetCompliantHeight()

bool wxPdfBarcodeZint::GetCompliantHeight ( ) const

inline

Get compliant height flag.

Returns: TRUE if compliant height is used and checked, FALSE otherwise

◆ GetDefaultXdim() [1/2]

double wxPdfBarcodeZint::GetDefaultXdim ( ) const

Get the default X-dimension of current barcode symbology.

Returns: the default X-dimension

◆ GetDefaultXdim() [2/2]

static double wxPdfBarcodeZint::GetDefaultXdim ( wxPdfBarcode::Symbology symbology )

static

Get the default X-dimension.

Parameters

symbology symbology for which the X-dimension should be determined

Returns: the default X-dimension

◆ GetDotSize()

double wxPdfBarcodeZint::GetDotSize ( ) const

inline

Get size of dots used in dotty mode.

Returns: the size of a dot in dotty mode

◆ GetDotty()

bool wxPdfBarcodeZint::GetDotty ( ) const

inline

Get dotty mode.

Returns: TRUE if dotty mode is enabled, FALSE otherwise

◆ GetDpmm()

double wxPdfBarcodeZint::GetDpmm ( ) const

inline

Get the resolution of output in dots per mm (BMP/EMF/PCX/PNG/TIF only)

Returns: the resoulution in dots per mm

◆ GetECI()

int wxPdfBarcodeZint::GetECI ( ) const

inline

Get Extended Channel Interpretation (segment 0 eci)

Returns: value of Extended Channel Interpretation

◆ GetEncodedHeight()

double wxPdfBarcodeZint::GetEncodedHeight ( ) const

Get the encoded height after successful rendering.

Returns: encoded height after successful rendering

◆ GetEncodedRows()

int wxPdfBarcodeZint::GetEncodedRows ( ) const

inline

Get the number of encoded rows after successful rendering.

Returns: number of encoded rows after successful rendering

◆ GetEncodedWidth()

int wxPdfBarcodeZint::GetEncodedWidth ( ) const

inline

Get the encoded width after successful rendering.

Returns: encoded width after successful rendering

Note: encoded width (no. of modules encoded)

◆ GetError()

int wxPdfBarcodeZint::GetError ( ) const

inline

Get the error or warning code returned by Zint on render() or save_to_file()

Returns: the error or warning code

◆ GetFgColour()

wxColour wxPdfBarcodeZint::GetFgColour ( ) const

Get the foreground colour as wxColour.

Returns: the foreground colour

◆ GetFgColourStr()

wxString wxPdfBarcodeZint::GetFgColourStr ( ) const

inline

Get the foreground colour (may be RGB(A) hex string or CMYK decimal "C,M,Y,K" percentage string)

Returns: the foreground colour as a string

◆ GetFontSetting()

int wxPdfBarcodeZint::GetFontSetting ( ) const

inline

Type of font to use i.e. normal, small, bold or (vector only) small bold.

Returns: the type of font to use

◆ GetGS1NoCheckMode()

bool wxPdfBarcodeZint::GetGS1NoCheckMode ( ) const

inline

Get flag whether validity of GS1 data is not checked (except that printable ASCII only)

Returns: TRUE if validity of GS1 data is not checked, FALSE otherwise

◆ GetGuardDescent()

double wxPdfBarcodeZint::GetGuardDescent ( ) const

inline

Get the height in X-dimensions that EAN/UPC guard bars descend.

Returns: the height of the guard bar descend

◆ GetHeight()

double wxPdfBarcodeZint::GetHeight ( ) const

inline

Get the symbol height in X-dimensions.

Returns: the height in X-dimensions

◆ GetInputMode()

int wxPdfBarcodeZint::GetInputMode ( ) const

inline

Get the input data encoding. Default UNICODE_MODE.

Returns: the input mode

◆ GetLastError()

const wxString & wxPdfBarcodeZint::GetLastError ( ) const

inline

Get the error message returned by Zint on render() or save_to_file()

Returns: the error message text

◆ GetOption1()

int wxPdfBarcodeZint::GetOption1 ( ) const

inline

Get symbol-specific option 1.

Returns: the value of option 1

◆ GetOption2()

int wxPdfBarcodeZint::GetOption2 ( ) const

inline

Get symbol-specific option 2.

Returns: the value of option 2

◆ GetOption3()

int wxPdfBarcodeZint::GetOption3 ( ) const

inline

Get symbol-specific option 3.

Returns: the value of option 3

◆ GetPrimaryMessage()

wxString wxPdfBarcodeZint::GetPrimaryMessage ( ) const

inline

Get the primary message (Maxicode, Composite)

Returns: the text of the primary message

◆ GetRotateAngle()

int wxPdfBarcodeZint::GetRotateAngle ( ) const

inline

Rotate barcode by angle (degrees 0, 90, 180 and 270)

Returns: the angle by which the barcode is rotated

◆ GetScale()

double wxPdfBarcodeZint::GetScale ( ) const

inline

Get scale factor when printing barcode, i.e. adjusts X-dimension.

Returns: the scale factor

◆ GetSecurityLevel()

int wxPdfBarcodeZint::GetSecurityLevel ( ) const

Get the security level (option 2)

Returns: the security level

◆ GetSegments()

std::vector< wxPdfZintSeg > wxPdfBarcodeZint::GetSegments ( ) const

inline

Get the segments.

Returns: an array with the segments

◆ GetStructAppCount()

int wxPdfBarcodeZint::GetStructAppCount ( ) const

◆ GetStructAppID()

wxString wxPdfBarcodeZint::GetStructAppID ( ) const

◆ GetStructAppIndex()

int wxPdfBarcodeZint::GetStructAppIndex ( ) const

◆ GetSymbology()

wxPdfBarcode::Symbology wxPdfBarcodeZint::GetSymbology ( ) const

inline

Get symbology in use.

Returns: the barcode symbology in use

◆ GetText()

wxString wxPdfBarcodeZint::GetText ( ) const

inline

Get the input data.

Returns: the input data (segment 0 text)

◆ GetTextGap()

double wxPdfBarcodeZint::GetTextGap ( ) const

inline

Get the text gap.

Returns: the text gap

◆ GetVectorHeight()

double wxPdfBarcodeZint::GetVectorHeight ( ) const

inline

Get the vector height after successful rendering.

Returns: vector height after successful rendering

◆ GetVectorWidth()

double wxPdfBarcodeZint::GetVectorWidth ( ) const

inline

Get the vector width after successful rendering.

Returns: vector width after successful rendering

◆ GetVersion()

static int wxPdfBarcodeZint::GetVersion ( )

static

Version of Zint library "libzint" linked to.

Returns: the version number of the Zint library

◆ GetVerticalWhitespace()

int wxPdfBarcodeZint::GetVerticalWhitespace ( ) const

inline

Get the height in X-dimensions of whitespace above & below the barcode.

Returns: the height of whitespace

◆ GetWarnLevel()

int wxPdfBarcodeZint::GetWarnLevel ( ) const

inline

Get the warning level.

Returns: the warning level

◆ GetWhitespace()

int wxPdfBarcodeZint::GetWhitespace ( ) const

inline

Get the width in X-dimensions of whitespace to left & right of barcode.

Returns: the width of whitespace

◆ GetWidth()

int wxPdfBarcodeZint::GetWidth ( ) const

Get barcode width (option 1)

Returns: the barcode width

◆ HasCompliantHeight()

static bool wxPdfBarcodeZint::HasCompliantHeight ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology has a compliant height.

Returns: TRUE if symbology has a compliant height, FALSE otherwise

◆ HasDebugFlag()

bool wxPdfBarcodeZint::HasDebugFlag ( ) const

inline

Check the debugging flag.

Returns: TRUE if debugging is enabled, FALSE otherwise

◆ HasDefaultQuietZones()

static bool wxPdfBarcodeZint::HasDefaultQuietZones ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology has default quiet zones.

Returns: TRUE if symbology has default quiet zones, FALSE otherwise

◆ HasEmbedVectorFont()

bool wxPdfBarcodeZint::HasEmbedVectorFont ( ) const

inline

Check whether the font will be embedded in vector output - currently only for SVG output of EAN/UPC.

Returns: TRUE if the font will be embedded, FALSE otherwise

◆ HasErrors()

bool wxPdfBarcodeZint::HasErrors ( ) const

Check whether errors occurred.

Returns: TRUE if errors occurred, FALSE otherwise

◆ HasFixedRatio()

static bool wxPdfBarcodeZint::HasFixedRatio ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology has a fixed ratio.

Returns: TRUE if symbology has a fixed ratio, FALSE otherwise

◆ HasGS1ParensMode()

bool wxPdfBarcodeZint::HasGS1ParensMode ( ) const

inline

Get flag whether parentheses are processed as GS1 AI delimiters (instead of square brackets)

Returns: TRUE if parentheses are processed as GS1 AI delimiters, FALSE otherwise

◆ HasGuardWhitespace()

bool wxPdfBarcodeZint::HasGuardWhitespace ( ) const

inline

Check whether quiet zone indicators will be added.

Returns: TRUE if quiet zone indicators will be added, FALSE otherwise

◆ HasHRT()

static bool wxPdfBarcodeZint::HasHRT ( wxPdfBarcode::Symbology symbology )

static

Check whether the symbology has human readable text.

Returns: TRUE if symbology has human readable text, FALSE otherwise

◆ HasMask()

static bool wxPdfBarcodeZint::HasMask ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology has a mask.

Returns: TRUE if symbology has a mask, FALSE otherwise

◆ HasNoQuietZones()

bool wxPdfBarcodeZint::HasNoQuietZones ( ) const

inline

Disable quiet zones, notably those with defaults.

Returns: TRUE if quiet zones are disabled, FALSE otherwise

Note: CODE16K, CODE49, CODABLOCKF, ITF14, EAN/UPC have default quiet zones

◆ HasQuietZones()

bool wxPdfBarcodeZint::HasQuietZones ( ) const

inline

Add compliant quiet zones (additional to any specified whitespace)

Returns: TRUE if compliant quiet zones are enabled, FALSE otherwise

Note: CODE16K, CODE49, CODABLOCKF, ITF14, EAN/UPC have default quiet zones

◆ HasReaderInit()

bool wxPdfBarcodeZint::HasReaderInit ( ) const

inline

Check whether Reader Initialisation (Programming) is used.

Returns: TRUE if Reader Initialisation is used, FALSE otherwise

◆ HasSeparatorGS()

bool wxPdfBarcodeZint::HasSeparatorGS ( ) const

inline

Check whether GS (Group Separator) is used instead of FNC1 as GS1 separator (Data Matrix)

Returns: TRUE if group separator is used, FALSE otherwise

◆ IsComposite()

static bool wxPdfBarcodeZint::IsComposite ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology is composite.

Returns: TRUE if symbology is composite, FALSE otherwise

◆ IsDotty()

static bool wxPdfBarcodeZint::IsDotty ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology is dotty.

Returns: TRUE if symbology is dotty, FALSE otherwise

◆ IsExtendable()

static bool wxPdfBarcodeZint::IsExtendable ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology is extendable.

Returns: TRUE if symbology is extendable, FALSE otherwise

◆ IsStackable()

static bool wxPdfBarcodeZint::IsStackable ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology is stackable.

Returns: TRUE if symbology is stackable, FALSE otherwise

◆ IsValidSymbology()

static bool wxPdfBarcodeZint::IsValidSymbology ( int symbolId )

static

Check validity of symbology.

Returns: TRUE if symbology is valid, FALSE otherwise

◆ NoPNG()

static bool wxPdfBarcodeZint::NoPNG ( )

static

Check whether PNG support is available.

Returns: TRUE if PNG support is not available, FALSE otherwise

◆ Render()

void wxPdfBarcodeZint::Render	(	wxPdfDocument &	pdfDoc,
		double	x,
		double	y )

Encode and render barcode to a PDF document.

Parameters

pdfDoc	PDF document instance to which the barcode should be rendered
x	horizontal position on the current page of the PDF document
y	vertical position on the current page of the PDF document

Note: the position (x,y) denotes always the left upper corner of the rectangle into which the resulting barcode is rendered

◆ SaveToFile()

bool wxPdfBarcodeZint::SaveToFile ( const wxString & filename )

Encode and print barcode to file.

Parameters

filename name of file to which the barcode should be saved

Returns: TRUE if saving to file was successful, FALSE otherwise

◆ SetBgColour()

void wxPdfBarcodeZint::SetBgColour ( const wxColour & bgColor )

Set the background colour as wxColour.

Parameters

bgColor the background colour

◆ SetBgColourStr()

bool wxPdfBarcodeZint::SetBgColourStr ( const wxString & bgStr )

Set the background colour (may be RGB(A) hex string or CMYK decimal "C,M,Y,K" percentage string)

Parameters

bgStr the background colour as a string

◆ SetBorderType()

void wxPdfBarcodeZint::SetBorderType ( int borderTypeIndex )

Set the type of border above/below/around barcode.

Parameters

borderTypeIndex the border type

◆ SetBorderWidth()

void wxPdfBarcodeZint::SetBorderWidth ( int borderWidth )

Set the border width in X-dimensions.

Parameters

borderWidth the border width

◆ SetCMYK()

void wxPdfBarcodeZint::SetCMYK ( bool cmyk )

inline

Enable or disable the use of CMYK colour space (Encapsulated PostScript and TIF)

Parameters

cmyk	TRUE to enable CMYK colour space, FALSE to disable it

◆ SetCompliantHeight()

void wxPdfBarcodeZint::SetCompliantHeight ( bool compliantHeight )

inline

Set compliant height.

Parameters

compliantHeight TRUE enables compliant height, FALSE disables it

Note: warning if height not compliant and use standard height (if any) as default

◆ SetDebugFlag()

void wxPdfBarcodeZint::SetDebugFlag ( bool debug )

inline

Debugging flags.

Parameters

debug TRUE if debugging should be enabled, FALSE otherwise

◆ SetDotSize()

void wxPdfBarcodeZint::SetDotSize ( double dotSize )

inline

Set size of dots used in dotty mode.

Parameters

dotSize the size of a dot in dotty mode

◆ SetDotty()

void wxPdfBarcodeZint::SetDotty ( bool dotty )

inline

Set dotty mode.

Parameters

dotty TRUE enables dotty mode, FALSE disables it

◆ SetDpmm()

void wxPdfBarcodeZint::SetDpmm ( double dpmm )

inline

Set the resolution of output in dots per mm (BMP/EMF/PCX/PNG/TIF only)

Parameters

dpmm	the resoulution in dots per mm

◆ SetECI()

void wxPdfBarcodeZint::SetECI ( int eci )

Set Extended Channel Interpretation (segment 0 eci)

Parameters

eci	Extended Channel Interpretation

◆ SetECIFromIndex()

void wxPdfBarcodeZint::SetECIFromIndex ( int ECIIndex )

Set Extended Channel Interpretation (segment 0 eci)

Parameters

ECIIndex index of Extended Channel Interpretation

◆ SetEmbedVectorFont()

void wxPdfBarcodeZint::SetEmbedVectorFont ( bool embedVectorFont )

inline

Set flag whether to embed the font in vector output - currently only for SVG output of EAN/UPC.

Parameters

embedVectorFont TRUE if the font will be embedded, FALSE otherwise

◆ SetFgColour()

void wxPdfBarcodeZint::SetFgColour ( const wxColour & fgColor )

Set the foreground colour as wxColour.

Parameters

fgColor the foreground colour

◆ SetFgColourStr()

bool wxPdfBarcodeZint::SetFgColourStr ( const wxString & fgStr )

Set the foreground colour (may be RGB(A) hex string or CMYK decimal "C,M,Y,K" percentage string)

Parameters

fgStr the foreground colour as a string

◆ SetFontSetting()

void wxPdfBarcodeZint::SetFontSetting ( int fontSetting )

Set the type of font to use i.e. normal, small, bold or (vector only) small bold.

Parameters

fontSetting the type of font to use

Note: Bold type is currently not supported

◆ SetGS1NoCheckMode()

void wxPdfBarcodeZint::SetGS1NoCheckMode ( bool gs1NoCheck )

inline

Set flag whether validity of GS1 data is not checked (except that printable ASCII only)

Parameters

gs1NoCheck TRUE if validity of GS1 data is not checked, FALSE otherwise

◆ SetGS1ParensMode()

void wxPdfBarcodeZint::SetGS1ParensMode ( bool gs1Parens )

inline

Set flag whether parentheses are processed as GS1 AI delimiters (instead of square brackets)

Parameters

gs1Parens TRUE if parentheses are processed as GS1 AI delimiters, FALSE otherwise

◆ SetGuardDescent()

void wxPdfBarcodeZint::SetGuardDescent ( double guardDescent )

inline

Set the height in X-dimensions that EAN/UPC guard bars descend.

Parameters

guardDescent the height of the guard bar descend

◆ SetGuardWhitespace()

void wxPdfBarcodeZint::SetGuardWhitespace ( bool guardWhitespace )

inline

Set flag whether to add quiet zone indicators ("<", ">") to HRT (EAN/UPC)

Parameters

guardWhitespace TRUE if quiet zone indicators will be added, FALSE otherwise

◆ SetHeight()

void wxPdfBarcodeZint::SetHeight ( double height )

inline

Set the symbol height in X-dimensions.

Parameters

height the height in X-dimensions

◆ SetInputMode()

void wxPdfBarcodeZint::SetInputMode ( int inputMode )

inline

Set the input data encoding. Default UNICODE_MODE.

Parameters

inputMode the input mode

◆ SetNoQuietZones()

void wxPdfBarcodeZint::SetNoQuietZones ( bool noQuietZones )

inline

Enable or disable quiet zones, notably those with defaults.

Parameters

noQuietZones TRUE disables quiet zones, FALSE enables them

Note: CODE16K, CODE49, CODABLOCKF, ITF14, EAN/UPC have default quiet zones

◆ SetOption1()

void wxPdfBarcodeZint::SetOption1 ( int option )

inline

Set symbol-specific option 1.

Parameters

option the value for option 1

◆ SetOption2()

void wxPdfBarcodeZint::SetOption2 ( int option )

inline

Set symbol-specific option 2.

Parameters

option the value for option 2

◆ SetOption3()

void wxPdfBarcodeZint::SetOption3 ( int option )

inline

Set symbol-specific option 3.

Parameters

option the value for option 3

◆ SetPrimaryMessage()

void wxPdfBarcodeZint::SetPrimaryMessage ( const wxString & primaryMessage )

inline

Set the primary message (Maxicode, Composite)

Parameters

primaryMessage the primary text

◆ SetQuietZones()

void wxPdfBarcodeZint::SetQuietZones ( bool quietZones )

inline

Enable or disable compliant quiet zones (additional to any specified whitespace)

Parameters

quietZones TRUE enables compliant quiet zones, FALSE disables them

Note: CODE16K, CODE49, CODABLOCKF, ITF14, EAN/UPC have default quiet zones

◆ SetReaderInit()

void wxPdfBarcodeZint::SetReaderInit ( bool readerInit )

inline

Set Reader Initialisation (Programming)

Parameters

readerInit TRUE if Reader Initialisation is enabled, FALSE otherwise

◆ SetRotateAngle()

void wxPdfBarcodeZint::SetRotateAngle ( int rotateAngle )

Rotate barcode by angle (degrees 0, 90, 180 and 270)

Parameters

rotateAngle angle by which the barcode should be rotated

Note: only degrees 0, 90, 180 and 270 are allowed

◆ SetScale()

void wxPdfBarcodeZint::SetScale ( double scale )

inline

Set scale factor when printing barcode, i.e. adjusts X-dimension.

Parameters

scale the scale factor

◆ SetSecurityLevel()

void wxPdfBarcodeZint::SetSecurityLevel ( int securityLevel )

Set the security level (option 2)

Parameters

securityLevel the requested security level

◆ SetSegments()

void wxPdfBarcodeZint::SetSegments ( const std::vector< wxPdfZintSeg > & segs )

Set the segments.

Parameters

segs	the array of segments

Note: clears text and sets eci

◆ SetSeparatorGS()

void wxPdfBarcodeZint::SetSeparatorGS ( bool gsSep )

inline

Use GS (Group Separator) instead of FNC1 as GS1 separator (Data Matrix)

Parameters

gsSep TRUE enables the group separator, FALSE disables it

◆ SetShowText()

void wxPdfBarcodeZint::SetShowText ( bool showText )

inline

Enable (true) or disable (false) Human Readable Text.

Parameters

showText TRUE enables human readable text, FALSE disables it

◆ SetStructApp()

void wxPdfBarcodeZint::SetStructApp	(	const int	count,
		const int	index,
		const wxString &	id )

◆ SetSymbology()

void wxPdfBarcodeZint::SetSymbology ( wxPdfBarcode::Symbology symbol )

inline

Set symbology to use.

Parameters

symbol the barcode symbology to use

◆ SetText()

void wxPdfBarcodeZint::SetText ( const wxString & text )

Set the input data.

Parameters

text	the barcode text

Note: clears segments

◆ SetTextGap()

void wxPdfBarcodeZint::SetTextGap ( double textGap )

inline

Set the text gap.

Parameters

textGap the text gap to use

◆ SetVerticalWhitespace()

void wxPdfBarcodeZint::SetVerticalWhitespace ( int vWhitespace )

inline

Get the height in X-dimensions of whitespace above & below the barcode.

Parameters

vWhitespace the height of whitespace

◆ SetWarnLevel()

void wxPdfBarcodeZint::SetWarnLevel ( int warnLevel )

inline

Set the warning level.

Parameters

warnLevel the requested warning level

◆ SetWhitespace()

void wxPdfBarcodeZint::SetWhitespace ( int whitespace )

inline

Set the width in X-dimensions of whitespace to left & right of barcode.

Parameters

whitespace the width of whitespace

◆ SetWidth()

void wxPdfBarcodeZint::SetWidth ( int width )

Set barcode width (option 1)

Parameters

width the barcode width

◆ ShowText()

bool wxPdfBarcodeZint::ShowText ( ) const

inline

Show (true) or hide (false) Human Readable Text.

Returns: TRUE if human readable text is enabled, FALSE otherwise

◆ SupportsECI()

static bool wxPdfBarcodeZint::SupportsECI ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology supports ECI.

Returns: TRUE if symbology supports ECI, FALSE otherwise

◆ SupportsFullMultibyte()

static bool wxPdfBarcodeZint::SupportsFullMultibyte ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology supports full multibyte.

Returns: TRUE if symbology supports full multibyte, FALSE otherwise

◆ SupportsGS1()

static bool wxPdfBarcodeZint::SupportsGS1 ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology supports GS1.

Returns: TRUE if symbology supports GS1, FALSE otherwise

◆ SupportsReaderInit()

static bool wxPdfBarcodeZint::SupportsReaderInit ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology supports reader init.

Returns: TRUE if symbology supports reader init, FALSE otherwise

◆ SupportsStructApp()

static bool wxPdfBarcodeZint::SupportsStructApp ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology supports structured apps.

Returns: TRUE if symbology supports structured apps, FALSE otherwise

◆ TakesGS1AIData()

static bool wxPdfBarcodeZint::TakesGS1AIData ( wxPdfBarcode::Symbology symbology )

static

Check whether symbology takes GS1 AI-delimited data.

Returns: TRUE if symbology takes GS1 AI-delimited data, FALSE otherwise

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

pdfbarcodezint.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ wxPdfBarcodeZint()

◆ ~wxPdfBarcodeZint()

Member Function Documentation

◆ ClearStructApp()

◆ GetBarcodeName()

◆ GetBgColour()

◆ GetBgColourStr()

◆ GetBorderType()

◆ GetBorderWidth()

◆ GetCMYK()

◆ GetCompliantHeight()

◆ GetDefaultXdim() [1/2]

◆ GetDefaultXdim() [2/2]

◆ GetDotSize()

◆ GetDotty()

◆ GetDpmm()

◆ GetECI()

◆ GetEncodedHeight()

◆ GetEncodedRows()

◆ GetEncodedWidth()

◆ GetError()

◆ GetFgColour()

◆ GetFgColourStr()

◆ GetFontSetting()

◆ GetGS1NoCheckMode()

◆ GetGuardDescent()

◆ GetHeight()

◆ GetInputMode()

◆ GetLastError()

◆ GetOption1()

◆ GetOption2()

◆ GetOption3()

◆ GetPrimaryMessage()

◆ GetRotateAngle()

◆ GetScale()

◆ GetSecurityLevel()

◆ GetSegments()

◆ GetStructAppCount()

◆ GetStructAppID()

◆ GetStructAppIndex()

◆ GetSymbology()

◆ GetText()

◆ GetTextGap()

◆ GetVectorHeight()

◆ GetVectorWidth()

◆ GetVersion()

◆ GetVerticalWhitespace()

◆ GetWarnLevel()

◆ GetWhitespace()

◆ GetWidth()

◆ HasCompliantHeight()

◆ HasDebugFlag()

◆ HasDefaultQuietZones()

◆ HasEmbedVectorFont()

◆ HasErrors()

◆ HasFixedRatio()

◆ HasGS1ParensMode()

◆ HasGuardWhitespace()

◆ HasHRT()

◆ HasMask()

◆ HasNoQuietZones()

◆ HasQuietZones()

◆ HasReaderInit()

◆ HasSeparatorGS()

◆ IsComposite()

◆ IsDotty()

◆ IsExtendable()

◆ IsStackable()

◆ IsValidSymbology()

◆ NoPNG()

◆ Render()

◆ SaveToFile()

◆ SetBgColour()

◆ SetBgColourStr()

◆ SetBorderType()

◆ SetBorderWidth()