Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Related Pages

Window: A Container for Displaying in a New Window

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

Data Structures

struct  Ewl_Window
 Extends the Ewl_Embed class to create it's own window and evas for drawing, sizing and positioning. More...

struct  Ewl_Window
 Extends the Ewl_Embed class to create it's own window and evas for drawing, sizing and positioning. More...


Defines

#define EWL_WINDOW(win)   ((Ewl_Window *) win)
 Typecasts a pointer to an Ewl_Window pointer.


Typedefs

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


Functions

Ewl_Widgetewl_window_new (void)
 Allocate and initialize a new window.

int ewl_window_init (Ewl_Window *win)
 Initialize a window to default values and callbacks.

Ewl_Windowewl_window_window_find (void *window)
 Find an ewl window by it's X window.

void ewl_window_title_set (Ewl_Window *win, char *title)
 Set the title of the specified window.

char * ewl_window_title_get (Ewl_Window *win)
 Retrieve the title of the specified window.

void ewl_window_name_set (Ewl_Window *win, char *name)
 Set the name of the specified window.

char * ewl_window_name_get (Ewl_Window *win)
 Retrieve the name of the specified window.

void ewl_window_class_set (Ewl_Window *win, char *classname)
 Set the class of the specified window.

char * ewl_window_class_get (Ewl_Window *win)
 Retrieve the class of the specified window.

void ewl_window_borderless_set (Ewl_Window *win)
 Remove the border from the specified window.

void ewl_window_move (Ewl_Window *win, int x, int y)
 Move the specified window to the given position.

void ewl_window_position_get (Ewl_Window *win, int *x, int *y)
 Retrieve the position of the window.

void ewl_window_raise (Ewl_Window *win)
 Raise a window.

void ewl_window_lower (Ewl_Window *win)
 Lower a window.


Detailed Description

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


Function Documentation

void ewl_window_borderless_set Ewl_Window win  ) 
 

Remove the border from the specified window.

Parameters:
win: the window to remove the border
Returns:
Returns no value.
Remove the border from the specified widget and call the necessary X lib functions to update the appearance.

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 be freed.

void ewl_window_class_set Ewl_Window win,
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_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.

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.

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.

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 be freed.

void ewl_window_name_set Ewl_Window win,
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.

void ewl_window_position_get Ewl_Window win,
int *  x,
int *  y
 

Retrieve the position of the window.

Parameters:
win: the window to query for position
x: a pointer to the integer that should receive the x coordinate
y: a pointer to the integer that should receive the y coordinate
Returns:
Returns no value.
Stores the window position into the parameters x and y.

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.

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 be freed.

void ewl_window_title_set Ewl_Window win,
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.

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.