gandi_register(3) - Linux man page

Name

Some information on GANDI widgets register.

Synopsis

#include <gandi_core.h>

int GANDI_registrate_widget(GANDIW_widget *w);

int GANDI_unregistrate_widget(GANDIW_widget *w);

Description

GANDI has a widgets register GANDI_widget. It is a null-terminated array of widgets' cores. If a widget is not present in the register, it will not be controlled by the GANDI_driver and it will never be focused. The Timer (see gandi_timer(3gandi)) will ignore it as well.

Usually, there is no need to use these routines.

int GANDI_registrate_widget(GANDIW_widget *w);

Adds a widget to the end of the register. It does NOT check whether w is in the register already. Inclusion of one widget twice may cause problems.

This function returns either OK or ERR.

There is a global variable GANDI_registrate of bool type. If it is FALSE, then this function does nothing, therefore all new widgets will not be added to the register although the return value is OK.

int GANDI_unregistrate_widget(GANDIW_widget *w);

Removes w from the register.

It returns either OK or ERR. The ERR signifies that either something has gone wrong or the register does not contains w.

There is a global variable GANDI_unregistrate of bool type. If it is FALSE, then this function does nothing, although the return value is OK. The function GANDI_kill_emptywidget (see gandi_widget(3gandi)) calls this automatically. It is useful to know, that any _kill function from any widget library calls GANDI_kill_emptywidget.

Notes

These are exclusive function, they work with widget's CORE! Never specify void * widget to them!