lv_barcode.h

lv_barcode_set_dark_color

Set the dark color of a barcode object. Only rewrites the palette, so it takes effect before or after the data and never regenerates the bars.

void lv_barcode_set_dark_color(lv_obj_t *obj, lv_color_t color)

lv_barcode_set_light_color

Set the light color of a barcode object. Only rewrites the palette, so it takes effect before or after the data and never regenerates the bars.

void lv_barcode_set_light_color(lv_obj_t *obj, lv_color_t color)

lv_barcode_set_scale

Set the scale of a barcode object, i.e. the pixel width of a single bar. The stored data is re-generated, so this may be called before or after the data.

void lv_barcode_set_scale(lv_obj_t *obj, uint16_t scale)

lv_barcode_set_direction

Set the direction of a barcode object. The stored data is re-generated, so this may be called before or after the data.

void lv_barcode_set_direction(lv_obj_t *obj, lv_dir_t direction)

lv_barcode_set_tiled

Set the tiled mode of a barcode object. The stored data is re-generated, so this may be called before or after the data.

void lv_barcode_set_tiled(lv_obj_t *obj, bool tiled)

lv_barcode_set_encoding

Set the encoding of a barcode object. The stored data is re-generated, so this may be called before or after the data.

void lv_barcode_set_encoding(lv_obj_t *obj, lv_barcode_encoding_t encoding)

lv_barcode_set_update_mode

Set when a change is turned into a new barcode bitmap. Applies to the data and to the scale, direction, tiled mode and encoding; the colors are never affected.

void lv_barcode_set_update_mode(lv_obj_t *obj, lv_barcode_update_mode_t mode)

lv_barcode_get_update_mode

Get when a property change is turned into a new barcode bitmap.

lv_barcode_update_mode_t lv_barcode_get_update_mode(lv_obj_t *obj)

Returns: lv_barcode_update_mode_t — the update mode currently in use

lv_barcode_get_dark_color

Get the dark color of a barcode object

lv_color_t lv_barcode_get_dark_color(lv_obj_t *obj)

Returns: lv_color_t — dark color of the barcode

lv_barcode_get_light_color

Get the light color of a barcode object

lv_color_t lv_barcode_get_light_color(lv_obj_t *obj)

Returns: lv_color_t — light color of the barcode

lv_barcode_get_scale

Get the scale of a barcode object

uint16_t lv_barcode_get_scale(lv_obj_t *obj)

Returns: uint16_t — scale factor

lv_barcode_get_encoding

Get the encoding of a barcode object

lv_barcode_encoding_t lv_barcode_get_encoding(const lv_obj_t *obj)

Returns: lv_barcode_encoding_t — encoding

lv_barcode_create

Create an empty barcode (an lv_canvas) object.

lv_obj_t * lv_barcode_create(lv_obj_t *parent)

Returns: lv_obj_t * — pointer to the created barcode object

lv_barcode_update

Set the data of a barcode object and generate the bitmap. A copy is stored, so a later property change or resize can regenerate it; the properties may be set before or after the data, in any order.

lv_result_t lv_barcode_update(lv_obj_t *obj, const char *data)

Returns: lv_result_t — LV_RESULT_OK: if no error; LV_RESULT_INVALID: on error

lv_barcode_render

(Re)generate the barcode bitmap from the stored data, whether or not anything changed. Needs no data argument, which is how deferred changes are applied.

lv_result_t lv_barcode_render(lv_obj_t *obj)

Returns: lv_result_t — LV_RESULT_OK: if no error; LV_RESULT_INVALID: on error (e.g. no data set, or the bars do not fit the current object size)

lv_barcode_is_render_valid

Check whether the bitmap is free of a known generation failure. lv_barcode_render(), and lv_barcode_update() in IMMEDIATE mode, return their result directly; the rest cannot - they run in a void setter, the resize handler, or a deferred fill in the draw pass. Use this for those, e.g. after shrinking the object below the size its data needs.

bool lv_barcode_is_render_valid(lv_obj_t *obj)

Returns: bool — true: no generation attempt is known to have failed. A change re-arms the Widget, so this is also true while a deferred regeneration is still pending; false: the last generation attempt failed, or no data has been set yet