lib/ewl_widget.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Ewl_Attach_List
	A list of things attached to a widget. More...
struct	Ewl_Callback_Chain
	The callback chain contains the length, mask and information on the list. More...
struct	Ewl_Color_Set
	Contains an RGBA set of colours. More...
struct	Ewl_Pair
	Contains a key and a value pair. More...
struct	Ewl_Pair_List
	Contains a list of key value pairs. More...
struct	Ewl_Widget
	Inherits from Ewl_Object and extends to provide appearance, parent, and callback capabilities. More...
Defines
#define	CONFIGURED(o)
#define	DESTROYED(o)
#define	DISABLED(o)   (ewl_widget_state_has(EWL_WIDGET(o), EWL_FLAG_STATE_DISABLED))
#define	EWL_PAIR(p)   ((Ewl_Pair *)p)
#define	EWL_WIDGET(widget)   ((Ewl_Widget *) widget)
	Typecast a pointer to an Ewl_Widget pointer.
#define	ewl_widget_flags_get(o, mask)   (EWL_WIDGET(o)->flags & mask)
	Retrieves the current setting of the widget flags for o.
#define	ewl_widget_flags_has(o, check_flags, mask)   (!!(EWL_WIDGET(o)->flags & ((check_flags) & mask)))
	Determines if widget has the requested flags set.
#define	ewl_widget_flags_has_all(o, check_flags, mask)   ((EWL_WIDGET(o)->flags & ((check_flags) & mask)) == ((check_flags) & mask))
	Determines if widget has all of the requested flags set.
#define	ewl_widget_in_tab_list_get(o)   (ewl_widget_flags_get(o, EWL_FLAG_PROPERTY_IN_TAB_LIST))
	Retrieves the current setting of the in tab list flag for o.
#define	ewl_widget_in_tab_list_set(o, val)
	Changes the tab list flag value to match val.
#define	EWL_WIDGET_IS(w)   (ewl_widget_type_is(EWL_WIDGET(w), EWL_WIDGET_TYPE))
#define	ewl_widget_queued_add(o, queued)   ewl_widget_flags_add(o, queued, EWL_FLAGS_QUEUED_MASK)
#define	ewl_widget_queued_get(o, queued)   ewl_widget_flags_get(o, queued, EWL_FLAGS_QUEUED_MASK)
#define	ewl_widget_queued_has(o, queued)   ewl_widget_flags_has(o, queued, EWL_FLAGS_QUEUED_MASK)
#define	ewl_widget_queued_remove(o, queued)   ewl_widget_flags_remove(o, queued, EWL_FLAGS_QUEUED_MASK)
#define	ewl_widget_recursive_get(o)   (ewl_widget_flags_get(o, EWL_FLAG_PROPERTY_RECURSIVE))
	Retrieves the current setting of the recursive flag for o.
#define	ewl_widget_recursive_set(o, val)
	Changes the recursive flag value to match val.
#define	ewl_widget_state_add(o, state)   ewl_widget_flags_add(o, state, EWL_FLAGS_STATE_MASK)
#define	ewl_widget_state_get(o, state)   ewl_widget_flags_get(o, state, EWL_FLAGS_STATE_MASK)
#define	ewl_widget_state_has(o, state)   ewl_widget_flags_has(o, state, EWL_FLAGS_STATE_MASK)
#define	ewl_widget_state_remove(o, state)   ewl_widget_flags_remove(o, state, EWL_FLAGS_STATE_MASK)
#define	ewl_widget_toplevel_get(o)   (ewl_widget_flags_get(o, EWL_FLAG_PROPERTY_TOPLEVEL))
	Retrieves the current setting of the top level flag for o.
#define	ewl_widget_toplevel_set(o, val)
	Changes the top level flag value to match val.
#define	EWL_WIDGET_TYPE   "widget"
#define	ewl_widget_visible_add(o, visible)   ewl_widget_flags_add(o, visible, EWL_FLAGS_VISIBLE_MASK)
#define	ewl_widget_visible_get(o, visible)   ewl_widget_flags_get(o, visible, EWL_FLAGS_VISIBLE_MASK)
#define	ewl_widget_visible_has(o, visible)   ewl_widget_flags_has(o, visible, EWL_FLAGS_VISIBLE_MASK)
#define	ewl_widget_visible_remove(o, visible)   ewl_widget_flags_remove(o, visible, EWL_FLAGS_VISIBLE_MASK)
#define	HIDDEN(o)   (!(EWL_WIDGET(o)->flags & EWL_FLAG_VISIBLE_SHOWN))
#define	REALIZED(o)   (EWL_WIDGET(o)->flags & EWL_FLAG_VISIBLE_REALIZED)
#define	RECURSIVE(o)   (EWL_WIDGET(o)->flags & EWL_FLAG_PROPERTY_RECURSIVE)
#define	REVEALED(o)   (EWL_WIDGET(o)->flags & EWL_FLAG_VISIBLE_REVEALED)
#define	TOPLAYERED(w)   (EWL_WIDGET(w)->flags & EWL_FLAG_PROPERTY_TOPLAYERED)
#define	UNMANAGED(w)   (EWL_WIDGET(w)->flags & EWL_FLAG_PROPERTY_UNMANAGED)
#define	VISIBLE(o)   (EWL_WIDGET(o)->flags & EWL_FLAG_VISIBLE_SHOWN)
Typedefs
typedef struct Ewl_Attach_List	Ewl_Attach_List
typedef struct Ewl_Callback_Chain	Ewl_Callback_Chain
typedef struct Ewl_Color_Set	Ewl_Color_Set
typedef struct Ewl_Pair	Ewl_Pair
typedef struct Ewl_Pair_List	Ewl_Pair_List
typedef struct Ewl_Widget	Ewl_Widget
typedef void *(*	Ewl_Widget_Drag )(void)
Functions
const char *	ewl_widget_appearance_get (Ewl_Widget *w)
	Retrieve the appearance key of the widget.
const char *	ewl_widget_appearance_part_text_get (Ewl_Widget *w, const char *part)
	Retrieve a copy of a parts current text.
void	ewl_widget_appearance_part_text_set (Ewl_Widget *w, const char *part, const char *text)
	Change the text of the given theme part of a widget.
int	ewl_widget_appearance_path_copy (Ewl_Widget *w, char *buf, int size)
char *	ewl_widget_appearance_path_get (Ewl_Widget *w)
	Retrieve the appearance path key of the widget.
int	ewl_widget_appearance_path_size_get (Ewl_Widget *w)
void	ewl_widget_appearance_set (Ewl_Widget *w, const char *appearance)
	Change the appearance of the specified widget.
const char *	ewl_widget_appearance_text_get (Ewl_Widget *w)
	Retrieve the text of the given theme part of a widget.
void	ewl_widget_appearance_text_set (Ewl_Widget *w, const char *text)
	Change the text of the given theme part of a widget.
void	ewl_widget_cb_configure (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_disable (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_enable (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_focus_in (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_focus_out (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_hide (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_mouse_down (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_mouse_in (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_mouse_move (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_mouse_out (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_mouse_up (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_obscure (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_realize (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_reparent (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_reveal (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_show (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_cb_unrealize (Ewl_Widget *w, void *ev_data, void *user_data)
void	ewl_widget_color_get (Ewl_Widget *w, unsigned int *r, unsigned int *g, unsigned int *b, unsigned int *a)
	Gets the colour settings of the widget.
void	ewl_widget_color_set (Ewl_Widget *w, unsigned int r, unsigned int g, unsigned int b, unsigned int a)
	sets the colour of the widget
void	ewl_widget_configure (Ewl_Widget *widget)
	Initiate configuring of the specified widget.
void *	ewl_widget_data_del (Ewl_Widget *w, void *k)
	Remove the specified key / value pair from the widget and return the value.
void *	ewl_widget_data_get (Ewl_Widget *w, void *k)
	retrieve the specified key / value pair from the widget
void	ewl_widget_data_set (Ewl_Widget *w, void *k, void *v)
	Attach the specified key / value pair to the widget.
void	ewl_widget_destroy (Ewl_Widget *widget)
	Destroy the specified widget.
void	ewl_widget_disable (Ewl_Widget *w)
	Prevent a widget from receiving any events.
void	ewl_widget_enable (Ewl_Widget *w)
	Re-enable a disabled widget.
void	ewl_widget_flags_add (Ewl_Widget *o, unsigned int flags, unsigned int mask)
	Add the set of flags specified in flags to w.
void	ewl_widget_flags_remove (Ewl_Widget *o, unsigned int flags, unsigned int mask)
	Removes the set of state flags specified in flags from w.
void	ewl_widget_focus_send (Ewl_Widget *w)
	Changes the keyboard focus to the widget w.
unsigned int	ewl_widget_focusable_get (Ewl_Widget *w)
	Checks the focusable state of the widget.
void	ewl_widget_focusable_set (Ewl_Widget *w, unsigned int val)
	Set if the given widget is focusable or not.
Ewl_Widget *	ewl_widget_focused_get (void)
	Retrieve the currently focused widget.
void	ewl_widget_free (Ewl_Widget *w)
void	ewl_widget_hide (Ewl_Widget *widget)
	Mark a widget as invisible.
unsigned int	ewl_widget_ignore_focus_change_get (Ewl_Widget *w)
	Get if the widget is ignoring focus changes.
void	ewl_widget_ignore_focus_change_set (Ewl_Widget *w, unsigned int val)
	Set if the widget should ignore focus changes.
void	ewl_widget_inherit (Ewl_Widget *widget, const char *type)
	Appends the given inheritance to this widgets inheritance string.
int	ewl_widget_init (Ewl_Widget *w)
	Initialize a widget to default values and callbacks.
unsigned int	ewl_widget_internal_is (Ewl_Widget *w)
void	ewl_widget_internal_set (Ewl_Widget *w, unsigned int val)
int	ewl_widget_layer_priority_get (Ewl_Widget *w)
	Retrieve a widgets layer relative to it's parent.
void	ewl_widget_layer_priority_set (Ewl_Widget *w, int layer)
	Set the relative layer to it's parent.
int	ewl_widget_layer_top_get (Ewl_Widget *w)
	Returns if the widget will be drawn above all the others.
void	ewl_widget_layer_top_set (Ewl_Widget *w, int top)
	set the widget to be layered above all other widgets
Ewl_Widget *	ewl_widget_name_find (const char *name)
	Find a widget identified by a name.
const char *	ewl_widget_name_get (Ewl_Widget *w)
	Get the name for the specified widget.
void	ewl_widget_name_set (Ewl_Widget *w, const char *name)
	Name the specified widget.
Ewl_Widget *	ewl_widget_new (void)
	Allocate a new widget.
void	ewl_widget_obscure (Ewl_Widget *w)
	Indicate a widget is obscured.
unsigned int	ewl_widget_onscreen_is (Ewl_Widget *widget)
	Checks if the given widget is currently on screen.
Ewl_Widget *	ewl_widget_parent_get (Ewl_Widget *w)
	Retrieves the parent of the given widget.
int	ewl_widget_parent_of (Ewl_Widget *c, Ewl_Widget *w)
	Determine if a widget is a parent of another widget.
void	ewl_widget_parent_set (Ewl_Widget *w, Ewl_Widget *p)
	change the parent of the specified widget
void	ewl_widget_print (Ewl_Widget *w)
	Prints info for debugging a widget's state information.
void	ewl_widget_print_verbose (Ewl_Widget *w)
	Prints verbose info for debugging a widget's state information.
void	ewl_widget_realize (Ewl_Widget *widget)
	Realize the specified widget.
void	ewl_widget_reparent (Ewl_Widget *widget)
	initiate reparent of the specified widget
void	ewl_widget_reveal (Ewl_Widget *w)
	Indicate a widget is revealed.
void	ewl_widget_show (Ewl_Widget *widget)
	mark a widget as visible
void	ewl_widget_state_set (Ewl_Widget *w, const char *state, Ewl_State_Type flag)
	Update the appearance of the widget to a state.
void	ewl_widget_tab_order_append (Ewl_Widget *w)
	Changes the order in the embed so w receives focus first on tab.
void	ewl_widget_tab_order_insert (Ewl_Widget *w, unsigned int idx)
	Changes the order in the embed so w receives focus first on tab.
void	ewl_widget_tab_order_insert_after (Ewl_Widget *w, Ewl_Widget *after)
	Insert the given widget into the tab order after the after widget.
void	ewl_widget_tab_order_insert_before (Ewl_Widget *w, Ewl_Widget *before)
	Inserts the widget into the tab order before the before widget.
void	ewl_widget_tab_order_prepend (Ewl_Widget *w)
	Changes the order in the embed so w receives focus first on tab.
void	ewl_widget_tab_order_remove (Ewl_Widget *w)
	Remove the widget from the tab order.
void	ewl_widget_theme_path_set (Ewl_Widget *w, const char *path)
	Change the path of the specified widget.
void	ewl_widget_tree_print (Ewl_Widget *w)
	Prints to stdout the tree of widgets that are parents of a widget.
unsigned int	ewl_widget_type_is (Ewl_Widget *widget, const char *type)
	Determine if the widget w has inherited from the type t.
unsigned int	ewl_widget_unmanaged_is (Ewl_Widget *w)
void	ewl_widget_unmanaged_set (Ewl_Widget *w, unsigned int val)
void	ewl_widget_unrealize (Ewl_Widget *w)
	Unrealize the specified widget.