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 struct 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.
Referenced by ewl_colordialog_init(), ewl_combo_cb_decrement_clicked(), ewl_combo_init(), ewl_cursor_init(), ewl_datepicker_init(), ewl_dialog_init(), ewl_filedialog_init(), ewl_menu_cb_expand(), ewl_popup_cb_show(), ewl_popup_init(), ewl_window_cb_configure(), ewl_window_cb_destroy(), ewl_window_cb_expose(), ewl_window_cb_hide(), ewl_window_cb_postrealize(), ewl_window_cb_realize(), ewl_window_cb_realize_parent(), ewl_window_cb_show(), and ewl_window_cb_unrealize().
#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
Referenced by ewl_popup_cb_show().
#define EWL_WINDOW_TYPE "window" |
- Widget Theme Keys:
- /window/file
- Widget Theme Keys:
- /window/group
Referenced by ewl_engine_canvas_setup(), ewl_engine_keyboard_grab(), ewl_engine_keyboard_ungrab(), ewl_engine_pointer_grab(), ewl_engine_pointer_ungrab(), ewl_engine_window_borderless_set(), ewl_engine_window_destroy(), ewl_engine_window_dialog_set(), ewl_engine_window_geometry_get(), ewl_engine_window_hide(), ewl_engine_window_hints_set(), ewl_engine_window_leader_set(), ewl_engine_window_lower(), ewl_engine_window_min_max_size_set(), ewl_engine_window_move(), ewl_engine_window_name_class_set(), ewl_engine_window_new(), ewl_engine_window_raise(), ewl_engine_window_resize(), ewl_engine_window_show(), ewl_engine_window_states_set(), ewl_engine_window_title_set(), ewl_engine_window_transient_for(), ewl_window_attention_demand(), ewl_window_borderless_get(), ewl_window_borderless_set(), ewl_window_cb_configure(), ewl_window_cb_destroy(), ewl_window_cb_expose(), ewl_window_cb_hide(), ewl_window_cb_postrealize(), ewl_window_cb_realize(), ewl_window_cb_realize_parent(), ewl_window_cb_show(), ewl_window_cb_unrealize(), ewl_window_class_get(), ewl_window_class_set(), ewl_window_dialog_get(), ewl_window_dialog_set(), ewl_window_fullscreen_get(), ewl_window_fullscreen_set(), ewl_window_init(), ewl_window_keyboard_grab_get(), ewl_window_keyboard_grab_set(), ewl_window_leader_foreign_get(), ewl_window_leader_foreign_set(), ewl_window_leader_get(), ewl_window_leader_set(), ewl_window_lower(), ewl_window_modal_get(), ewl_window_modal_set(), ewl_window_move(), ewl_window_name_get(), ewl_window_name_set(), ewl_window_override_get(), ewl_window_override_set(), ewl_window_pointer_grab_get(), ewl_window_pointer_grab_set(), ewl_window_raise(), ewl_window_skip_pager_get(), ewl_window_skip_pager_set(), ewl_window_skip_taskbar_get(), ewl_window_skip_taskbar_set(), ewl_window_title_get(), ewl_window_title_set(), ewl_window_transient_for(), ewl_window_transient_for_foreign(), ewl_window_urgent_get(), and ewl_window_urgent_set().
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_window_states_set(), EWL_WINDOW_DEMANDS_ATTENTION, EWL_WINDOW_TYPE, and flags.
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
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_WINDOW_BORDERLESS, EWL_WINDOW_TYPE, and flags.
Referenced by ewl_window_borderless_set().
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
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, ewl_engine_window_borderless_set(), EWL_WIDGET, ewl_widget_realize(), ewl_widget_unrealize(), EWL_WINDOW_BORDERLESS, ewl_window_borderless_get(), EWL_WINDOW_TYPE, and flags.
void ewl_window_cb_configure | ( | Ewl_Widget * | w, | |
void * | ev_data, | |||
void * | user_data | |||
) |
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, EWL_EMBED, ewl_engine_canvas_output_set(), ewl_engine_window_min_max_size_set(), ewl_engine_window_resize(), EWL_OBJECT, ewl_object_current_h_get(), ewl_object_current_w_get(), ewl_object_current_x_get(), ewl_object_current_y_get(), EWL_WINDOW, EWL_WINDOW_TYPE, EWL_WINDOW_USER_CONFIGURE, flags, and window.
Referenced by ewl_window_init().
void ewl_window_cb_destroy | ( | Ewl_Widget * | w, | |
void * | ev_data, | |||
void * | user_data | |||
) |
References classname, DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_WINDOW, ewl_window_list, EWL_WINDOW_TYPE, IF_FREE, name, and title.
Referenced by ewl_window_init().
void ewl_window_cb_expose | ( | Ewl_Widget * | w, | |
void * | ev, | |||
void * | user_data | |||
) |
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_keyboard_grab(), ewl_engine_pointer_grab(), EWL_WINDOW, and EWL_WINDOW_TYPE.
Referenced by ewl_window_init().
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 | |||
) |
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_config, EWL_CONFIG_DEBUG_EVAS_RENDER, ewl_config_int_get(), EWL_EMBED, ewl_engine_canvas_setup(), ewl_engine_embed_dnd_aware_set(), ewl_engine_window_borderless_set(), ewl_engine_window_dialog_set(), ewl_engine_window_geometry_get(), ewl_engine_window_hints_set(), ewl_engine_window_leader_set(), ewl_engine_window_name_class_set(), ewl_engine_window_new(), ewl_engine_window_states_set(), ewl_engine_window_title_set(), EWL_OBJECT, EWL_OBJECT_MAX_SIZE, ewl_object_maximum_h_get(), ewl_object_maximum_size_set(), ewl_object_maximum_w_get(), EWL_WINDOW, and EWL_WINDOW_TYPE.
Referenced by ewl_window_init().
void ewl_window_cb_realize_parent | ( | Ewl_Widget * | w, | |
void * | ev_data, | |||
void * | user_data | |||
) |
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl, ewl_callback_del(), EWL_CALLBACK_REALIZE, EWL_WIDGET, EWL_WINDOW, ewl_window_cb_realize_parent(), ewl_window_leader_set(), ewl_window_transient_for(), EWL_WINDOW_TYPE, leader, and transient.
Referenced by ewl_window_cb_realize_parent(), ewl_window_leader_set(), and ewl_window_transient_for().
void ewl_window_cb_show | ( | Ewl_Widget * | w, | |
void * | ev_data, | |||
void * | user_data | |||
) |
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, ewl_engine_window_borderless_set(), ewl_engine_window_resize(), ewl_engine_window_show(), ewl_widget_configure(), EWL_WINDOW, EWL_WINDOW_OVERRIDE, EWL_WINDOW_TYPE, EWL_WINDOW_USER_CONFIGURE, flags, and window.
Referenced by ewl_window_init().
void ewl_window_cb_unrealize | ( | Ewl_Widget * | w, | |
void * | ev_data, | |||
void * | user_data | |||
) |
References Ewl_Embed::canvas, DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_canvas_destroy(), EWL_EMBED, ewl_embed_cache_cleanup(), ewl_engine_window_destroy(), ewl_engine_window_hide(), EWL_WINDOW, EWL_WINDOW_TYPE, and REALIZED.
Referenced by ewl_window_init().
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.
References classname, DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, and EWL_WINDOW_TYPE.
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.
References classname, DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_window_name_class_set(), EWL_WINDOW_TYPE, and IF_FREE.
Referenced by ewl_colordialog_init(), and ewl_filedialog_init().
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.
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_WINDOW_DIALOG, EWL_WINDOW_TYPE, and flags.
Referenced by ewl_window_dialog_set().
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, ewl_engine_window_dialog_set(), EWL_WINDOW_DIALOG, ewl_window_dialog_get(), EWL_WINDOW_TYPE, and flags.
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
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_WINDOW_FULLSCREEN, EWL_WINDOW_TYPE, and flags.
Referenced by ewl_window_fullscreen_set().
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
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, ewl_engine_window_states_set(), EWL_WINDOW_FULLSCREEN, ewl_window_fullscreen_get(), EWL_WINDOW_TYPE, and flags.
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.
References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, ewl_callback_append(), EWL_CALLBACK_CONFIGURE, EWL_CALLBACK_DESTROY, EWL_CALLBACK_EXPOSE, EWL_CALLBACK_HIDE, ewl_callback_prepend(), EWL_CALLBACK_REALIZE, EWL_CALLBACK_SHOW, EWL_CALLBACK_UNREALIZE, EWL_EMBED, ewl_embed_init(), EWL_FLAG_FILL_FILL, EWL_OBJECT, ewl_object_fill_policy_set(), EWL_WIDGET, ewl_widget_appearance_set(), ewl_widget_inherit(), ewl_window_cb_configure(), ewl_window_cb_destroy(), ewl_window_cb_expose(), ewl_window_cb_hide(), ewl_window_cb_postrealize(), ewl_window_cb_realize(), ewl_window_cb_show(), ewl_window_cb_unrealize(), ewl_window_list, and EWL_WINDOW_TYPE.
Referenced by ewl_cursor_init(), ewl_dialog_init(), ewl_popup_init(), and ewl_window_new().
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.
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_WINDOW_GRAB_KEYBOARD, EWL_WINDOW_TYPE, and flags.
Referenced by ewl_popup_cb_show().
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_keyboard_grab(), EWL_WINDOW_GRAB_KEYBOARD, EWL_WINDOW_TYPE, and flags.
Referenced by ewl_combo_init(), ewl_datepicker_init(), and ewl_popup_cb_show().
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
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_WINDOW_LEADER_FOREIGN, EWL_WINDOW_TYPE, flags, foreign, and leader.
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_window_hints_set(), ewl_engine_window_leader_set(), EWL_WINDOW_LEADER, EWL_WINDOW_LEADER_FOREIGN, EWL_WINDOW_TYPE, flags, foreign, leader, and window.
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
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, ewl, EWL_WINDOW_LEADER, EWL_WINDOW_TYPE, flags, and leader.
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, ewl, ewl_callback_append(), EWL_CALLBACK_REALIZE, ewl_engine_window_hints_set(), ewl_engine_window_leader_set(), EWL_WIDGET, ewl_window_cb_realize_parent(), EWL_WINDOW_LEADER, EWL_WINDOW_LEADER_FOREIGN, EWL_WINDOW_TYPE, flags, leader, and window.
Referenced by ewl_window_cb_realize_parent().
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_window_lower(), and EWL_WINDOW_TYPE.
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.
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_WINDOW_MODAL, EWL_WINDOW_TYPE, and flags.
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
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_window_states_set(), EWL_WINDOW_MODAL, EWL_WINDOW_TYPE, and flags.
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_EMBED, ewl_engine_window_move(), and EWL_WINDOW_TYPE.
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.
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_WINDOW_TYPE, and name.
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_window_name_class_set(), EWL_WINDOW_TYPE, IF_FREE, and name.
Referenced by ewl_colordialog_init(), and ewl_filedialog_init().
Ewl_Widget* ewl_window_new | ( | void | ) |
Allocate and initialize a new window.
- Returns:
- Returns a new window on success, or NULL on failure.
References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_WIDGET, ewl_widget_destroy(), ewl_window_init(), and NEW.
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.
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_WINDOW_OVERRIDE, EWL_WINDOW_TYPE, and flags.
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_WINDOW_OVERRIDE, EWL_WINDOW_TYPE, and flags.
Referenced by ewl_popup_init().
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.
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_WINDOW_GRAB_POINTER, EWL_WINDOW_TYPE, and flags.
Referenced by ewl_popup_cb_show().
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_pointer_grab(), EWL_WINDOW_GRAB_POINTER, EWL_WINDOW_TYPE, and flags.
Referenced by ewl_combo_init(), ewl_datepicker_init(), and ewl_popup_cb_show().
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_window_raise(), and EWL_WINDOW_TYPE.
Referenced by ewl_combo_cb_decrement_clicked(), and ewl_menu_cb_expand().
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
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_WINDOW_SKIP_PAGER, EWL_WINDOW_TYPE, and flags.
Referenced by ewl_window_skip_pager_set().
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
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, ewl_engine_window_states_set(), EWL_WINDOW_SKIP_PAGER, ewl_window_skip_pager_get(), EWL_WINDOW_TYPE, and flags.
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
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_WINDOW_SKIP_TASKBAR, EWL_WINDOW_TYPE, and flags.
Referenced by ewl_window_skip_taskbar_set().
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
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, ewl_engine_window_states_set(), EWL_WINDOW_SKIP_TASKBAR, ewl_window_skip_taskbar_get(), EWL_WINDOW_TYPE, and flags.
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.
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_WINDOW_TYPE, and title.
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_window_title_set(), EWL_WINDOW_TYPE, IF_FREE, and title.
Referenced by ewl_colordialog_init(), and ewl_filedialog_init().
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, ewl, ewl_callback_append(), EWL_CALLBACK_REALIZE, ewl_engine_window_transient_for(), EWL_WIDGET, ewl_window_cb_realize_parent(), EWL_WINDOW_TRANSIENT, EWL_WINDOW_TRANSIENT_FOREIGN, EWL_WINDOW_TYPE, flags, transient, and window.
Referenced by ewl_window_cb_postrealize(), and ewl_window_cb_realize_parent().
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_window_transient_for(), EWL_WINDOW_TRANSIENT, EWL_WINDOW_TRANSIENT_FOREIGN, EWL_WINDOW_TYPE, flags, foreign, transient, and window.
Referenced by ewl_popup_cb_show(), and ewl_window_cb_postrealize().
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
References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_WINDOW_TYPE, EWL_WINDOW_URGENT, and flags.
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.
References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_engine_window_hints_set(), EWL_WINDOW_TYPE, EWL_WINDOW_URGENT, and flags.
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.
References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, ewl_window_list, and window.
Variable Documentation
unsigned int EWL_CALLBACK_DELETE_WINDOW |
The window is being closed
Referenced by ewl_colordialog_init(), ewl_filedialog_init(), and ewl_init().
unsigned int EWL_CALLBACK_EXPOSE |
Triggered when the window needs redrawing
Referenced by ewl_init(), and ewl_window_init().