gp_widget_frame.h File Reference

A frame widget. More...

Go to the source code of this file.

Functions
gp_widget *	gp_widget_frame_new (const char *title, gp_widget_tattr tattr, gp_widget *child)
	Allocates and initializes a new frame widget.
void	gp_widget_frame_title_set (gp_widget *self, const char *title)
	Sets a new frame title.
gp_widget *	gp_widget_frame_put (gp_widget *self, gp_widget *child)
	Puts a child widget into a frame widget.

Detailed Description

A frame widget.

Frame widget JSON attributes

Attribute	Type	Default	Description
title	string		A frame title.
tattr	string	"bold"	A title text attribute, parsed by gp_widget_tattr_parse().
widget	object		A frame child widget.

Definition in file gp_widget_frame.h.

Function Documentation

gp_widget_frame_new()

gp_widget * gp_widget_frame_new	(	const char *	title,
		gp_widget_tattr	tattr,
		gp_widget *	child
	)

Allocates and initializes a new frame widget.

Parameters

title	A frame title, there is no title if NULL is passed.
tattr	A text attribute monospace/bold/large etc.
child	Frame widget child widget.

Returns

A frame widget.

gp_widget_frame_put()

gp_widget * gp_widget_frame_put	(	gp_widget *	self,
		gp_widget *	child
	)

Puts a child widget into a frame widget.

Parameters

self	A frame widget.
child	A child widget.

Returns

Returns previous frame widget child or NULL if frame had no child.

gp_widget_frame_title_set()

void gp_widget_frame_title_set	(	gp_widget *	self,
		const char *	title
	)

Sets a new frame title.

Parameters

self	A frame widget.
title	New frame title.