Class
MetaWindow
Instance methods
meta_window_activate
meta_window_activate_with_workspace
meta_window_allows_move
meta_window_allows_resize
meta_window_appears_focused
Determines if the window should be drawn with a focused appearance. This is true for focused windows but also true for windows with a focused modal dialog attached.
meta_window_begin_grab_op
meta_window_can_close
meta_window_can_maximize
meta_window_can_minimize
meta_window_can_shade
meta_window_change_workspace
meta_window_change_workspace_by_index
meta_window_check_alive
meta_window_client_rect_to_frame_rect
Converts a desired bounds of the client window into the corresponding bounds of the window frame (excluding invisible borders and client side shadows.)
meta_window_compute_group
meta_window_delete
meta_window_find_root_ancestor
Follow the chain of parents of window
, skipping transient windows,
and return the “root” window which has no non-transient parent.
meta_window_focus
meta_window_foreach_ancestor
If window
is transient, call func
with the window for which it’s transient,
repeatedly until either we find a non-transient window, or func
returns FALSE
.
meta_window_foreach_transient
Call func
for every window which is either transient for window
, or is
a transient of a window which is in turn transient for window
.
The order of window enumeration is not defined.
meta_window_frame_rect_to_client_rect
Converts a desired frame bounds for a window into the bounds of the client window.
meta_window_get_buffer_rect
Gets the rectangle that the pixmap or buffer of window
occupies.
meta_window_get_client_machine
Returns name of the client machine from which this windows was created, if known (obtained from the WM_CLIENT_MACHINE property).
meta_window_get_client_type
Returns the MetaWindowClientType
of the window.
meta_window_get_compositor_private
Gets the compositor’s wrapper object for window
.
meta_window_get_description
meta_window_get_display
meta_window_get_frame
meta_window_get_frame_bounds
Gets a region representing the outer bounds of the window’s frame.
meta_window_get_frame_rect
Gets the rectangle that bounds window
that is what the user thinks of
as the edge of the window. This doesn’t include any extra reactive
area that we or the client adds to the window, or any area that the
client adds to draw a client-side shadow.
meta_window_get_frame_type
Gets the type of window decorations that should be used for this window.
meta_window_get_group
meta_window_get_gtk_app_menu_object_path
meta_window_get_gtk_application_id
meta_window_get_gtk_application_object_path
meta_window_get_gtk_menubar_object_path
meta_window_get_gtk_theme_variant
meta_window_get_gtk_unique_bus_name
meta_window_get_gtk_window_object_path
meta_window_get_icon_geometry
Gets the location of the icon corresponding to the window. The location will be provided set by the task bar or other user interface element displaying the icon, and is relative to the root window.
meta_window_get_id
Returns the window id associated with window.
meta_window_get_layer
meta_window_get_maximized
Gets the current maximization state of the window, as combination
of the META_MAXIMIZE_HORIZONTAL
and META_MAXIMIZE_VERTICAL
flags;
meta_window_get_monitor
Gets index of the monitor that this window is on.
meta_window_get_mutter_hints
Gets the current value of the _MUTTER_HINTS property.
meta_window_get_pid
Returns the pid of the process that created this window, if available to the windowing system.
meta_window_get_role
meta_window_get_sandboxed_app_id
Gets an unique id for a sandboxed app (currently flatpaks and snaps are supported).
meta_window_get_stable_sequence
The stable sequence number is a monotonicially increasing
unique integer assigned to each MetaWindow
upon creation.
meta_window_get_startup_id
Gets the startup id of the given MetaWindow
.
meta_window_get_tile_match
Returns the matching tiled window on the same monitor as window
. This is
the topmost tiled window in a complementary tile mode that is:
meta_window_get_title
meta_window_get_transient_for
Returns the MetaWindow
for the window that is pointed to by the
WM_TRANSIENT_FOR hint on this window (see XGetTransientForHint()
or XSetTransientForHint()). Mutter keeps transient windows above their
parents. A typical usage of this hint is for a dialog that wants to stay
above its associated window.
meta_window_get_user_time
The user time represents a timestamp for the last time the user interacted with this window. Note this property is only available for non-override-redirect windows.
meta_window_get_window_type
meta_window_get_wm_class
Return the current value of the name part of WM_CLASS X property.
meta_window_get_wm_class_instance
Return the current value of the instance part of WM_CLASS X property.
meta_window_get_work_area_all_monitors
Get the work area for all monitors for window
.
meta_window_get_work_area_current_monitor
Get the work area for the monitor window
is currently on.
meta_window_get_work_area_for_monitor
Get the work area for window
, given the monitor index
which_monitor
.
meta_window_get_workspace
Gets the MetaWorkspace
that the window is currently displayed on.
If the window is on all workspaces, returns the currently active workspace.
meta_window_get_xwindow
meta_window_group_leader_changed
meta_window_has_attached_dialogs
Tests if window
has any transients attached to it.
(If the “attach_modal_dialogs” option is not enabled, this will
always return FALSE
.)
meta_window_has_focus
meta_window_is_above
meta_window_is_always_on_all_workspaces
meta_window_is_ancestor_of_transient
The function determines whether window
is an ancestor of transient
; it does
so by traversing the transient
‘s ancestors until it either locates window
or reaches an ancestor that is not transient.
meta_window_is_attached_dialog
Tests if window
should be attached to its parent window.
(If the “attach_modal_dialogs” option is not enabled, this will
always return FALSE
.)
meta_window_is_client_decorated
Check if if the window has decorations drawn by the client. (window->decorated refers only to whether we should add decorations)
meta_window_is_fullscreen
meta_window_is_hidden
meta_window_is_monitor_sized
meta_window_is_on_all_workspaces
meta_window_is_on_primary_monitor
meta_window_is_override_redirect
meta_window_is_remote
meta_window_is_screen_sized
meta_window_is_shaded
meta_window_is_skip_taskbar
Gets whether this window should be ignored by task lists.
meta_window_kill
meta_window_located_on_workspace
meta_window_lower
meta_window_lower_with_transients
meta_window_make_above
meta_window_make_fullscreen
meta_window_maximize
meta_window_minimize
meta_window_move_frame
Moves the window to the desired location on window’s assigned
workspace, using the northwest edge of the frame as the reference,
instead of the actual window’s origin, but only if a frame is present.
Otherwise, acts identically to meta_window_move()
.
meta_window_move_resize_frame
Resizes the window so that its outer bounds (including frame) fit within the given rect.
meta_window_move_to_monitor
Moves the window to the monitor with index monitor
, keeping
the relative position of the window’s top left corner.
meta_window_raise
meta_window_set_compositor_private
meta_window_set_demands_attention
meta_window_set_icon_geometry
Sets or unsets the location of the icon corresponding to the window. If set, the location should correspond to a dock, task bar or other user interface element displaying the icon, and is relative to the root window.
meta_window_shade
meta_window_shove_titlebar_onscreen
meta_window_showing_on_its_workspace
meta_window_shutdown_group
meta_window_stick
meta_window_titlebar_is_onscreen
meta_window_unmake_above
meta_window_unmake_fullscreen
meta_window_unmaximize
meta_window_unminimize
meta_window_unset_demands_attention
meta_window_unshade
meta_window_unstick
Properties
Meta.Window:above
Meta.Window:appears-focused
Meta.Window:decorated
Meta.Window:demands-attention
Meta.Window:fullscreen
Meta.Window:gtk-app-menu-object-path
Meta.Window:gtk-application-id
Meta.Window:gtk-application-object-path
Meta.Window:gtk-menubar-object-path
Meta.Window:gtk-unique-bus-name
Meta.Window:gtk-window-object-path
Meta.Window:icon
Meta.Window:is-alive
Meta.Window:maximized-horizontally
Meta.Window:maximized-vertically
Meta.Window:mini-icon
Meta.Window:minimized
Meta.Window:mutter-hints
Meta.Window:on-all-workspaces
Meta.Window:resizeable
Meta.Window:skip-taskbar
Meta.Window:title
Meta.Window:urgent
Meta.Window:user-time
Meta.Window:window-type
Meta.Window:wm-class
Signals
Meta.Window::focus
Meta.Window::position-changed
This is emitted when the position of a window might have changed. Specifically, this is emitted when the position of the toplevel window has changed, or when the position of the client window has changed.
Meta.Window::raised
Meta.Window::shown
This is emitted after a window has been shown.
Meta.Window::size-changed
This is emitted when the size of a window might have changed. Specifically, this is emitted when the size of the toplevel window has changed, or when the size of the client window has changed.