Frame widget

Frame widget provides a frame with border and a title bar.

It can be configured to be resizable and movable.

Typedefs
typedef bool(*	wtk_frame_handler_t )(struct wtk_frame *frame, win_command_t command_data)
	Frame command event handler callback. More...

Functions
struct win_window *	wtk_frame_as_child (struct wtk_frame *frame)
	This function returns a reference to the window that should be used when managing the widget, such as move, resize, destroy and reparenting. More...
struct win_window *	wtk_frame_as_parent (struct wtk_frame *frame)
	This function returns a reference to the window that should be used as a parent for child widgets and windows. More...
struct wtk_frame *	wtk_frame_create (struct win_window *parent, struct win_area const *area, char const *caption, bool allow_resize, wtk_frame_handler_t frame_handler, void *custom_data)
	This function creates a new frame widget. More...
void *	wtk_frame_get_custom_data (struct wtk_frame const *frame)
	This function returns the custom data from the frame's attributes. More...
static bool	wtk_frame_handler (struct win_window *win, enum win_event_type type, void const *data)
	This function is the window event handler for frame widgets. More...

typedef bool(* wtk_frame_handler_t)(struct wtk_frame *frame, win_command_t command_data)

Frame command event handler callback.

struct win_window* wtk_frame_as_child

(

struct wtk_frame *

frame

)

This function returns a reference to the window that should be used when managing the widget, such as move, resize, destroy and reparenting.

Parameters

frame

Frame widget to manage.

Returns

Window to be used for managing the frame.

References Assert, and wtk_frame::container.

struct win_window* wtk_frame_as_parent

(

struct wtk_frame *

frame

)

This function returns a reference to the window that should be used as a parent for child widgets and windows.

This corresponds to the internal area inside borders and title bar.

Parameters

frame

Frame widget to be a parent.

Returns

Window to be used as parent for child contents.

References Assert, and wtk_frame::contents.

struct wtk_frame* wtk_frame_create	(	struct win_window *	parent,
		struct win_area const *	area,
		char const *	caption,
		bool	allow_resize,
		wtk_frame_handler_t	frame_handler,
		void *	custom_data
	)

This function creates a new frame widget.

It allocates required memory and intializes necessary windows to create the widget. If there is not enough memory, the function returns NULL.

To destroy the widget and all its contents, and free its memory, call win_destroy() on the frame's child reference, given by wtk_frame_as_child(), like this: "win_destroy(wtk_frame_as_child(my_frame_ptr));". The frame's internal area will equal the area parameter, but the total extents will be slightly larger, to accommodate for titlebar, borders etc.

Parameters

parent	Parent window.
area	Area of the internal contents.
caption	Pointer to caption string. Will be copied into widget.
allow_resize	True if resize handle should be included on the frame.
frame_handler	Optional command event handler, for applications.
custom_data	Optional custom data link, for applications.

Returns

Pointer to frame, or NULL if failed.

References win_attributes::area, Assert, win_attributes::background, win_attributes::behavior, wtk_frame::caption, wtk_frame::container, wtk_frame::contents, win_attributes::custom, wtk_frame::custom_data, win_attributes::event_handler, wtk_frame::frame_handler, membag_alloc(), membag_free(), NULL, win_area::pos, wtk_frame::resize, win_area::size, wtk_frame::state, WIN_BEHAVIOR_RAISE_ON_PRESS, win_create(), win_destroy(), win_show(), wtk_copy_string(), wtk_frame_background, wtk_frame_handler(), WTK_FRAME_NORMAL, wtk_resize_frame(), win_point::x, and win_point::y.

void* wtk_frame_get_custom_data

(

struct wtk_frame const *

frame

)

This function returns the custom data from the frame's attributes.

The custom data can be used for e.g. linking to associated applications.

Parameters

frame

Pointer to frame.

Returns

Copy of the custom data.

References Assert, and wtk_frame::custom_data.

static bool wtk_frame_handler ( struct win_window *  win, enum win_event_type  type, void const *  data  )

static

This function is the window event handler for frame widgets.

It handles all events sent to the windows composing the widget.

Parameters

win	Window receiving the event.
type	The event type.
data	Custom data, depending on event type.

Returns

True if the event was recognized and accepted.

References wtk_frame::caption, wtk_frame::container, wtk_frame::frame_handler, GFX_COLOR_TRANSPARENT, gfx_draw_filled_circle, gfx_draw_filled_rect, gfx_draw_string(), GFX_QUADRANT1, membag_free(), win_clip_region::origin, wtk_frame::resize, win_area::size, sysfont, win_destroy(), WIN_EVENT_COMMAND, WIN_EVENT_DESTROY, WIN_EVENT_DRAW, WIN_EVENT_POINTER, win_get_area(), win_get_custom_data(), WIN_POINTER_MOVE, WIN_POINTER_PRESS, WIN_POINTER_RELEASE, wtk_handle_frame_move(), wtk_handle_frame_press(), wtk_handle_frame_release(), wtk_handle_resize_move(), wtk_handle_resize_press(), wtk_handle_resize_release(), win_point::x, and win_point::y.

Referenced by wtk_frame_create().