xputty.h File Reference

This file contains definitions and structs used on all platforms. Platform specific definitions are located in xwidget-platform.h Xlib compatibility definitions for MSWindows are located in xputty-mswin.h. More...

Go to the source code of this file.

Data Structures
struct	Xputty
	Xputty - the main struct. It should be declared before any other call to a Xputty function. Xputty store a pointer in the childlist, to any Widget_t related to this instance of libxputty. The first created Widget_t is the toplevel window. When the toplevel window call destroy_widget(), Xputty call destroy_widget() for all remaining Widget_t's in the main childlist. So any allocated memory should be released before the toplevel window finaly close. More...

Typedefs
typedef struct Childlist_t	Childlist_t
	Childlist_t - maintain a Widget_t list of childs for a Widget_t.
typedef struct Adjustment_t	Adjustment_t
	Adjustment_t - Adjustment_t for a Widget_t.
typedef struct Widget_t	Widget_t
	Widget_t - the Widget_t base struct.
typedef struct XColor_t	XColor_t
	XColor_t - the Widget_t Color struct.
typedef struct SystrayColor_t	SystrayColor_t
	SystrayColor_t - the Systray Icon background Color.
typedef struct Xputty	Xputty
	Xputty - the main struct.It should be declared before any other call to a Xputty function.
typedef void(*	xfunc) (void *widget, void *user_data)
	*xfunc - function pointer to connect XEvents from a Widget_t to a event handler

Functions
void	main_init (Xputty *main)
	main_init - open the Display and init the main->childlist. Set the bool run to true. The bool run is used to terminate the main event loop. main_init() should be called directly after the declaration of Xputty before the first Widget_t get created. Any Widget_t created afterwards will be added to the main childlist. The main childlist is used to check if a Widget_t is valid to receive a Event. Xputty check if a Widget_t is registerd in the main childlist, and only forward events when it found the Widget_t in the list. When a Widget_t call destroy_widget() any childs of this Widget_t receive a call to destroy_widget() to release there memory, they get removed from the main childlist and finaly the Widget_t itself will be removed from the main childlist as well. On main_quit() any remaining Widget_t from the main childlist will be destroyed, to ensure that we leave the memory clean.
void	main_run (Xputty *main)
	main_run - start the main event loop. It should be start after your Widget_t's been created. You could create and destroy additional Widget_t's at any time later during run.
void	run_embedded (Xputty *main)
	run_embedded - the main event loop to run embedded UI's. It should be start after your Widget_t's been created. You could create and destroy additional Widget_t's at any time later during run.
void	main_quit (Xputty *main)
	main_quit - destroy all remaining Widget_t's from the main->childlist. Free all resources which may be allocated between init and quit. It should be called after main_run()/run_embedded();

Detailed Description

This file contains definitions and structs used on all platforms. Platform specific definitions are located in xwidget-platform.h Xlib compatibility definitions for MSWindows are located in xputty-mswin.h.

Definition in file xputty.h.

Typedef Documentation

Adjustment_t

typedef struct Adjustment_t Adjustment_t

Adjustment_t - Adjustment_t for a Widget_t.

Definition at line 153 of file xputty.h.

Childlist_t

typedef struct Childlist_t Childlist_t

Childlist_t - maintain a Widget_t list of childs for a Widget_t.

Definition at line 147 of file xputty.h.

SystrayColor_t

typedef struct SystrayColor_t SystrayColor_t

SystrayColor_t - the Systray Icon background Color.

Definition at line 171 of file xputty.h.

Widget_t

typedef struct Widget_t Widget_t

Widget_t - the Widget_t base struct.

Definition at line 159 of file xputty.h.

XColor_t

typedef struct XColor_t XColor_t

XColor_t - the Widget_t Color struct.

Definition at line 165 of file xputty.h.

xfunc

typedef void(* xfunc) (void *widget, void *user_data)

*xfunc - function pointer to connect XEvents from a Widget_t to a event handler

Parameters

*widget	- void pointer to the widget
*user_data	- void pointer to attached user_data, maybe NULL

Definition at line 186 of file xputty.h.

Xputty

typedef struct Xputty Xputty

Xputty - the main struct.It should be declared before any other call to a Xputty function.

Definition at line 178 of file xputty.h.

Function Documentation

main_init()

void main_init

(

Xputty *

main

)

main_init - open the Display and init the main->childlist.
Set the bool run to true.
The bool run is used to terminate the main event loop.
main_init() should be called directly after the declaration of Xputty before the first Widget_t get created.
Any Widget_t created afterwards will be added to the main childlist.
The main childlist is used to check if a Widget_t is valid to receive a Event.
Xputty check if a Widget_t is registerd in the main childlist, and only forward events when it found the Widget_t in the list.
When a Widget_t call destroy_widget() any childs of this Widget_t receive a call to destroy_widget() to release there memory, they get removed from the main childlist and finaly the Widget_t itself will be removed from the main childlist as well. On main_quit() any remaining Widget_t from the main childlist will be destroyed, to ensure that we leave the memory clean.

Parameters

*main

- pointer to the main Xputty struct

Examples

simple-example.c.

Definition at line 24 of file xputty.c.

                             {
    main->dpy = os_open_display(0);
    assert(main->dpy);
    main->childlist = (Childlist_t*)malloc(sizeof(Childlist_t));
    assert(main->childlist);
    childlist_init(main->childlist);
    main->color_scheme = (XColor_t*)malloc(sizeof(XColor_t));
    assert(main->color_scheme);
    set_dark_theme(main);
    main->systray_color = (SystrayColor_t*)malloc(sizeof(SystrayColor_t));
    assert(main->systray_color);
    set_systray_color(main, 0.3, 0.3, 0.3, 1.0);
    main->hold_grab = NULL;
    main->key_snooper = NULL;
    main->submenu = NULL;
    main->run = true;
    main->is_grab = false;
    main->small_font = 10;
    main->normal_font = 12;
    main->big_font = 16;
    main->ctext = NULL;
    main->csize = 0;
    os_init_dnd(main);
}

References Xputty::big_font, Xputty::childlist, childlist_init(), Xputty::color_scheme, Xputty::csize, Xputty::ctext, Xputty::dpy, Xputty::hold_grab, Xputty::is_grab, Xputty::key_snooper, Xputty::normal_font, os_init_dnd(), os_open_display(), Xputty::run, set_dark_theme(), set_systray_color(), Xputty::small_font, Xputty::submenu, and Xputty::systray_color.

main_quit()

void main_quit

(

Xputty *

main

)

main_quit - destroy all remaining Widget_t's from the main->childlist.
Free all resources which may be allocated between init and quit.
It should be called after main_run()/run_embedded();

Parameters

*main

- pointer to the main Xputty struct

Examples

simple-example.c.

Definition at line 57 of file xputty.c.

                             {
    int i = main->childlist->elem-1;
    for(;i>-1;i--) {
        Widget_t *w = main->childlist->childs[i];
        destroy_widget(w, main);
    }
    childlist_destroy(main->childlist);
    free(main->childlist);
    free(main->color_scheme);
    free(main->systray_color);
    os_close_display(main->dpy);
    free(main->ctext);
    debug_print("quit\n");
}

References Xputty::childlist, childlist_destroy(), Childlist_t::childs, Xputty::color_scheme, Xputty::ctext, destroy_widget(), Xputty::dpy, Childlist_t::elem, os_close_display(), and Xputty::systray_color.

main_run()

void main_run

(

Xputty *

main

)

main_run - start the main event loop.
It should be start after your Widget_t's been created.
You could create and destroy additional Widget_t's at any time later during run.

Parameters

*main

- pointer to the main Xputty struct

Examples

simple-example.c.

Definition at line 49 of file xputty.c.

                            {
    os_main_run(main);
}

References os_main_run().

run_embedded()

void run_embedded

(

Xputty *

main

)

run_embedded - the main event loop to run embedded UI's.
It should be start after your Widget_t's been created.
You could create and destroy additional Widget_t's at any time later during run.

Parameters

*main

- pointer to the main Xputty struct

Definition at line 53 of file xputty.c.

                                {
    os_run_embedded(main);
}

References os_run_embedded().