Functions
Wayland Library Window Functions

Functions that deal with creating, destroying, or interacting with Wayland windows. More...

Functions

EAPI Ecore_Wl2_Window * ecore_wl2_window_new (Ecore_Wl2_Display *display, Ecore_Wl2_Window *parent, int x, int y, int w, int h)
 Create a new Ecore_Wl2_Window. More...
 
EAPI int ecore_wl2_window_id_get (Ecore_Wl2_Window *window)
 Get the window id associated with an Ecore_Wl2_Window. More...
 
EAPI struct wl_surface * ecore_wl2_window_surface_get (Ecore_Wl2_Window *window)
 Get the wl_surface which belongs to this window. More...
 
EAPI int ecore_wl2_window_surface_id_get (Ecore_Wl2_Window *window)
 Get the id of a given Ecore_Wl2_Window. More...
 
EAPI void ecore_wl2_window_show (Ecore_Wl2_Window *window)
 Show a given Ecore_Wl2_Window. More...
 
EAPI void ecore_wl2_window_hide (Ecore_Wl2_Window *window)
 Hide a given Ecore_Wl2_Window. More...
 
EAPI void ecore_wl2_window_free (Ecore_Wl2_Window *window)
 Free a given Ecore_Wl2_Window. More...
 
EAPI void ecore_wl2_window_move (Ecore_Wl2_Window *window, int x, int y)
 Move a given Ecore_Wl2_Window. More...
 
EAPI void ecore_wl2_window_resize (Ecore_Wl2_Window *window, int w, int h, int location)
 Resize a given Ecore_Wl2_Window. More...
 
EAPI void ecore_wl2_window_raise (Ecore_Wl2_Window *window)
 Raise a given Ecore_Wl2_Window. More...
 
EAPI Eina_Bool ecore_wl2_window_alpha_get (Ecore_Wl2_Window *window)
 Get if a given window is alpha. More...
 
EAPI void ecore_wl2_window_alpha_set (Ecore_Wl2_Window *window, Eina_Bool alpha)
 Set a given window's alpha property. More...
 
EAPI void ecore_wl2_window_transparent_set (Ecore_Wl2_Window *window, Eina_Bool transparent)
 Set a given window's transparent property. More...
 
EAPI void ecore_wl2_window_opaque_region_set (Ecore_Wl2_Window *window, int x, int y, int w, int h)
 Set the opaque region of the Ecore_Wl2_Window. More...
 
EAPI void ecore_wl2_window_input_region_set (Ecore_Wl2_Window *window, int x, int y, int w, int h)
 Set the input region of the Ecore_Wl2_Window. More...
 
EAPI Eina_Bool ecore_wl2_window_maximized_get (Ecore_Wl2_Window *window)
 Get if a given window is maximized. More...
 
EAPI void ecore_wl2_window_maximized_set (Ecore_Wl2_Window *window, Eina_Bool maximized)
 Set the maximized state of a given window. More...
 
EAPI Eina_Bool ecore_wl2_window_fullscreen_get (Ecore_Wl2_Window *window)
 Get if a given window is fullscreen. More...
 
EAPI void ecore_wl2_window_fullscreen_set (Ecore_Wl2_Window *window, Eina_Bool fullscreen)
 Set the fullscreen state of a given window. More...
 
EAPI int ecore_wl2_window_rotation_get (Ecore_Wl2_Window *window)
 Get if a given window is rotated. More...
 
EAPI void ecore_wl2_window_rotation_set (Ecore_Wl2_Window *window, int rotation)
 Set the rotation of a given window. More...
 
EAPI void ecore_wl2_window_title_set (Ecore_Wl2_Window *window, const char *title)
 Set the title of a given window. More...
 
EAPI void ecore_wl2_window_class_set (Ecore_Wl2_Window *window, const char *clas)
 Set the class of a given window. More...
 
EAPI void ecore_wl2_window_geometry_get (Ecore_Wl2_Window *window, int *x, int *y, int *w, int *h)
 Get the geometry of a given window. More...
 
EAPI void ecore_wl2_window_geometry_set (Ecore_Wl2_Window *window, int x, int y, int w, int h)
 Set the geometry of a given window. More...
 
EAPI Eina_Bool ecore_wl2_window_iconified_get (Ecore_Wl2_Window *window)
 Get the iconified state of a given window. More...
 
EAPI void ecore_wl2_window_iconified_set (Ecore_Wl2_Window *window, Eina_Bool iconified)
 Iconify a window. More...
 
EAPI void ecore_wl2_window_pointer_xy_get (Ecore_Wl2_Window *window, int *x, int *y)
 Retrieves the mouse position of the current window. More...
 
EAPI void ecore_wl2_window_pointer_set (Ecore_Wl2_Window *window, struct wl_surface *surface, int hot_x, int hot_y)
 Set a given wl_surface to use as the pointer on a window. More...
 
EAPI void ecore_wl2_window_cursor_from_name_set (Ecore_Wl2_Window *window, const char *cursor)
 Set a specific cursor on a given window. More...
 
EAPI void ecore_wl2_window_type_set (Ecore_Wl2_Window *window, Ecore_Wl2_Window_Type type)
 Set the type of a given window. More...
 

Detailed Description

Functions that deal with creating, destroying, or interacting with Wayland windows.

Function Documentation

§ ecore_wl2_window_new()

EAPI Ecore_Wl2_Window* ecore_wl2_window_new ( Ecore_Wl2_Display *  display,
Ecore_Wl2_Window *  parent,
int  x,
int  y,
int  w,
int  h 
)

Create a new Ecore_Wl2_Window.

Parameters
displayThe Ecore_Wl2_Display on which to create this new window
parentThe Ecore_Wl2_Window which is the parent of this window
xInitial x position of window
yInitial y position of window
wInitial width of window
hInitial height of window
Since
1.17

§ ecore_wl2_window_id_get()

EAPI int ecore_wl2_window_id_get ( Ecore_Wl2_Window *  window)

Get the window id associated with an Ecore_Wl2_Window.

Parameters
windowThe Ecore_Wl2_Window of which to retrieve the window id
Returns
The id associated with this window
Since
1.17

Referenced by elm_win_inlined_image_object_get().

§ ecore_wl2_window_surface_get()

EAPI struct wl_surface* ecore_wl2_window_surface_get ( Ecore_Wl2_Window *  window)

Get the wl_surface which belongs to this window.

Parameters
windowThe Ecore_Wl2_Window to get the surface of
Returns
The wl_surface associated with this window.
Since
1.17

§ ecore_wl2_window_surface_id_get()

EAPI int ecore_wl2_window_surface_id_get ( Ecore_Wl2_Window *  window)

Get the id of a given Ecore_Wl2_Window.

Parameters
windowThe window to return the id of
Returns
The id of the given window, or -1 on failure
Since
1.17

§ ecore_wl2_window_show()

EAPI void ecore_wl2_window_show ( Ecore_Wl2_Window *  window)

Show a given Ecore_Wl2_Window.

Parameters
windowThe Ecore_Wl2_Window to show
Since
1.17

§ ecore_wl2_window_hide()

EAPI void ecore_wl2_window_hide ( Ecore_Wl2_Window *  window)

Hide a given Ecore_Wl2_Window.

Parameters
windowThe Ecore_Wl2_Window to hide
Since
1.17

§ ecore_wl2_window_free()

EAPI void ecore_wl2_window_free ( Ecore_Wl2_Window *  window)

Free a given Ecore_Wl2_Window.

Parameters
windowThe Ecore_Wl2_Window to free
Since
1.17

§ ecore_wl2_window_move()

EAPI void ecore_wl2_window_move ( Ecore_Wl2_Window *  window,
int  x,
int  y 
)

Move a given Ecore_Wl2_Window.

The position requested (x, y) is not honored by Wayland because Wayland does not allow specific window placement to be set.

Parameters
windowThe Ecore_Wl2_Window which to move
xDesired x position of window
yDesired y position of window
Since
1.17

§ ecore_wl2_window_resize()

EAPI void ecore_wl2_window_resize ( Ecore_Wl2_Window *  window,
int  w,
int  h,
int  location 
)

Resize a given Ecore_Wl2_Window.

The size requested (w, h) is not honored by Wayland because Wayland does not allow specific window sizes to be set.

Parameters
windowThe Ecore_Wl2_Window which to resize
wDesired width of window
hDesired height of window
locationThe edge of the window from where the resize should start
Since
1.17

§ ecore_wl2_window_raise()

EAPI void ecore_wl2_window_raise ( Ecore_Wl2_Window *  window)

Raise a given Ecore_Wl2_Window.

Parameters
windowThe Ecore_Wl2_Window which to raise
Since
1.17

§ ecore_wl2_window_alpha_get()

EAPI Eina_Bool ecore_wl2_window_alpha_get ( Ecore_Wl2_Window *  window)

Get if a given window is alpha.

Parameters
windowThe window to get if is alpha
Returns
EINA_TRUE if window is alpha, EINA_FALSE otherwise
Since
1.17

§ ecore_wl2_window_alpha_set()

EAPI void ecore_wl2_window_alpha_set ( Ecore_Wl2_Window *  window,
Eina_Bool  alpha 
)

Set a given window's alpha property.

Parameters
windowThe window on which to set the alpha property
alphaEINA_TRUE to set window as alpha, EINA_FALSE otherwise
Since
1.17

§ ecore_wl2_window_transparent_set()

EAPI void ecore_wl2_window_transparent_set ( Ecore_Wl2_Window *  window,
Eina_Bool  transparent 
)

Set a given window's transparent property.

Parameters
windowThe window on which to set the transparent property
transparentEINA_TRUE to set window as transparent, EINA_FALSE otherwise
Since
1.17

§ ecore_wl2_window_opaque_region_set()

EAPI void ecore_wl2_window_opaque_region_set ( Ecore_Wl2_Window *  window,
int  x,
int  y,
int  w,
int  h 
)

Set the opaque region of the Ecore_Wl2_Window.

Parameters
winThe window
xThe left point of the region.
yThe top point of the region.
wThe width of the region.
hThe height of the region.
Since
1.17

§ ecore_wl2_window_input_region_set()

EAPI void ecore_wl2_window_input_region_set ( Ecore_Wl2_Window *  window,
int  x,
int  y,
int  w,
int  h 
)

Set the input region of the Ecore_Wl2_Window.

To set an empty region, pass width and height as 0.

An empty input region means the entire window surface will accept input.

Parameters
windowThe window to set the input region of
xThe left point of the region.
yThe top point of the region.
wThe width of the region.
hThe height of the region.
Since
1.17

§ ecore_wl2_window_maximized_get()

EAPI Eina_Bool ecore_wl2_window_maximized_get ( Ecore_Wl2_Window *  window)

Get if a given window is maximized.

Parameters
windowThe window to get the maximized state of
Returns
EINA_TRUE if window is maximized, EINA_FALSE otherwise
Since
1.17

§ ecore_wl2_window_maximized_set()

EAPI void ecore_wl2_window_maximized_set ( Ecore_Wl2_Window *  window,
Eina_Bool  maximized 
)

Set the maximized state of a given window.

Parameters
windowThe window to set the maximized state of
maximizedEINA_TRUE to set maximized, EINA_FALSE to unset
Since
1.17

§ ecore_wl2_window_fullscreen_get()

EAPI Eina_Bool ecore_wl2_window_fullscreen_get ( Ecore_Wl2_Window *  window)

Get if a given window is fullscreen.

Parameters
windowThe window to get the fullscreen state of
Returns
EINA_TRUE if window is fullscreen, EINA_FALSE otherwise
Since
1.17

§ ecore_wl2_window_fullscreen_set()

EAPI void ecore_wl2_window_fullscreen_set ( Ecore_Wl2_Window *  window,
Eina_Bool  fullscreen 
)

Set the fullscreen state of a given window.

Parameters
windowThe window to set the fullscreen state of
maximizedEINA_TRUE to set fullscreen, EINA_FALSE to unset
Since
1.17

§ ecore_wl2_window_rotation_get()

EAPI int ecore_wl2_window_rotation_get ( Ecore_Wl2_Window *  window)

Get if a given window is rotated.

Parameters
windowThe window to get the rotation of
Returns
The amount of rotation for this window, or -1 on failure
Since
1.17

§ ecore_wl2_window_rotation_set()

EAPI void ecore_wl2_window_rotation_set ( Ecore_Wl2_Window *  window,
int  rotation 
)

Set the rotation of a given window.

Parameters
windowThe window to set the rotation of
rotationThe amount of rotation
Since
1.17

§ ecore_wl2_window_title_set()

EAPI void ecore_wl2_window_title_set ( Ecore_Wl2_Window *  window,
const char *  title 
)

Set the title of a given window.

Parameters
windowThe window to set the title of
titleThe title of the window
Since
1.17

§ ecore_wl2_window_class_set()

EAPI void ecore_wl2_window_class_set ( Ecore_Wl2_Window *  window,
const char *  clas 
)

Set the class of a given window.

Parameters
windowThe window to set the class of
clasThe class of the window
Since
1.17

§ ecore_wl2_window_geometry_get()

EAPI void ecore_wl2_window_geometry_get ( Ecore_Wl2_Window *  window,
int *  x,
int *  y,
int *  w,
int *  h 
)

Get the geometry of a given window.

The window geometry returned here is the window geometry as recognized by xdg_surface_set_window_geometry. As such, it represents the "visible bounds" of a window from the user's perspective.

Parameters
windowThe window to get the geometry of
xThe left point of the window geometry
yThe top point of the window geometry
wThe width of the window geometry
hThe height of the window geometry
Since
1.17

§ ecore_wl2_window_geometry_set()

EAPI void ecore_wl2_window_geometry_set ( Ecore_Wl2_Window *  window,
int  x,
int  y,
int  w,
int  h 
)

Set the geometry of a given window.

The window geometry referenced here is the window geometry as recognized by xdg_surface_set_window_geometry. As such, it represents the "visible bounds" of a window from the user's perspective.

Parameters
windowThe window to set the geometry of
xThe left point of the window geometry
yThe top point of the window geometry
wThe width of the window geometry
hThe height of the window geometry
Since
1.17

§ ecore_wl2_window_iconified_get()

EAPI Eina_Bool ecore_wl2_window_iconified_get ( Ecore_Wl2_Window *  window)

Get the iconified state of a given window.

Parameters
windowThe window to get the iconified state of
Returns
EINA_TRUE if window is iconified, EINA_FALSE otherwise
Since
1.17

§ ecore_wl2_window_iconified_set()

EAPI void ecore_wl2_window_iconified_set ( Ecore_Wl2_Window *  window,
Eina_Bool  iconified 
)

Iconify a window.

Parameters
winThe window to iconifiy
iconifiedThe new iconified state to set
Since
1.17

§ ecore_wl2_window_pointer_xy_get()

EAPI void ecore_wl2_window_pointer_xy_get ( Ecore_Wl2_Window *  window,
int *  x,
int *  y 
)

Retrieves the mouse position of the current window.

Parameters
windowThe window on which to retrieve the mouse position
xwhere to return the horizontal position. May be NULL. Returns 0 on error.
ywhere to return the vertical position. May be NULL. Returns 0 on error.
Since
1.17

§ ecore_wl2_window_pointer_set()

EAPI void ecore_wl2_window_pointer_set ( Ecore_Wl2_Window *  window,
struct wl_surface *  surface,
int  hot_x,
int  hot_y 
)

Set a given wl_surface to use as the pointer on a window.

Parameters
windowThe window to set this surface as the pointer on
surfaceThe surface to use as the pointer
hot_xThe x coordinate to use as the cursor hot spot
hot_yThe y coordinate to use as the cursor hot spot
Since
1.17

§ ecore_wl2_window_cursor_from_name_set()

EAPI void ecore_wl2_window_cursor_from_name_set ( Ecore_Wl2_Window *  window,
const char *  cursor 
)

Set a specific cursor on a given window.

This function will try to find a matching cursor inside the existing cursor theme and set the pointer which is over the given window to be the specified cursor

Parameters
windowThe window to set the cursor on
cursorThe name of the cursor to try and set
Since
1.17

§ ecore_wl2_window_type_set()

EAPI void ecore_wl2_window_type_set ( Ecore_Wl2_Window *  window,
Ecore_Wl2_Window_Type  type 
)

Set the type of a given window.

Parameters
windowThe window to set the type of The Ecore_Wl2_Window_Type to set on the window
Since
1.17