gbc_barcode.h File Reference

Go to the source code of this file.

Typedefs
typedef struct gbcBarcode	gbcBarcode

Functions
void	gbc_barcode_delete (gbcBarcode *bc)
void	gbc_barcode_set_show_text (gbcBarcode *bc, bool value)
bool	gbc_barcode_get_show_text (gbcBarcode *bc)
void	gbc_barcode_set_checksum (gbcBarcode *bc, bool value)
bool	gbc_barcode_get_checksum (gbcBarcode *bc)
void	gbc_barcode_build (gbcBarcode *bc, char *data, double w, double h)
void	gbc_barcode_render (gbcBarcode *bc, gbcRenderer *renderer)
bool	gbc_barcode_is_empty (gbcBarcode *bc)
bool	gbc_barcode_is_data_valid (gbcBarcode *bc)
double	gbc_barcode_get_width (gbcBarcode *bc)
double	gbc_barcode_get_height (gbcBarcode *bc)

Detailed Description

CAPI front-end to glbarcode::Barcode.

Typedef Documentation

gbcBarcode

typedef struct gbcBarcode gbcBarcode

CAPI Base class for all barcode types.

Function Documentation

gbc_barcode_build()

void gbc_barcode_build	(	gbcBarcode *	bc,
		char *	data,
		double	w,
		double	h
	)

Build barcode from data.

Parameters

bc	pointer to barcode object
data	Data to encode in barcode
w	Requested width of barcode (0 = auto size)
h	Requested height of barcode (0 = auto size)

gbc_barcode_delete()

void gbc_barcode_delete

(

gbcBarcode *

bc

)

Delete gbcBarcode object.

Parameters

bc	pointer to barcode object

gbc_barcode_get_checksum()

bool gbc_barcode_get_checksum

(

gbcBarcode *

bc

)

Get accessor for "checksum" parameter.

Parameters

bc	pointer to barcode object

Returns

Value of boolean "checksum" parameter

gbc_barcode_get_height()

double gbc_barcode_get_height

(

gbcBarcode *

bc

)

Get actual height of barcode (may differ from requested height).

Parameters

bc	pointer to barcode object

Returns

Actual height of barcode (points)

gbc_barcode_get_show_text()

bool gbc_barcode_get_show_text

(

gbcBarcode *

bc

)

Get accessor for "show_text" parameter.

Parameters

bc	pointer to barcode object

Returns

Value of boolean "show_text" parameter

gbc_barcode_get_width()

double gbc_barcode_get_width

(

gbcBarcode *

bc

)

Get actual width of barcode (may differ from requested width).

Parameters

bc	pointer to barcode object

Returns

Actual width of barcode (points)

gbc_barcode_is_data_valid()

bool gbc_barcode_is_data_valid

(

gbcBarcode *

bc

)

Is barcode data valid?

Parameters

bc	pointer to barcode object

Returns

True if barcode data is valid

False if barcode data is not valid for implemented barcode type

gbc_barcode_is_empty()

bool gbc_barcode_is_empty

(

gbcBarcode *

bc

)

Is barcode data empty?

Parameters

bc	pointer to barcode object

Returns

True if barcode data is empty

False if barcode data is not empty

gbc_barcode_render()

void gbc_barcode_render	(	gbcBarcode *	bc,
		gbcRenderer *	renderer
	)

Render barcode using given Renderer object.

Parameters

bc	pointer to barcode object
renderer	A gbcRenderer object

gbc_barcode_set_checksum()

void gbc_barcode_set_checksum	(	gbcBarcode *	bc,
		bool	value
	)

Set accessor for "checksum" parameter.

Parameters

bc	pointer to barcode object
value	Boolean value

gbc_barcode_set_show_text()

void gbc_barcode_set_show_text	(	gbcBarcode *	bc,
		bool	value
	)

Set accessor for "show_text" parameter.

Parameters

bc	pointer to barcode object
value	Boolean value