gp_widget_log.h File Reference

A text log widget. More...

#include <stdlib.h>
#include <utils/gp_cbuffer.h>

Go to the source code of this file.

Functions
void	gp_widget_log_append (gp_widget *self, const char *text)
	Appends text to the log.
gp_widget *	gp_widget_log_new (gp_widget_tattr tattr, unsigned int min_width, unsigned int min_lines, size_t max_logs)
	Allocates a log widget.

Detailed Description

A text log widget.

Log widget JSON attributes

Attribute	Type	Default	Description
max_logs	uint		A maximal number of log lines the widget can store.
min_lines	uint	25	A minimal number of log lines visible on the screen.
min_width	uint	80	A minimal widget width in text characters.
tattr	string	normal	Log text attributes gp_widget_tattr, e.g. mono for monospace.

Definition in file gp_widget_log.h.

Function Documentation

gp_widget_log_append()

void gp_widget_log_append	(	gp_widget *	self,
		const char *	text
	)

Appends text to the log.

Parameters

self	A log widget.
text	Text to be appended.

gp_widget_log_new()

gp_widget * gp_widget_log_new	(	gp_widget_tattr	tattr,
		unsigned int	min_width,
		unsigned int	min_lines,
		size_t	max_logs
	)

Allocates a log widget.

The log widget is a circular buffer of loglines, when size reaches the max_log_lines the oldest message gets removed from the log.

Parameters

tattr	Text attributes
min_width	Minimal width in letters
min_lines	Minimal number of lines
max_logs	Maximal number of log lines stored internally.

Returns

Newly allocated log widget.