widget.h File Reference

Text widgets. More...

#include <curses.h>

Go to the source code of this file.

Data Structures
struct	widget
	A text widget. More...
struct	widget_operations
	Text widget operations. More...

Enumerations
enum	widget_flags { WIDGET_EDITABLE = 0x0001, WIDGET_SECRET = 0x0002 }
	Text widget flags. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static void	init_widget (struct widget *widget, struct widget_operations *op, unsigned int row, unsigned int col, unsigned int width, unsigned int flags)
	Initialise text widget. More...
static void	draw_widget (struct widget *widget)
	Draw text widget. More...
static int	edit_widget (struct widget *widget, int key)
	Edit text widget. More...

Detailed Description

Text widgets.

Definition in file widget.h.

Enumeration Type Documentation

widget_flags

enum widget_flags

Text widget flags.

Enumerator
WIDGET_EDITABLE	Widget may have input focus.
WIDGET_SECRET	Widget contains a secret.

Definition at line 30 of file widget.h.

                  {
        /** Widget may have input focus */
        WIDGET_EDITABLE = 0x0001,
        /** Widget contains a secret */
        WIDGET_SECRET = 0x0002,
};

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

init_widget()

static void init_widget ( struct widget *  widget, struct widget_operations *  op, unsigned int  row, unsigned int  col, unsigned int  width, unsigned int  flags  )

inlinestatic

Initialise text widget.

Parameters

widget	Text widget
op	Text widget operations
row	Row
col	Starting column
width	Width

Definition at line 69 of file widget.h.

                                   {

        widget->op = op;
        widget->row = row;
        widget->col = col;
        widget->width = width;
        widget->flags = flags;
}

References widget::col, flags, widget::flags, widget::op, op, widget::row, and widget::width.

Referenced by init_editbox(), and init_label().

draw_widget()

static void draw_widget ( struct widget *  widget )

inlinestatic

Draw text widget.

Parameters

widget

Text widget

Definition at line 86 of file widget.h.

                                      {

        widget->op->draw ( widget );
}

References widget_operations::draw, and widget::op.

Referenced by draw_form(), form_loop(), and main_loop().

edit_widget()

static int edit_widget ( struct widget *  widget, int  key  )

inlinestatic

Edit text widget.

Parameters

widget	Text widget
key	Key pressed by user

Return values

key	Key returned to application, or zero

This will not update the display: you must call draw_widget() to ensure that any changes to an editable widget are displayed to the user.

Definition at line 103 of file widget.h.

                                               {

        return widget->op->edit ( widget, key );
}

References widget_operations::edit, key, and widget::op.

Referenced by edit_setting(), and form_loop().