NetSurf: fbtk_widget_s Struct Reference

NetSurf

Widget description. More...

#include <widget.h>

Collaboration diagram for fbtk_widget_s:

Data Fields
struct fbtk_widget_s *	next

struct fbtk_widget_s *	prev

struct fbtk_widget_s *	parent

struct fbtk_widget_s *	first_child

struct fbtk_widget_s *	last_child

bool	mapped
	The widget is mapped/visible . More...

int	x

int	y

int	width

int	height

colour	bg

colour	fg

fbtk_callback	callback [FBTK_CBT_END]

void *	callback_context [FBTK_CBT_END]

struct {
bool child

bool needed

int x

int y

int width

int height

}	redraw

enum fbtk_widgettype_e	type
	The type of the widget. More...

union {
struct {
nsfb_t * fb

struct fbtk_widget_s * prev

struct fbtk_widget_s * grabbed

struct fbtk_widget_s * input

struct {
struct fbtk_widget_s * owner

int x

int y

int height

void(* remove_cb )(fbtk_widget_t *widget)

} caret

} root

struct {
struct fbtk_bitmap * bitmap

} bitmap

struct {
char * text

bool outline

fbtk_enter_t enter

void * pw

int idx

int len

int width

int idx_offset

} text

struct {
void * pw

} user

struct {
int minimum

int maximum

int thumb

int page

int position

int drag

int drag_position

struct fbtk_widget_s * btnul

struct fbtk_widget_s * btndr

} scroll

}	u

Detailed Description

Widget description.

A widget is an entry in a tree structure which represents a rectangular area with co-ordinates relative to its parent widget. This area has a distinct set of callback operations for handling events which occour within its boundries. A widget may have an arbitrary number of child widgets. The order within the tree determines a widgets z order.

A | +-------—+ +—>| Button 3 | | +-------—+ | | A | V | | +-------—+ | | Button 2 | | +-------—+ | | A | V | | +-------—+ | | Button 1 | | +-------—+ | | A | V | — | +-------—+ A | +->| Filled | | | | +-------—+ +-------—+ | | | +-—>| |-+ | V | | Window 1 | | — — | | |—+ A | +-------—+ | | | A +-------—+ — | | | +—>| Button 2 | A | | | | +-------—+ | | | | | | A +----------—+ | | | | | | +—>| Button Up | | | | | | | | +----------—+ | | | | | | | | A | | | | | | | V | | | | | | | | +----------—+ | | | | | | | | Button Down | | | | | | | | +----------—+ | | | | | | | | A | | | | | | | V | | | | | | | | +----------—+ | | | | | | | +->| Scroller | | | | | V | | | +----------—+ | | | | +-------—+ | | | | | | | | |-+ | V | | | | | V Scroll | | — | | | | | |—+ | | | | +-------—+ | | | | | A | | | | V | | | | | +-------—+ | | | | +->| Button 1 | | | | | | +-------—+ | +-------—+ | | | | | |-+ | V | | Window 2 | | — | | |—+ | +-------—+ | | A | V | | +---------—+ — | | Background | A | +->| Bitmap | | | | +---------—+ +---—+ | | | | |-+ | V | Root | | — | |—+ +---—+ |

V

Every widget is contained within this generic wrapper. The integrated union provides for data specific to a widget type.

Definition at line 120 of file widget.h.

Field Documentation

◆ bg

colour fbtk_widget_s::bg

Definition at line 137 of file widget.h.

Referenced by fb_redraw_bitmap(), fb_redraw_fill(), fb_redraw_text(), fb_redraw_text_button(), fb_redraw_window(), fb_text_font_style(), fbtk_create_bitmap(), fbtk_create_button(), fbtk_create_fill(), fbtk_create_hscroll(), fbtk_create_text(), fbtk_create_text_button(), fbtk_create_vscroll(), fbtk_create_window(), fbtk_create_writable_text(), hscroll_redraw(), and vscroll_redraw().

◆ bitmap [1/2]

struct fbtk_bitmap* fbtk_widget_s::bitmap

Definition at line 177 of file widget.h.

Referenced by fb_redraw_bitmap(), fbtk_create_bitmap(), fbtk_create_button(), and fbtk_set_bitmap().

◆ [2/2]

struct { ... } fbtk_widget_s::bitmap

◆ btndr

struct fbtk_widget_s* fbtk_widget_s::btndr

Definition at line 206 of file widget.h.

Referenced by fbtk_create_hscroll(), fbtk_create_vscroll(), fbtk_reposition_hscroll(), and fbtk_reposition_vscroll().

◆ btnul

struct fbtk_widget_s* fbtk_widget_s::btnul

Definition at line 205 of file widget.h.

Referenced by fbtk_create_hscroll(), fbtk_create_vscroll(), fbtk_reposition_hscroll(), and fbtk_reposition_vscroll().

◆ callback

fbtk_callback fbtk_widget_s::callback[FBTK_CBT_END]

Definition at line 141 of file widget.h.

Referenced by fbtk_get_handler(), fbtk_post_callback(), and fbtk_set_handler().

◆ callback_context

void* fbtk_widget_s::callback_context[FBTK_CBT_END]

Definition at line 142 of file widget.h.

Referenced by fbtk_post_callback(), and fbtk_set_handler().

◆

struct { ... } fbtk_widget_s::caret

◆ child

bool fbtk_widget_s::child

Definition at line 146 of file widget.h.

Referenced by do_redraw(), and fbtk_request_redraw().

◆ drag

int fbtk_widget_s::drag

Definition at line 203 of file widget.h.

Referenced by hscroll_drag(), hscrollarea_click(), vscroll_drag(), and vscrollarea_click().

◆ drag_position

int fbtk_widget_s::drag_position

Definition at line 204 of file widget.h.

Referenced by hscroll_drag(), hscrollarea_click(), vscroll_drag(), and vscrollarea_click().

◆ enter

fbtk_enter_t fbtk_widget_s::enter

Definition at line 184 of file widget.h.

◆ fb

nsfb_t* fbtk_widget_s::fb

Definition at line 160 of file widget.h.

◆ fg

colour fbtk_widget_s::fg

Definition at line 138 of file widget.h.

Referenced by fb_text_font_style(), fbtk_create_hscroll(), fbtk_create_text(), fbtk_create_text_button(), fbtk_create_vscroll(), fbtk_create_writable_text(), hscroll_redraw(), and vscroll_redraw().

◆ first_child

struct fbtk_widget_s* fbtk_widget_s::first_child

Definition at line 126 of file widget.h.

Referenced by fbtk_destroy_widget(), fbtk_get_widget_at(), and swap_siblings().

◆ grabbed

struct fbtk_widget_s* fbtk_widget_s::grabbed

Definition at line 162 of file widget.h.

◆ height

int fbtk_widget_s::height

Definition at line 136 of file widget.h.

Referenced by do_redraw(), fb_text_font_style(), fbtk_clip_to_widget(), fbtk_get_bbox(), fbtk_get_height(), fbtk_get_widget_at(), fbtk_request_redraw(), fbtk_set_pos_and_size(), fbtk_set_text(), fbtk_warp_pointer(), fbtk_widget_new(), hscroll_redraw(), text_input(), text_input_click(), vscroll_drag(), vscroll_redraw(), and vscrollarea_click().

◆ idx

int fbtk_widget_s::idx

Definition at line 186 of file widget.h.

◆ idx_offset

int fbtk_widget_s::idx_offset

Definition at line 189 of file widget.h.

◆ input

struct fbtk_widget_s* fbtk_widget_s::input

Definition at line 163 of file widget.h.

◆ last_child

struct fbtk_widget_s* fbtk_widget_s::last_child

Definition at line 127 of file widget.h.

Referenced by do_redraw(), fbtk_request_redraw(), and swap_siblings().

◆ len

int fbtk_widget_s::len

Definition at line 187 of file widget.h.

◆ mapped

bool fbtk_widget_s::mapped

The widget is mapped/visible .

Definition at line 130 of file widget.h.

Referenced by fbtk_create_bitmap(), fbtk_create_button(), fbtk_create_fill(), fbtk_create_hscroll(), fbtk_create_text(), fbtk_create_text_button(), fbtk_create_user(), fbtk_create_vscroll(), fbtk_create_writable_text(), fbtk_get_widget_at(), fbtk_post_callback(), fbtk_request_redraw(), and fbtk_set_mapping().

◆ maximum

int fbtk_widget_s::maximum

Definition at line 199 of file widget.h.

Referenced by fbtk_set_scroll_parameters(), fbtk_set_scroll_position(), hscroll_drag(), hscroll_redraw(), hscrollarea_click(), hscrollr_click(), vscroll_drag(), vscroll_redraw(), vscrollarea_click(), and vscrolld_click().

◆ minimum

int fbtk_widget_s::minimum

Definition at line 198 of file widget.h.

Referenced by fbtk_set_scroll_parameters(), hscroll_drag(), hscroll_redraw(), hscrollarea_click(), hscrolll_click(), vscroll_drag(), vscroll_redraw(), vscrollarea_click(), and vscrollu_click().

◆ needed

bool fbtk_widget_s::needed

Definition at line 147 of file widget.h.

Referenced by do_redraw(), and fbtk_request_redraw().

◆ next

struct fbtk_widget_s* fbtk_widget_s::next

Definition at line 121 of file widget.h.

Referenced by fbtk_destroy_widget(), fbtk_get_widget_at(), fbtk_set_zorder(), fbtk_widget_new(), gui_window_create(), and swap_siblings().

◆ outline

bool fbtk_widget_s::outline

Definition at line 183 of file widget.h.

◆ owner

struct fbtk_widget_s* fbtk_widget_s::owner

Definition at line 167 of file widget.h.

◆ page

int fbtk_widget_s::page

Definition at line 201 of file widget.h.

Referenced by fbtk_set_scroll_parameters(), hscrollarea_click(), hscrolll_click(), hscrollr_click(), vscrollarea_click(), vscrolld_click(), and vscrollu_click().

◆ parent

struct fbtk_widget_s* fbtk_widget_s::parent

Definition at line 124 of file widget.h.

Referenced by fbtk_destroy_widget(), fbtk_get_absx(), fbtk_get_absy(), fbtk_get_bbox(), fbtk_get_root_widget(), fbtk_request_redraw(), fbtk_set_mapping(), fbtk_set_pos_and_size(), fbtk_widget_new(), and swap_siblings().

◆ position

int fbtk_widget_s::position

Definition at line 202 of file widget.h.

Referenced by fbtk_set_scroll_parameters(), fbtk_set_scroll_position(), hscroll_drag(), hscroll_redraw(), hscrollarea_click(), hscrolll_click(), hscrollr_click(), vscroll_drag(), vscroll_redraw(), vscrollarea_click(), vscrolld_click(), and vscrollu_click().

◆ prev

struct fbtk_widget_s* fbtk_widget_s::prev

Definition at line 122 of file widget.h.

Referenced by do_redraw(), fbtk_destroy_widget(), fbtk_request_redraw(), fbtk_set_zorder(), fbtk_widget_new(), and swap_siblings().

◆ pw

void* fbtk_widget_s::pw

Definition at line 185 of file widget.h.

Referenced by fbtk_create_user(), and fbtk_get_userpw().

◆

struct { ... } fbtk_widget_s::redraw

Referenced by do_redraw(), and fbtk_request_redraw().

◆ remove_cb

void(* fbtk_widget_s::remove_cb) (fbtk_widget_t *widget)

Definition at line 171 of file widget.h.

◆

struct { ... } fbtk_widget_s::root

◆

struct { ... } fbtk_widget_s::scroll

Referenced by fbtk_create_hscroll(), fbtk_create_vscroll(), fbtk_reposition_hscroll(), fbtk_reposition_vscroll(), fbtk_set_scroll_parameters(), fbtk_set_scroll_position(), hscroll_drag(), hscroll_redraw(), hscrollarea_click(), hscrolll_click(), hscrollr_click(), vscroll_drag(), vscroll_redraw(), vscrollarea_click(), vscrolld_click(), and vscrollu_click().

◆ text [1/2]

char* fbtk_widget_s::text

Definition at line 182 of file widget.h.

Referenced by fb_destroy_text(), fb_redraw_text(), fb_redraw_text_button(), fb_text_font_style(), fbtk_create_text(), fbtk_create_text_button(), fbtk_create_writable_text(), fbtk_set_text(), fbtk_writable_text(), gui_window_create(), text_input(), and text_input_click().

◆ [2/2]

struct { ... } fbtk_widget_s::text

◆ thumb

int fbtk_widget_s::thumb

Definition at line 200 of file widget.h.

Referenced by fbtk_set_scroll_parameters(), hscroll_drag(), hscroll_redraw(), hscrollarea_click(), hscrollr_click(), vscroll_drag(), vscroll_redraw(), vscrollarea_click(), and vscrolld_click().

◆ type

enum fbtk_widgettype_e fbtk_widget_s::type

The type of the widget.

Definition at line 154 of file widget.h.

Referenced by fb_destroy_text(), fbtk_get_root_widget(), fbtk_get_userpw(), fbtk_reposition_hscroll(), fbtk_reposition_vscroll(), fbtk_set_bitmap(), fbtk_set_scroll_parameters(), fbtk_set_scroll_position(), fbtk_set_text(), and fbtk_widget_new().

◆

◆

struct { ... } fbtk_widget_s::user

Referenced by fbtk_create_user(), and fbtk_get_userpw().

◆ width

int fbtk_widget_s::width

Definition at line 135 of file widget.h.

Referenced by do_redraw(), fb_redraw_text(), fbtk_clip_to_widget(), fbtk_get_bbox(), fbtk_get_widget_at(), fbtk_get_width(), fbtk_request_redraw(), fbtk_set_pos_and_size(), fbtk_warp_pointer(), fbtk_widget_new(), hscroll_drag(), hscroll_redraw(), hscrollarea_click(), and vscroll_redraw().

◆ x

int fbtk_widget_s::x

Definition at line 133 of file widget.h.

Referenced by do_redraw(), fbtk_get_absx(), fbtk_get_bbox(), fbtk_get_widget_at(), fbtk_request_redraw(), fbtk_set_pos_and_size(), and fbtk_widget_new().

◆ y

int fbtk_widget_s::y

Definition at line 134 of file widget.h.

Referenced by do_redraw(), fbtk_get_absy(), fbtk_get_bbox(), fbtk_get_widget_at(), fbtk_request_redraw(), fbtk_set_pos_and_size(), and fbtk_widget_new().

The documentation for this struct was generated from the following file:

frontends/framebuffer/fbtk/widget.h