meta_window_get_frame ()

MetaFrame *
meta_window_get_frame (MetaWindow *window);

meta_window_has_focus ()

gboolean
meta_window_has_focus (MetaWindow *window);

meta_window_appears_focused ()

gboolean
meta_window_appears_focused (MetaWindow *window);

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_is_shaded ()

gboolean
meta_window_is_shaded (MetaWindow *window);

meta_window_is_monitor_sized ()

gboolean
meta_window_is_monitor_sized (MetaWindow *window);

meta_window_is_override_redirect ()

gboolean
meta_window_is_override_redirect (MetaWindow *window);

meta_window_is_skip_taskbar ()

gboolean
meta_window_is_skip_taskbar (MetaWindow *window);

Gets whether this window should be ignored by task lists.

meta_window_get_buffer_rect ()

void
meta_window_get_buffer_rect (const MetaWindow *window,
                             MetaRectangle *rect);

Gets the rectangle that the pixmap or buffer of window occupies.

For X11 windows, this is the server-side geometry of the toplevel window.

For Wayland windows, this is the bounding rectangle of the attached buffer.

meta_window_get_frame_rect ()

void
meta_window_get_frame_rect (const MetaWindow *window,
                            MetaRectangle *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_client_rect_to_frame_rect ()

void
meta_window_client_rect_to_frame_rect (MetaWindow *window,
                                       MetaRectangle *client_rect,
                                       MetaRectangle *frame_rect);

Converts a desired bounds of the client window - what is passed to meta_window_move_resize() - into the corresponding bounds of the window frame (excluding invisible borders and client side shadows.)

meta_window_frame_rect_to_client_rect ()

void
meta_window_frame_rect_to_client_rect (MetaWindow *window,
                                       MetaRectangle *frame_rect,
                                       MetaRectangle *client_rect);

Converts a desired frame bounds for a window into the bounds of the client window - what is passed to meta_window_move_resize().

meta_window_get_screen ()

MetaScreen *
meta_window_get_screen (MetaWindow *window);

Gets the MetaScreen that the window is on.

meta_window_get_display ()

MetaDisplay *
meta_window_get_display (MetaWindow *window);

meta_window_get_xwindow ()

Window
meta_window_get_xwindow (MetaWindow *window);

meta_window_get_window_type ()

MetaWindowType
meta_window_get_window_type (MetaWindow *window);

meta_window_get_workspace ()

MetaWorkspace *
meta_window_get_workspace (MetaWindow *window);

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_monitor ()

int
meta_window_get_monitor (MetaWindow *window);

Gets index of the monitor that this window is on.

meta_window_is_on_all_workspaces ()

gboolean
meta_window_is_on_all_workspaces (MetaWindow *window);

meta_window_located_on_workspace ()

gboolean
meta_window_located_on_workspace (MetaWindow *window,
                                  MetaWorkspace *workspace);

meta_window_is_hidden ()

gboolean
meta_window_is_hidden (MetaWindow *window);

meta_window_activate ()

void
meta_window_activate (MetaWindow *window,
                      guint32 current_time);

meta_window_activate_with_workspace ()

void
meta_window_activate_with_workspace (MetaWindow *window,
                                     guint32 current_time,
                                     MetaWorkspace *workspace);

meta_window_get_description ()

const char *
meta_window_get_description (MetaWindow *window);

meta_window_get_wm_class ()

const char *
meta_window_get_wm_class (MetaWindow *window);

Return the current value of the name part of WM_CLASS X property.

meta_window_get_wm_class_instance ()

const char *
meta_window_get_wm_class_instance (MetaWindow *window);

Return the current value of the instance part of WM_CLASS X property.

meta_window_showing_on_its_workspace ()

gboolean
meta_window_showing_on_its_workspace (MetaWindow *window);

meta_window_get_gtk_application_id ()

const char *
meta_window_get_gtk_application_id (MetaWindow *window);

meta_window_get_gtk_unique_bus_name ()

const char *
meta_window_get_gtk_unique_bus_name (MetaWindow *window);

meta_window_get_gtk_application_object_path ()

const char *
meta_window_get_gtk_application_object_path
                               (MetaWindow *window);

meta_window_get_gtk_window_object_path ()

const char *
meta_window_get_gtk_window_object_path
                               (MetaWindow *window);

meta_window_get_gtk_app_menu_object_path ()

const char *
meta_window_get_gtk_app_menu_object_path
                               (MetaWindow *window);

meta_window_get_gtk_menubar_object_path ()

const char *
meta_window_get_gtk_menubar_object_path
                               (MetaWindow *window);

meta_window_move_frame ()

void
meta_window_move_frame (MetaWindow *window,
                        gboolean user_op,
                        int root_x_nw,
                        int root_y_nw);

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 ()

void
meta_window_move_resize_frame (MetaWindow *window,
                               gboolean user_op,
                               int root_x_nw,
                               int root_y_nw,
                               int w,
                               int h);

Resizes the window so that its outer bounds (including frame) fit within the given rect

meta_window_move_to_monitor ()

void
meta_window_move_to_monitor (MetaWindow *window,
                             int monitor);

Moves the window to the monitor with index monitor , keeping the relative position of the window's top left corner.

meta_window_set_demands_attention ()

void
meta_window_set_demands_attention (MetaWindow *window);

meta_window_unset_demands_attention ()

void
meta_window_unset_demands_attention (MetaWindow *window);

meta_window_get_startup_id ()

const char *
meta_window_get_startup_id (MetaWindow *window);

meta_window_change_workspace_by_index ()

void
meta_window_change_workspace_by_index (MetaWindow *window,
                                       gint space_index,
                                       gboolean append);

meta_window_change_workspace ()

void
meta_window_change_workspace (MetaWindow *window,
                              MetaWorkspace *workspace);

meta_window_get_compositor_private ()

GObject *
meta_window_get_compositor_private (MetaWindow *window);

Gets the compositor's wrapper object for window .

meta_window_set_compositor_private ()

void
meta_window_set_compositor_private (MetaWindow *window,
                                    GObject *priv);

meta_window_get_role ()

const char *
meta_window_get_role (MetaWindow *window);

meta_window_get_layer ()

MetaStackLayer
meta_window_get_layer (MetaWindow *window);

meta_window_find_root_ancestor ()

MetaWindow *
meta_window_find_root_ancestor (MetaWindow *window);

Follow the chain of parents of window , skipping transient windows, and return the "root" window which has no non-transient parent.

meta_window_is_ancestor_of_transient ()

gboolean
meta_window_is_ancestor_of_transient (MetaWindow *window,
                                      MetaWindow *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.

MetaWindowForeachFunc ()

gboolean
(*MetaWindowForeachFunc) (MetaWindow *window,
                          void *user_data);

meta_window_foreach_transient ()

void
meta_window_foreach_transient (MetaWindow *window,
                               MetaWindowForeachFunc func,
                               void *user_data);

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.

Iteration will stop if func at any point returns FALSE.

meta_window_foreach_ancestor ()

void
meta_window_foreach_ancestor (MetaWindow *window,
                              MetaWindowForeachFunc func,
                              void *user_data);

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_get_maximized ()

MetaMaximizeFlags
meta_window_get_maximized (MetaWindow *window);

Gets the current maximization state of the window, as combination of the META_MAXIMIZE_HORIZONTAL and META_MAXIMIZE_VERTICAL flags;

meta_window_is_fullscreen ()

gboolean
meta_window_is_fullscreen (MetaWindow *window);

meta_window_is_on_primary_monitor ()

gboolean
meta_window_is_on_primary_monitor (MetaWindow *window);

meta_window_requested_bypass_compositor ()

gboolean
meta_window_requested_bypass_compositor
                               (MetaWindow *window);

meta_window_requested_dont_bypass_compositor ()

gboolean
meta_window_requested_dont_bypass_compositor
                               (MetaWindow *window);

meta_window_get_icon_geometry ()

gboolean
meta_window_get_icon_geometry (MetaWindow *window,
                               MetaRectangle *rect);

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_set_icon_geometry ()

void
meta_window_set_icon_geometry (MetaWindow *window,
                               MetaRectangle *rect);

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_maximize ()

void
meta_window_maximize (MetaWindow *window,
                      MetaMaximizeFlags directions);

meta_window_unmaximize ()

void
meta_window_unmaximize (MetaWindow *window,
                        MetaMaximizeFlags directions);

meta_window_minimize ()

void
meta_window_minimize (MetaWindow *window);

meta_window_unminimize ()

void
meta_window_unminimize (MetaWindow *window);

meta_window_raise ()

void
meta_window_raise (MetaWindow *window);

meta_window_lower ()

void
meta_window_lower (MetaWindow *window);

meta_window_get_title ()

const char *
meta_window_get_title (MetaWindow *window);

meta_window_get_transient_for ()

MetaWindow *
meta_window_get_transient_for (MetaWindow *window);

Returns the MetaWindow for the window that is pointed to by the WM_TRANSIENT_FOR hint on this window (see XGetTransientForHint() or XSetTransientForHint()). Metacity 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_delete ()

void
meta_window_delete (MetaWindow *window,
                    guint32 timestamp);

meta_window_get_stable_sequence ()

guint
meta_window_get_stable_sequence (MetaWindow *window);

The stable sequence number is a monotonicially increasing unique integer assigned to each MetaWindow upon creation.

This number can be useful for sorting windows in a stable fashion.

meta_window_get_user_time ()

guint32
meta_window_get_user_time (MetaWindow *window);

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.

The property is set by Mutter initially upon window creation, and updated thereafter on input events (key and button presses) seen by Mutter, client updates to the _NET_WM_USER_TIME property (if later than the current time) and when focusing the window.

meta_window_get_pid ()

int
meta_window_get_pid (MetaWindow *window);

Returns pid of the process that created this window, if known (obtained from the _NET_WM_PID property).

meta_window_get_client_machine ()

const char *
meta_window_get_client_machine (MetaWindow *window);

Returns name of the client machine from which this windows was created, if known (obtained from the WM_CLIENT_MACHINE property).

meta_window_is_remote ()

gboolean
meta_window_is_remote (MetaWindow *window);

meta_window_is_attached_dialog ()

gboolean
meta_window_is_attached_dialog (MetaWindow *window);

Tests if window is should be attached to its parent window. (If the "attach_modal_dialogs" option is not enabled, this will always return FALSE.)

meta_window_get_mutter_hints ()

const char *
meta_window_get_mutter_hints (MetaWindow *window);

Gets the current value of the _MUTTER_HINTS property.

The purpose of the hints is to allow fine-tuning of the Window Manager and Compositor behaviour on per-window basis, and is intended primarily for hints that are plugin-specific.

The property is a list of colon-separated key=value pairs. The key names for any plugin-specific hints must be suitably namespaced to allow for shared use; 'mutter-' key prefix is reserved for internal use, and must not be used by plugins.

meta_window_get_frame_type ()

MetaFrameType
meta_window_get_frame_type (MetaWindow *window);

Gets the type of window decorations that should be used for this window.

meta_window_get_frame_bounds ()

cairo_region_t *
meta_window_get_frame_bounds (MetaWindow *window);

Gets a region representing the outer bounds of the window's frame.

meta_window_get_tile_match ()

MetaWindow *
meta_window_get_tile_match (MetaWindow *window);

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_make_fullscreen ()

void
meta_window_make_fullscreen (MetaWindow *window);

meta_window_unmake_fullscreen ()

void
meta_window_unmake_fullscreen (MetaWindow *window);

meta_window_make_above ()

void
meta_window_make_above (MetaWindow *window);

meta_window_unmake_above ()

void
meta_window_unmake_above (MetaWindow *window);

meta_window_shade ()

void
meta_window_shade (MetaWindow *window,
                   guint32 timestamp);

meta_window_unshade ()

void
meta_window_unshade (MetaWindow *window,
                     guint32 timestamp);

meta_window_stick ()

void
meta_window_stick (MetaWindow *window);

meta_window_unstick ()

void
meta_window_unstick (MetaWindow *window);

meta_window_kill ()

void
meta_window_kill (MetaWindow *window);

meta_window_focus ()

void
meta_window_focus (MetaWindow *window,
                   guint32 timestamp);

meta_window_check_alive ()

void
meta_window_check_alive (MetaWindow *window,
                         guint32 timestamp);

meta_window_get_work_area_current_monitor ()

void
meta_window_get_work_area_current_monitor
                               (MetaWindow *window,
                                MetaRectangle *area);

Get the work area for the monitor window is currently on.

meta_window_get_work_area_for_monitor ()

void
meta_window_get_work_area_for_monitor (MetaWindow *window,
                                       int which_monitor,
                                       MetaRectangle *area);

Get the work area for window , given the monitor index which_monitor .

meta_window_get_work_area_all_monitors ()

void
meta_window_get_work_area_all_monitors
                               (MetaWindow *window,
                                MetaRectangle *area);

Get the work area for all monitors for window .

meta_window_begin_grab_op ()

void
meta_window_begin_grab_op (MetaWindow *window,
                           MetaGrabOp op,
                           gboolean frame_action,
                           guint32 timestamp);

MetaWindow

typedef struct _MetaWindow MetaWindow;

MetaWindowClass

typedef struct _MetaWindowClass MetaWindowClass;

enum MetaWindowType

enum MetaMaximizeFlags

The “above” property

  “above”                    gboolean

Whether the window is shown as always-on-top.

Flags: Read

Default value: FALSE

The “appears-focused” property

  “appears-focused”          gboolean

Whether the window is drawn as being focused.

Flags: Read

Default value: FALSE

The “decorated” property

  “decorated”                gboolean

Whether window is decorated.

Flags: Read

Default value: TRUE

The “demands-attention” property

  “demands-attention”        gboolean

Whether the window has _NET_WM_STATE_DEMANDS_ATTENTION set.

Flags: Read

Default value: FALSE

The “fullscreen” property

  “fullscreen”               gboolean

Whether window is fullscreened.

Flags: Read

Default value: FALSE

The “gtk-app-menu-object-path” property

  “gtk-app-menu-object-path” gchar *

Contents of the _GTK_APP_MENU_OBJECT_PATH property of this window.

Flags: Read

Default value: NULL

The “gtk-application-id” property

  “gtk-application-id”       gchar *

Contents of the _GTK_APPLICATION_ID property of this window.

Flags: Read

Default value: NULL

The “gtk-application-object-path” property

  “gtk-application-object-path” gchar *

Contents of the _GTK_APPLICATION_OBJECT_PATH property of this window.

Flags: Read

Default value: NULL

The “gtk-menubar-object-path” property

  “gtk-menubar-object-path”  gchar *

Contents of the _GTK_MENUBAR_OBJECT_PATH property of this window.

Flags: Read

Default value: NULL

The “gtk-unique-bus-name” property

  “gtk-unique-bus-name”      gchar *

Contents of the _GTK_UNIQUE_BUS_NAME property of this window.

Flags: Read

Default value: NULL

The “gtk-window-object-path” property

  “gtk-window-object-path”   gchar *

Contents of the _GTK_WINDOW_OBJECT_PATH property of this window.

Flags: Read

Default value: NULL

The “icon” property

  “icon”                     gpointer

96 pixel sized icon.

Flags: Read

The “maximized-horizontally” property

  “maximized-horizontally”   gboolean

Whether window is maximized horizontally.

Flags: Read

Default value: FALSE

The “maximized-vertically” property

  “maximized-vertically”     gboolean

Whether window is maximized vertically.

Flags: Read

Default value: FALSE

The “mini-icon” property

  “mini-icon”                gpointer

16 pixel sized icon.

Flags: Read

The “minimized” property

  “minimized”                gboolean

Whether window is minimized.

Flags: Read

Default value: FALSE

The “mutter-hints” property

  “mutter-hints”             gchar *

Contents of the _MUTTER_HINTS property of this window.

Flags: Read

Default value: NULL

The “on-all-workspaces” property

  “on-all-workspaces”        gboolean

Whether the window is set to appear on all workspaces.

Flags: Read

Default value: FALSE

The “resizeable” property

  “resizeable”               gboolean

Whether the window can be resized.

Flags: Read

Default value: FALSE

The “skip-taskbar” property

  “skip-taskbar”             gboolean

Whether the skip-taskbar flag of WM_HINTS is set.

Flags: Read

Default value: FALSE

The “title” property

  “title”                    gchar *

The title of the window.

Flags: Read

Default value: NULL

The “urgent” property

  “urgent”                   gboolean

Whether the urgent flag of WM_HINTS is set.

Flags: Read

Default value: FALSE

The “user-time” property

  “user-time”                guint

Timestamp of last user interaction.

Flags: Read

Default value: 0

The “window-type” property

  “window-type”              MetaWindowType

The type of the window.

Flags: Read

Default value: META_WINDOW_NORMAL

The “wm-class” property

  “wm-class”                 gchar *

Contents of the WM_CLASS property of this window.

Flags: Read

Default value: NULL

The “focus” signal

void
user_function (MetaWindow *metawindow,
               gpointer    user_data)

Flags: Run Last

The “position-changed” signal

void
user_function (MetaWindow *window,
               gpointer    user_data)

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.

Flags: Run Last

The “raised” signal

void
user_function (MetaWindow *metawindow,
               gpointer    user_data)

Flags: Run Last

The “size-changed” signal

void
user_function (MetaWindow *window,
               gpointer    user_data)

This is emitted when the position 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.

Flags: Run Last

The “unmanaged” signal

void
user_function (MetaWindow *metawindow,
               gpointer    user_data)

Flags: Run Last

The “workspace-changed” signal

void
user_function (MetaWindow *metawindow,
               gpointer    user_data)

Flags: Run Last