Ewl_Window: A Container for Displaying in a New Window

Detailed Description

Defines the Ewl_Window class which extends the Ewl_Embed class by creating it's own window and evas.

Remarks:: Inherits from Ewl_Embed.

Tutorial


Data Structures
struct	Ewl_Window
	Inherits from Ewl_Embed class to create it's own window and canvas for drawing, sizing and positioning. More...
Defines
#define	EWL_WINDOW(win) ((Ewl_Window *) win)
#define	EWL_WINDOW_IS(w) (ewl_widget_type_is(EWL_WIDGET(w), EWL_WINDOW_TYPE))
#define	EWL_WINDOW_TYPE "window"
Typedefs
typedef Ewl_Window	Ewl_Window
Functions
void	ewl_window_attention_demand (Ewl_Window *win)
	Request the WM to pay attention to the window.
unsigned int	ewl_window_borderless_get (Ewl_Window *win)
	Retrieves the borderless flag for the window.
void	ewl_window_borderless_set (Ewl_Window *win, unsigned int border)
	Changes the border from the specified window.
void	ewl_window_cb_configure (Ewl_Widget w, void ev_data, void *user_data)
void	ewl_window_cb_destroy (Ewl_Widget w, void ev_data, void *user_data)
void	ewl_window_cb_expose (Ewl_Widget w, void ev, void *user_data)
void	ewl_window_cb_hide (Ewl_Widget w, void ev_data, void *user_data)
void	ewl_window_cb_postrealize (Ewl_Widget w, void ev_data, void *user_data)
void	ewl_window_cb_realize (Ewl_Widget w, void ev_data, void *user_data)
void	ewl_window_cb_realize_parent (Ewl_Widget w, void ev_data, void *user_data)
void	ewl_window_cb_show (Ewl_Widget w, void ev_data, void *user_data)
void	ewl_window_cb_unrealize (Ewl_Widget w, void ev_data, void *user_data)
const char *	ewl_window_class_get (Ewl_Window *win)
	Retrieve the class of the specified window.
void	ewl_window_class_set (Ewl_Window win, const char classname)
	Set the class of the specified window.
int	ewl_window_dialog_get (Ewl_Window *win)
	Retrieves the current dialog state on a window.
void	ewl_window_dialog_set (Ewl_Window *win, int dialog)
	Changes the dialog state on the specified window.
unsigned int	ewl_window_fullscreen_get (Ewl_Window *win)
	Retrieve the fullscreen setting for the window.
void	ewl_window_fullscreen_set (Ewl_Window *win, unsigned int fullscreen)
	Sets the fullscreen setting for the window.
int	ewl_window_init (Ewl_Window *win)
	Initialize a window to default values and callbacks.
int	ewl_window_keyboard_grab_get (Ewl_Window *win)
	Retrieves the current keyboard grab state on a window.
void	ewl_window_keyboard_grab_set (Ewl_Window *win, int grab)
	Changes the keyboard grab state on the specified window.
Ewl_Embed_Window *	ewl_window_leader_foreign_get (Ewl_Window *win)
	Gets the leader of this window.
void	ewl_window_leader_foreign_set (Ewl_Window win, Ewl_Embed_Window leader)
	Sets the window to be client window of the leader.
Ewl_Window *	ewl_window_leader_get (Ewl_Window *win)
	Gets the leader of this window.
void	ewl_window_leader_set (Ewl_Window win, Ewl_Window leader)
	Sets the window to be client window of the leader.
void	ewl_window_lower (Ewl_Window *win)
	Lower a window.
int	ewl_window_modal_get (Ewl_Window *win)
	Gets the boolean flag indicating if win is modal.
void	ewl_window_modal_set (Ewl_Window *win, int modal)
	Sets the window to modal or non-modal based on modal.
void	ewl_window_move (Ewl_Window *win, int x, int y)
	Move the specified window to the given position.
const char *	ewl_window_name_get (Ewl_Window *win)
	Retrieve the name of the specified window.
void	ewl_window_name_set (Ewl_Window win, const char name)
	Set the name of the specified window.
Ewl_Widget *	ewl_window_new (void)
	Allocate and initialize a new window.
int	ewl_window_override_get (Ewl_Window *win)
	Retrieves the current override state on a window.
void	ewl_window_override_set (Ewl_Window *win, int override)
	Changes the override state on the specified window.
int	ewl_window_pointer_grab_get (Ewl_Window *win)
	Retrieves the current pointer grab state on a window.
void	ewl_window_pointer_grab_set (Ewl_Window *win, int grab)
	Changes the pointer grab state on the specified window.
void	ewl_window_raise (Ewl_Window *win)
	Raise a window.
unsigned int	ewl_window_skip_pager_get (Ewl_Window *win)
	Retrieve the skip pager setting for the window.
void	ewl_window_skip_pager_set (Ewl_Window *win, unsigned int skip)
	Sets the skip pager setting for the window.
unsigned int	ewl_window_skip_taskbar_get (Ewl_Window *win)
	Retrieve the skip taskbar setting for the window.
void	ewl_window_skip_taskbar_set (Ewl_Window *win, unsigned int skip)
	Sets the skip taskbar setting for the window.
const char *	ewl_window_title_get (Ewl_Window *win)
	Retrieve the title of the specified window.
void	ewl_window_title_set (Ewl_Window win, const char title)
	Set the title of the specified window.
void	ewl_window_transient_for (Ewl_Window win, Ewl_Window forwin)
	Sets a window to be transient for another window.
void	ewl_window_transient_for_foreign (Ewl_Window win, Ewl_Embed_Window forwin)
	Sets a window to be transient for another window.
unsigned int	ewl_window_urgent_get (Ewl_Window *win)
	Get the window urgent state.
void	ewl_window_urgent_set (Ewl_Window *win, unsigned int urgent)
	Set the window to be urgent.
Ewl_Window *	ewl_window_window_find (void *window)
	Find an ewl window by it's X window.
Variables
unsigned int	EWL_CALLBACK_DELETE_WINDOW
unsigned int	EWL_CALLBACK_EXPOSE

Define Documentation

#define EWL_WINDOW ( win ) ((Ewl_Window *) win)

Typecasts a pointer to an Ewl_Window pointer.

#define EWL_WINDOW_IS ( w ) (ewl_widget_type_is(EWL_WIDGET(w), EWL_WINDOW_TYPE))

Returns TRUE if the widget is an Ewl_Window, FALSE otherwise

#define EWL_WINDOW_TYPE "window"

The type name for the Ewl_Window widget

Typedef Documentation

typedef struct Ewl_Window Ewl_Window

The window structure is mostly a container for holding widgets and a wrapper around the xlib window.

Function Documentation

void ewl_window_attention_demand ( Ewl_Window * win )

Request the WM to pay attention to the window.

Parameters:

win,:

the window to work with.

Returns:: Returns no value.

Demand attention for the window win if it is realized. The window manager will then try to draw attention to the window, e.g. a blinking taskbar entry. When the window got the wanted attention the window manager will stop this action itself.

unsigned int ewl_window_borderless_get ( Ewl_Window * win )

Retrieves the borderless flag for the window.

Parameters:

win,:

The window to get the border settings from

Returns:: Returns TRUE if the window is borderless, FALSE otherwise

void ewl_window_borderless_set	(	Ewl_Window *	win,
		unsigned int	border
	)

Changes the border from the specified window.

Parameters:

	win,:	the window to change the border flag on
	border,:	the borderless flag to set, either TRUe or FALSE

Returns:: Returns no value.

Changes the border from the specified window

void ewl_window_cb_configure	(	Ewl_Widget *	w,
		void *	ev_data,
		void *	user_data
	)

void ewl_window_cb_destroy	(	Ewl_Widget *	w,
		void *	ev_data,
		void *	user_data
	)

void ewl_window_cb_expose	(	Ewl_Widget *	w,
		void *	ev,
		void *	user_data
	)

void ewl_window_cb_hide	(	Ewl_Widget *	w,
		void *	ev_data,
		void *	user_data
	)

void ewl_window_cb_postrealize	(	Ewl_Widget *	w,
		void *	ev_data,
		void *	user_data
	)

void ewl_window_cb_realize	(	Ewl_Widget *	w,
		void *	ev_data,
		void *	user_data
	)

void ewl_window_cb_realize_parent	(	Ewl_Widget *	w,
		void *	ev_data,
		void *	user_data
	)

void ewl_window_cb_show	(	Ewl_Widget *	w,
		void *	ev_data,
		void *	user_data
	)

void ewl_window_cb_unrealize	(	Ewl_Widget *	w,
		void *	ev_data,
		void *	user_data
	)

const char* ewl_window_class_get ( Ewl_Window * win )

Retrieve the class of the specified window.

Parameters:

win,:

the window to retrieve the window

Returns:: Returns a pointer to a new copy of the class, NULL on failure.

The returned class should not be freed, and should be copied immediately if needed for extended use.

void ewl_window_class_set	(	Ewl_Window *	win,
		const char *	classname
	)

Set the class of the specified window.

Parameters:

	win,:	the window to change the class
	classname,:	the class to set for the window

Returns:: Returns no value.

Sets the class of window w to class and calls the necessary X lib functions to update the window.

int ewl_window_dialog_get ( Ewl_Window * win )

Retrieves the current dialog state on a window.

Parameters:

win,:

window to retrieve dialog state

Returns:: Returns TRUE if window is an dialog window, FALSE otherwise.

void ewl_window_dialog_set	(	Ewl_Window *	win,
		int	dialog
	)

Changes the dialog state on the specified window.

Parameters:

	win,:	the window
	dialog,:	TRUE or FALSE to indicate dialog state.

Returns:: Returns no value.

A dialog window has not a iconify and/or maximize button.

unsigned int ewl_window_fullscreen_get ( Ewl_Window * win )

Retrieve the fullscreen setting for the window.

Parameters:

win,:

The window to work with

Returns:: Returns TRUE if the window is fullscreen, FALSE otherwise

void ewl_window_fullscreen_set	(	Ewl_Window *	win,
		unsigned int	fullscreen
	)

Sets the fullscreen setting for the window.

Parameters:

	win,:	The window to work with
	fullscreen,:	The fullscreen setting to use

Returns:: Returns no value

int ewl_window_init ( Ewl_Window * w )

Initialize a window to default values and callbacks.

Parameters:

w,:

the window to be initialized to default values and callbacks

Returns:: Returns TRUE or FALSE depending on if initialization succeeds.

Sets the values and callbacks of a window w to their defaults.

int ewl_window_keyboard_grab_get ( Ewl_Window * win )

Retrieves the current keyboard grab state on a window.

Parameters:

win,:

window to retrieve keyboard grab state

Returns:: Returns TRUE if window is grabbing keyboard, FALSE otherwise.

void ewl_window_keyboard_grab_set	(	Ewl_Window *	win,
		int	grab
	)

Changes the keyboard grab state on the specified window.

Parameters:

	win,:	the window to change keyboard grab settings.
	grab,:	TRUE or FALSE to indicate grab state.

Returns:: Returns no value.

Ewl_Embed_Window* ewl_window_leader_foreign_get ( Ewl_Window * win )

Gets the leader of this window.

Parameters:

win,:

window to get leader for

Returns:: Returns the leader of this window or NULL

Note:: this function returns even NULL if the leader is a ewl window

void ewl_window_leader_foreign_set	(	Ewl_Window *	win,
		Ewl_Embed_Window *	leader
	)

Sets the window to be client window of the leader.

Parameters:

	win,:	window to set leader for
	leader,:	the window that is the leader of the window group

Returns:: Returns no value.

Ewl_Window* ewl_window_leader_get ( Ewl_Window * win )

Gets the leader of this window.

Parameters:

win,:

window to get leader for

Returns:: leader of the window or NULL

Note:: this function returns even NULL if the leader is a foreign window

void ewl_window_leader_set	(	Ewl_Window *	win,
		Ewl_Window *	leader
	)

Sets the window to be client window of the leader.

Parameters:

	win,:	window to set leader for
	leader,:	the window that is the leader of the window group

Returns:: Returns no value.

void ewl_window_lower ( Ewl_Window * win )

Lower a window.

Parameters:

win,:

the window to lower.

Returns:: Returns no value.

Lower the window win if it is realized.

int ewl_window_modal_get ( Ewl_Window * win )

Gets the boolean flag indicating if win is modal.

Parameters:

win,:

The window to work with

Returns:: Returns a boolean indicating if the window is modal.

void ewl_window_modal_set	(	Ewl_Window *	win,
		int	modal
	)

Sets the window to modal or non-modal based on modal.

Parameters:

	win,:	The window to work with
	modal,:	Boolean to indicate if this window is modal

Returns:: Returns no value

void ewl_window_move	(	Ewl_Window *	win,
		int	x,
		int	y
	)

Move the specified window to the given position.

Parameters:

	win,:	the window to move
	x,:	the x coordinate of the new position
	y,:	the y coordinate of the new position

Returns:: Returns no value.

Moves the window into the specified position in the window manager environment.

const char* ewl_window_name_get ( Ewl_Window * win )

Retrieve the name of the specified window.

Parameters:

win,:

the window to retrieve the window

Returns:: Returns a pointer to a new copy of the name, NULL on failure.

The returned name should not be freed, and should be copied immediately if needed for extended use.

void ewl_window_name_set	(	Ewl_Window *	win,
		const char *	name
	)

Set the name of the specified window.

Parameters:

	win,:	the window to change the name
	name,:	the name to set for the window

Returns:: Returns no value.

Sets the name of window w to name and calls the necessary X lib functions to update the window.

Ewl_Widget* ewl_window_new ( void )

Allocate and initialize a new window.

Returns:: Returns a new window on success, or NULL on failure.

int ewl_window_override_get ( Ewl_Window * win )

Retrieves the current override state on a window.

Parameters:

win,:

window to retrieve override state

Returns:: Returns TRUE if window is an override window, FALSE otherwise.

void ewl_window_override_set	(	Ewl_Window *	win,
		int	override
	)

Changes the override state on the specified window.

Parameters:

	win,:	the window to change override settings
	override,:	TRUE or FALSE to indicate override state.

Returns:: Returns no value.

int ewl_window_pointer_grab_get ( Ewl_Window * win )

Retrieves the current pointer grab state on a window.

Parameters:

win,:

window to retrieve pointer grab state

Returns:: Returns TRUE if window is grabbing pointer, FALSE otherwise.

void ewl_window_pointer_grab_set	(	Ewl_Window *	win,
		int	grab
	)

Changes the pointer grab state on the specified window.

Parameters:

	win,:	the window to change pointer grab settings.
	grab,:	TRUE or FALSE to indicate grab state.

Returns:: Returns no value.

void ewl_window_raise ( Ewl_Window * win )

Raise a window.

Parameters:

win,:

the window to raise.

Returns:: Returns no value.

Raise the window win if it is realized.

unsigned int ewl_window_skip_pager_get ( Ewl_Window * win )

Retrieve the skip pager setting for the window.

Parameters:

win,:

The window to work with

Returns:: Returns TRUE if the window is to be skipped for the pager, FALSE otherwise

void ewl_window_skip_pager_set	(	Ewl_Window *	win,
		unsigned int	skip
	)

Sets the skip pager setting for the window.

Parameters:

	win,:	The window to work with
	skip,:	If the `win` should be visible in the pager

Returns:: Returns no value

unsigned int ewl_window_skip_taskbar_get ( Ewl_Window * win )

Retrieve the skip taskbar setting for the window.

Parameters:

win,:

The window to work with

Returns:: Returns TRUE if the window is to be skipped for the taskbar, FALSE otherwise

void ewl_window_skip_taskbar_set	(	Ewl_Window *	win,
		unsigned int	skip
	)

Sets the skip taskbar setting for the window.

Parameters:

	win,:	The window to work with
	skip,:	If the `win` should not be in the taskbar

Returns:: Returns no value

const char* ewl_window_title_get ( Ewl_Window * win )

Retrieve the title of the specified window.

Parameters:

win,:

the window to retrieve the window

Returns:: Returns a pointer to a new copy of the title, NULL on failure.

The returned title should not be freed, and should be copied immediately if needed for extended use.

void ewl_window_title_set	(	Ewl_Window *	win,
		const char *	title
	)

Set the title of the specified window.

Parameters:

	win,:	the window to change the title
	title,:	the title to set for the window

Returns:: Returns no value.

Sets the title of window w to title and calls the necessary X lib functions to update the window.

void ewl_window_transient_for	(	Ewl_Window *	win,
		Ewl_Window *	forwin
	)

Sets a window to be transient for another window.

Parameters:

	win,:	window to set transient
	forwin,:	the window to be transient for

Returns:: Returns no value.

void ewl_window_transient_for_foreign	(	Ewl_Window *	win,
		Ewl_Embed_Window *	forwin
	)

Sets a window to be transient for another window.

Parameters:

	win,:	window to set transient
	forwin,:	the window to be transient for

Returns:: Returns no value.

unsigned int ewl_window_urgent_get ( Ewl_Window * win )

Get the window urgent state.

Parameters:

win,:

the window to work with.

Returns:: the urgent state

void ewl_window_urgent_set	(	Ewl_Window *	win,
		unsigned int	urgent
	)

Set the window to be urgent.

Parameters:

	win,:	the window to work with.
	urgent,:	if the window should have the urgent hint

Returns:: Returns no value.

This is similar to a attention demand with the difference, that it is more urgent and the window manager might even raise the window and/or let title bar blink. Different from attention demand the window manager will not reset it to normal state, so it is up to the application to do this, after it got the needed attention.

Ewl_Window* ewl_window_window_find ( void * window )

Find an ewl window by it's X window.

Parameters:

window,:

the X window to search for on the list of ewl window's

Returns:: Returns the found ewl window on success, NULL on failure.

Variable Documentation

unsigned int EWL_CALLBACK_DELETE_WINDOW

Triggered when the window gets a close request

unsigned int EWL_CALLBACK_EXPOSE

Triggered when the window needs redrawing

Ewl_Window: A Container for Displaying in a New Window

Detailed Description

Tutorial

Data Structures

Defines

Typedefs

Functions

Variables

Define Documentation

Typedef Documentation

Function Documentation

Variable Documentation