gp_widget_label.h File Reference

A label widget. More...

#include <stdlib.h>
#include <core/gp_compiler.h>

Go to the source code of this file.

Enumerations
enum	gp_widget_label_flags { GP_WIDGET_LABEL_FRAME =0x01 }
	A label flags. More...

Functions
void	gp_widget_label_set (gp_widget *self, const char *text)
	Sets the label text.
const char *	gp_widget_label_get (gp_widget *self)
	Gets the label text.
void	gp_widget_labe_fmt_set (gp_widget *self, const char *text_fmt)
	Sets the label text format.
void	gp_widget_label_fmt_var_set (gp_widget *self, const char *fmt,...)
	Sets label accordingly to text format string.
void	gp_widget_label_append (gp_widget *self, const char *text)
	Appends text to the label.
int	gp_widget_label_printf (gp_widget *self, const char *fmt,...) __attribute__((format(printf
	Printf-like function to set label text.
int void	gp_widget_label_vprintf (gp_widget *self, const char *fmt, va_list ap)
	VPrintf-like function to set label text.
void	gp_widget_label_tattr_set (gp_widget *self, gp_widget_tattr tattr)
	Changes text attributes.
gp_widget_tattr	gp_widget_label_tattr_get (gp_widget *self)
	Gets text attributes.
void	gp_widget_label_width_set (gp_widget *self, unsigned int width)
	Changes widget minimal width.
unsigned int	gp_widget_label_width_get (gp_widget *self)
	Returns widget minimal width.
void	gp_widget_label_flags_set (gp_widget *self, enum gp_widget_label_flags flags)
	Sets frame flags.
enum gp_widget_label_flags	gp_widget_label_flags_get (gp_widget *self)
	Gets frame flags.
gp_widget *	gp_widget_label_new (const char *text, gp_widget_tattr tattr, unsigned int width)
	Allocates a label widget.
gp_widget *	gp_widget_label_printf_new (gp_widget_tattr tattr, const char *fmt,...) __attribute__((format(printf
	Printf-like function to create a label widget.

Detailed Description

A label widget.

A label widget is a single line of a text.

A note about the widget size

Unless widget 'size' is set the widget grows its size to fit the content without any limitations, which is only useful for cases where the label text is under your control and all possible values are known in advance.

If you have a label whose text is outside of your control, e.g. the value is a result of some system call, RPC call, etc, it's important to set the label size so that the label will not grow undefinitelly. The most useful combination is to set both label 'size' along with 'hfill' alignment in which case the label will fill all available horizontal space and the 'size' will function as a minimal widget size. The text inside of the label widget can be aligned with gp_widget_tattr text attributes.

Label JSON attributes

Attribute	Type	Default	Description
text	string		A label text.
tattr	string	normal	Text attributes gp_widget_tattr, e.g. bold.
width	uint	0	Label text size in characters.
frame	bool	false	Draw frame around label, implies min padd = 1
padd	uint	0	Padd inside label on left and right.
bg_color	string	"bg"	Background gp_widgets_color.
text_color	string	"text"	Text gp_widgets_color.
reverse_colors	bool	false	Reverse background and text color.

Definition in file gp_widget_label.h.

Enumeration Type Documentation

gp_widget_label_flags

enum gp_widget_label_flags

A label flags.

Enumerator
GP_WIDGET_LABEL_FRAME	Draws a frame around the label.

Definition at line 53 of file gp_widget_label.h.

Function Documentation

gp_widget_labe_fmt_set()

void gp_widget_labe_fmt_set	(	gp_widget *	self,
		const char *	text_fmt
	)

Sets the label text format.

The text format may include a variable that can be then set.

Parameters

self	A label widget.
text_fmt	A text format.

gp_widget_label_append()

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

Appends text to the label.

Parameters

self	A label widget.
text	Text to be appended.

gp_widget_label_flags_get()

enum gp_widget_label_flags gp_widget_label_flags_get

(

gp_widget *

self

)

Gets frame flags.

Parameters

self	A label widget.

Returns

A label flags.

gp_widget_label_flags_set()

void gp_widget_label_flags_set	(	gp_widget *	self,
		enum gp_widget_label_flags	flags
	)

Sets frame flags.

Parameters

self	A label widget.
flags	A new label flags.

gp_widget_label_fmt_var_set()

void gp_widget_label_fmt_var_set	(	gp_widget *	self,
		const char *	fmt,
			...
	)

Sets label accordingly to text format string.

Parameters

self	A label widget.
fmt	Printf-like format
...	Printf-like parameters.

gp_widget_label_get()

const char * gp_widget_label_get

(

gp_widget *

self

)

Gets the label text.

Parameters

self	A label widget.

Returns

A label text.

gp_widget_label_new()

gp_widget * gp_widget_label_new	(	const char *	text,
		gp_widget_tattr	tattr,
		unsigned int	width
	)

Allocates a label widget.

Label minimal width is a bit more complicated topic since labels can change content and hence size dynamically. There are two different modes of operation.

• If width is set, the size is set to stone so that the label can hold width characters. The main problem is that for proprotional fonts the allocated space is huge because we account for maximal character width. To accomodate for that you can also pass a string with subset of characters that are expected to appear in the label to make that computation more precise.
• If width is not set, i.e. set to zero, the size is computed accordintly to the current label text, however by default the widget does not shrink, e.g. if the new string width is shorter than the last one we do not trigger resize, which avoids for the layout to size to jump on label text changes. You can manually trigger shrinking by calling gp_widget_resize().

Parameters

text	A label text.
tattr	Text attributes, e.g. bold.
width	Maximal expected text width, if set to non-zero it's used to callculate the label size.

Returns

Newly allocated label widget.

gp_widget_label_printf()

int gp_widget_label_printf	(	gp_widget *	self,
		const char *	fmt,
			...
	)

Printf-like function to set label text.

Parameters

self	A label widget.
fmt	Printf formatting string.
...	Printf parameters.

Returns

Number of characters printed.

gp_widget_label_printf_new()

gp_widget * gp_widget_label_printf_new	(	gp_widget_tattr	tattr,
		const char *	fmt,
			...
	)

Printf-like function to create a label widget.

Parameters

tattr	Text attributes, e.g. bold.
fmt	Printf formatting string.
...	Printf parameters.

Returns

Newly allocated label widget.

gp_widget_label_set()

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

Sets the label text.

Parameters

self	A label widget.
text	New widget label text.

gp_widget_label_tattr_get()

gp_widget_tattr gp_widget_label_tattr_get

(

gp_widget *

self

)

Gets text attributes.

Parameters

self	A label widget.

Returns

A label text attributes.

gp_widget_label_tattr_set()

void gp_widget_label_tattr_set	(	gp_widget *	self,
		gp_widget_tattr	tattr
	)

Changes text attributes.

Parameters

self	A label widget.
tattr	New text attributes.

gp_widget_label_vprintf()

int void gp_widget_label_vprintf	(	gp_widget *	self,
		const char *	fmt,
		va_list	ap
	)

VPrintf-like function to set label text.

Parameters

self	A label widget.
fmt	Printf formatting string.
ap	Printf parameters.

gp_widget_label_width_get()

unsigned int gp_widget_label_width_get

(

gp_widget *

self

)

Returns widget minimal width.

Parameters

self	Pointer to a label widget.

Returns

Label width, the unit for the width is font average characters. Return zero if minimal size is not set.

gp_widget_label_width_set()

void gp_widget_label_width_set	(	gp_widget *	self,
		unsigned int	width
	)

Changes widget minimal width.

Parameters

self	Pointer to a label widget.
width	New label width, the unit for the width is font average characters.