Optionalproperties: Partial<Meta.Window.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeRead-Onlya11y_Read-Onlya11y_Read-Onlya11yRead-Onlya11yRead-OnlyaboveRead-Onlyappears_Read-OnlyappearsRead-OnlydecoratedRead-Onlydemands_Read-OnlydemandsConstruct OnlydisplayConstruct OnlyeffectRead-OnlyfullscreenRead-Onlygtk_Read-Onlygtk_Read-Onlygtk_Read-Onlygtk_Read-Onlygtk_Read-Onlygtk_Read-OnlygtkRead-OnlygtkRead-OnlygtkRead-OnlygtkRead-OnlygtkRead-OnlygtkRead-Onlyis_Read-OnlyisRead-Onlymain_Read-OnlymainRead-OnlymappedRead-Onlymaximized_Read-Onlymaximized_Read-OnlymaximizedRead-OnlymaximizedRead-OnlyminimizedRead-Onlymutter_Read-OnlymutterRead-Onlyon_Read-OnlyonRead-OnlyresizeableRead-Onlyskip_Read-OnlyskipRead-OnlytagRead-OnlytitleRead-OnlyurgentRead-Onlyuser_Read-OnlyuserRead-Onlywindow_Read-OnlywindowRead-Onlywm_Read-OnlywmAdds an external constraint to the window.
The constraint object is referenced by the window, so the caller should release its own reference when no longer needed.
SignalconnectSignalconnect_SignalemitIf 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.
Called for each window which is a transient parent of window
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.
Called for each window which is a transient of window (transitively)
Returns the Meta.WindowClientType of the window.
The root ancestor window
the object path
the application ID
the object path
the object path
the theme variant or null
the unique name
the object path
Returns the window id associated with window.
The window id
Gets the maximum size allowed for this window, if set by the client application, or to 0 if not.
Returns true if the maximum size is known.
Gets the current maximization state of the window, as combination of the Meta.MaximizeFlags.HORIZONTAL and Meta.MaximizeFlags.VERTICAL flags;
current maximization state
Gets the minimum size allowed for this window, if set by the client application, or to 0 if not.
Returns true if the minimum size is known.
Gets index of the monitor that this window is on.
The index of the monitor in the screens monitor list, or -1 if the window has been recently unmanaged and does not have a monitor.
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.
the _MUTTER_HINTS string, or null if no hints are set.
Returns the pid of the process that created this window, if available to the windowing system.
Note that the value returned by this is vulnerable to spoofing attacks by the client.
the pid, or 0 if not known.
Gets an unique id for a sandboxed app (currently flatpaks and snaps are supported).
the sandboxed application ID or null
The stable sequence number is a monotonicially increasing unique integer assigned to each Meta.Window upon creation.
This number can be useful for sorting windows in a stable fashion.
Internal sequence number for this window
Get a tag associated to the window.
Under wayland the tag can be set using the toplevel tag protocol,
and under x11 it falls back to using NET_WM_WINDOW_TAG atom.
An associated toplevel tag
Returns the matching tiled window on the same monitor as window. This is
the topmost tiled window in a complementary tile mode that is:
the matching tiled window or null if it doesn't exist.
the current title of the window.
Returns the Meta.Window 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.
the window this window is transient for, or null if the WM_TRANSIENT_FOR hint is unset or does not point to a toplevel window that Mutter knows about.
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.
The last time the user interacted with this window.
Return the current value of the name part of WM_CLASS X property.
the current value of the name part of WM_CLASS X property
Return the current value of the instance part of WM_CLASS X property.
the current value of the instance part of WM_CLASS X property.
Gets the Meta.Workspace that the window is currently displayed on.
If the window is on all workspaces, returns the currently active workspace.
the Meta.Workspace for the window
Tests if window has any transients attached to it.
If the attach_modal_dialogs option is not enabled, this will
always return false.
whether window has attached transients
Hides this window from any window list, like taskbars, pagers...
Inhibits the mapped state of the window.
Initializes the object implementing the interface.
This method is intended for language bindings. If writing in C,
g_initable_new() should typically be used instead.
The object must be initialized before any real use after initial
construction, either with this function or g_async_initable_init_async().
Implementations may also support cancellation. If cancellable is not null,
then initialization can be cancelled by triggering the cancellable object
from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null and
the object doesn't support cancellable initialization the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
If the object is not initialized, or initialization returns with an
error, then all operations on the object except g_object_ref() and
g_object_unref() are considered to be invalid, and have undefined
behaviour. See the [description][iface@Gio.Initable#description] for more details.
Callers should not assume that a class which implements Gio.Initable can be
initialized multiple times, unless the class explicitly documents itself as
supporting this. Generally, a class’ implementation of init() can assume
(and assert) that it will only be called once. Previously, this documentation
recommended all Gio.Initable implementations should be idempotent; that
recommendation was relaxed in GLib 2.54.
If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.
One reason why a class might need to support idempotent initialization is if
it is designed to be used via the singleton pattern, with a
GObject.ObjectClass.constructor that sometimes returns an existing instance.
In this pattern, a caller would expect to be able to call g_initable_init()
on the result of g_object_new(), regardless of whether it is in fact a new
instance.
optional Gio.Cancellable object, null to ignore.
true if successful. If an error has occurred, this function will return false and set error appropriately if present.
Tests if window should be attached to its parent window.
If the attach_modal_dialogs option is not enabled, this will
always return false.
whether window should be attached to its parent
true if the window is currently fullscreen
Returns whether the mapped state of the window is inhibited.
true if the window is maximized vertically and horizontally.
true if the window is occupies an entire monitor or the whole screen.
true if the window is on the primary monitor
true if this window isn't managed by mutter; it will control its own positioning and mutter won't draw decorations among other things. In X terminology this is "override redirect".
true if this window originates from a host different from the one running mutter.
true if the window is occupies the the whole screen (all monitors).
Gets whether this window should be ignored by task lists.
true if the skip bar hint is set.
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().
bool to indicate whether or not this is a user operation
desired x pos
desired y pos
Resizes the window so that its outer bounds (including frame) fit within the given rect
bool to indicate whether or not this is a user operation
new x
new y
desired width
desired height
Moves the window to the monitor with index monitor, keeping
the relative position of the window's top left corner.
desired monitor index
Raises a window and marks it as the most recently used window on the
workspace target_workspace. If the window exists on all workspaces, it will
become the most recently used sticky window on all other workspaces. This
ensures proper tracking among windows on all workspaces while not overriding
MRU for other windows.
the Meta.Workspace to raise and make it most recent on
Removes a previously added external constraint from the window.
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.
Shows again this window in window lists, like taskbars, pagers...
true if window would be visible, if its workspace was current
Transform the coordinates from stage coordinates to protocol coordinates
x Mtk.Rectangle in stage coordinate space
Uninhibits the mapped state of the window.
Virtualvfunc_Initializes the object implementing the interface.
This method is intended for language bindings. If writing in C,
g_initable_new() should typically be used instead.
The object must be initialized before any real use after initial
construction, either with this function or g_async_initable_init_async().
Implementations may also support cancellation. If cancellable is not null,
then initialization can be cancelled by triggering the cancellable object
from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null and
the object doesn't support cancellable initialization the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
If the object is not initialized, or initialization returns with an
error, then all operations on the object except g_object_ref() and
g_object_unref() are considered to be invalid, and have undefined
behaviour. See the [description][iface@Gio.Initable#description] for more details.
Callers should not assume that a class which implements Gio.Initable can be
initialized multiple times, unless the class explicitly documents itself as
supporting this. Generally, a class’ implementation of init() can assume
(and assert) that it will only be called once. Previously, this documentation
recommended all Gio.Initable implementations should be idempotent; that
recommendation was relaxed in GLib 2.54.
If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.
One reason why a class might need to support idempotent initialization is if
it is designed to be used via the singleton pattern, with a
GObject.ObjectClass.constructor that sometimes returns an existing instance.
In this pattern, a caller would expect to be able to call g_initable_init()
on the result of g_object_new(), regardless of whether it is in fact a new
instance.
optional Gio.Cancellable object, null to ignore.
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
This function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
data to associate with that key
Sets a property on an object.
The name of the property to set
The value to set the property to
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
Static_Staticcompat_Staticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
A display-agnostic abstraction for a window.
Meta.Window is the core abstraction in Mutter of a window. It has the properties you'd expect, such as a title, whether it's fullscreen, has decorations, etc.
Since a lot of different kinds of windows exist, each window also a Meta.WindowType which denotes which kind of window we're exactly dealing with. For example, one expects slightly different behaviour from a dialog than a "normal" window. The type of a window can be queried with Meta.Window.get_window_type.
Common API for windows include:
Each Meta.Window is part of either one or all Meta.Workspaces of the desktop. You can activate a window on a certain workspace using Meta.Window.activate_with_workspace, and query on which workspace it is located using Meta.Window.located_on_workspace. The workspace it is part of can be obtained using Meta.Window.get_workspace.
Each display protocol should make a subclass to be compatible with that protocols' specifics, for example
MetaWindowX11andMetaWindowWayland. This is independent of the protocol that the client uses, which is modeled using the Meta.WindowClientType enum.To integrate within the Clutter scene graph, which deals with the actual rendering, each Meta.Window will be part of a Meta.WindowActor.