Libxfce4windowing.Window¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`activate` (seat, event_timestamp)
	`close` (event_timestamp)
	`get_application` ()
	`get_capabilities` ()
	`get_class_ids` ()
	`get_geometry` ()
	`get_gicon` ()
	`get_icon` (size, scale)
	`get_monitors` ()
	`get_name` ()
	`get_screen` ()
	`get_state` ()
	`get_window_type` ()
	`get_workspace` ()
	`icon_is_fallback` ()
	`is_above` ()
	`is_active` ()
	`is_below` ()
	`is_fullscreen` ()
	`is_in_viewport` (workspace)
	`is_maximized` ()
	`is_minimized` ()
	`is_on_workspace` (workspace)
	`is_pinned` ()
	`is_shaded` ()
	`is_skip_pager` ()
	`is_skip_tasklist` ()
	`is_urgent` ()
	`move_to_workspace` (workspace)
	`set_above` (is_above)
	`set_below` (is_below)
	`set_button_geometry` (relative_to, rect)
	`set_fullscreen` (is_fullscreen)
	`set_geometry` (rect)
	`set_maximized` (is_maximized)
	`set_minimized` (is_minimized)
	`set_pinned` (is_pinned)
	`set_shaded` (is_shaded)
	`set_skip_pager` (is_skip_pager)
	`set_skip_tasklist` (is_skip_tasklist)
	`start_move` ()
	`start_resize` ()
	`x11_get_xid` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`application`	`Libxfce4windowing.Application`	r	application
`capabilities`	`Libxfce4windowing.WindowCapabilities`	r	capabilities
`class-ids`	[`str`]	r	class-ids
`gicon`	`Gio.Icon`	r	gicon
`monitors`	`int`	r	monitors
`name`	`str`	r	name
`screen`	`Libxfce4windowing.Screen`	r/w/co	screen
`state`	`Libxfce4windowing.WindowState`	r	state
`type`	`Libxfce4windowing.WindowType`	r	type
`workspace`	`Libxfce4windowing.Workspace`	r	workspace

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`capabilities-changed`	Emitted when window's capabilities change.
`class-changed`	Emitted when at least one of the window's class ids changes.
`closed`	Emitted when window is closed.
`geometry-changed`	Emitted when window's position or size changes.
`icon-changed`	Emitted when window's icon changes.
`name-changed`	Emitted when window's name/title changes.
`state-changed`	Emitted when window's state changes.
`type-changed`	Emitted when window's type changes.
`workspace-changed`	Emitted when window is moved to a different worksapce.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Libxfce4windowing.Window(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: Libxfce4windowing.WindowClass

activate(seat, event_timestamp)¶

Parameters:

seat (Libxfce4windowing.Seat) –
event_timestamp (int) –

Raises:

GLib.Error

Return type:

bool

close(event_timestamp)¶

Parameters:: event_timestamp (int) –
Raises:: GLib.Error
Return type:: bool

get_application()¶

Returns:: An Libxfce4windowing.Application instance, with a reference owned by self.
Return type:: Libxfce4windowing.Application

Fetches self's application.

get_capabilities()¶

Returns:: a bitfield with zero or more bits from Libxfce4windowing.WindowCapabilities set.
Return type:: Libxfce4windowing.WindowCapabilities

Fetches self's capabilities bitfield.

get_class_ids()¶

Returns:: a None-terminated array of strings owned by the Libxfce4windowing.Window.
Return type:: [str]

Fetches self's class ids. On X11 this should contain the class and instance names of the WM_CLASS property. On Wayland, it’s likely to be limited to the application ID, which should correspond to the basename of the application’s desktop file.

New in version 4.19.3.

get_geometry()¶

Returns:: A Gdk.Rectangle representing self's geometry, which should not be modified or freed.
Return type:: Gdk.Rectangle

Fetches self's position and size.

get_gicon()¶

Returns:: a Gio.Icon, owned by self.
Return type:: Gio.Icon

Fetches self's icon as a size-independent Gio.Icon. If an icon cannot be found, a Gio.Icon representing a fallback icon will be returned. Whether or not the returned icon is a fallback icon can be determined using Libxfce4windowing.Window.icon_is_fallback().

New in version 4.19.1.

get_icon(size, scale)¶

Parameters:

size (int) – the desired icon size.
scale (int) – the UI scale factor.

Returns:

a GdkPixbuf.Pixbuf, owned by self, or None if self has no icon and a fallback cannot be rendered.

Return type:

GdkPixbuf.Pixbuf or None

Fetches self's icon. If self has no icon, a fallback icon may be returned. Whether or not the returned icon is a fallback icon can be determined using Libxfce4windowing.Window.icon_is_fallback().

get_monitors()¶

Returns:: A list of Libxfce4windowing.Monitor instances, or None. The list and its contents are owned by self and should not be modified or freed.
Return type:: [Libxfce4windowing.Monitor] or None

Fetches the list of monitors self is displayed on, if any.

get_name()¶

Returns:: a window title, or None if there is no title. The returned title should not be modified or freed.
Return type:: str or None

Fetches self's name/title.

get_screen()¶

Returns:: A Libxfce4windowing.Screen instance, with a reference owned by self.
Return type:: object

Fetches the Libxfce4windowing.Screen instance that owns self.

get_state()¶

Returns:: a bitfield with zero or more bits from Libxfce4windowing.WindowState set.
Return type:: Libxfce4windowing.WindowState

Fetches self's state bitfield.

get_window_type()¶

Return type:: Libxfce4windowing.WindowType

get_workspace()¶

Returns:: A Libxfce4windowing.Workspace instance, with a reference owned by self, or None.
Return type:: Libxfce4windowing.Workspace or None

Fetches self's workspace, if any. This may return None if self is not on a workspace, or is pinned to all workspaces.

icon_is_fallback()¶

Returns:: True or False, depending on if self's icon uses a fallback icon or not.
Return type:: bool

Determines if self does not have an icon, and thus a fallback icon will be returned from Libxfce4windowing.Window.get_icon() and Libxfce4windowing.Window.get_gicon().

New in version 4.19.1.

is_above()¶

Return type:: bool

is_active()¶

Return type:: bool

is_below()¶

Return type:: bool

is_fullscreen()¶

Return type:: bool

is_in_viewport(workspace)¶

Parameters:: workspace (Libxfce4windowing.Workspace) –
Return type:: bool

is_maximized()¶

Return type:: bool

is_minimized()¶

Return type:: bool

is_on_workspace(workspace)¶

Parameters:: workspace (Libxfce4windowing.Workspace) –
Return type:: bool

is_pinned()¶

Return type:: bool

is_shaded()¶

Return type:: bool

is_skip_pager()¶

Return type:: bool

is_skip_tasklist()¶

Return type:: bool

is_urgent()¶

Return type:: bool

move_to_workspace(workspace)¶

Parameters:: workspace (Libxfce4windowing.Workspace) –
Raises:: GLib.Error
Return type:: bool

set_above(is_above)¶

Parameters:: is_above (bool) –
Raises:: GLib.Error
Return type:: bool

set_below(is_below)¶

Parameters:: is_below (bool) –
Raises:: GLib.Error
Return type:: bool

set_button_geometry(relative_to, rect)¶

Parameters:

relative_to (Gdk.Window) –
rect (Gdk.Rectangle) –

Raises:

GLib.Error

Return type:

bool

set_fullscreen(is_fullscreen)¶

Parameters:: is_fullscreen (bool) –
Raises:: GLib.Error
Return type:: bool

set_geometry(rect)¶

Parameters:: rect (Gdk.Rectangle) –
Raises:: GLib.Error
Return type:: bool

set_maximized(is_maximized)¶

Parameters:: is_maximized (bool) –
Raises:: GLib.Error
Return type:: bool

set_minimized(is_minimized)¶

Parameters:: is_minimized (bool) –
Raises:: GLib.Error
Return type:: bool

set_pinned(is_pinned)¶

Parameters:: is_pinned (bool) –
Raises:: GLib.Error
Return type:: bool

set_shaded(is_shaded)¶

Parameters:: is_shaded (bool) –
Raises:: GLib.Error
Return type:: bool

set_skip_pager(is_skip_pager)¶

Parameters:: is_skip_pager (bool) –
Raises:: GLib.Error
Return type:: bool

set_skip_tasklist(is_skip_tasklist)¶

Parameters:: is_skip_tasklist (bool) –
Raises:: GLib.Error
Return type:: bool

start_move()¶

Raises:: GLib.Error
Return type:: bool

start_resize()¶

Raises:: GLib.Error
Return type:: bool

x11_get_xid()¶

Return type:: int

Signal Details¶

Libxfce4windowing.Window.signals.capabilities_changed(window, changed_mask, new_state)¶

Signal Name:

capabilities-changed

Flags:

RUN_LAST

Parameters:

window (Libxfce4windowing.Window) – The object which received the signal
changed_mask (Libxfce4windowing.WindowCapabilities) – bitfield representing which state bits have changed.
new_state (Libxfce4windowing.WindowCapabilities) – the new state bitfield.

Emitted when window's capabilities change.

Libxfce4windowing.Window.signals.class_changed(window)¶

Signal Name:: class-changed
Flags:: RUN_LAST
Parameters:: window (Libxfce4windowing.Window) – The object which received the signal

Emitted when at least one of the window's class ids changes.

New in version 4.19.3.

Libxfce4windowing.Window.signals.closed(window)¶

Signal Name:: closed
Flags:: RUN_LAST
Parameters:: window (Libxfce4windowing.Window) – The object which received the signal

Emitted when window is closed.

Libxfce4windowing.Window.signals.geometry_changed(window)¶

Signal Name:: geometry-changed
Flags:: RUN_LAST
Parameters:: window (Libxfce4windowing.Window) – The object which received the signal

Emitted when window's position or size changes.

Libxfce4windowing.Window.signals.icon_changed(window)¶

Signal Name:: icon-changed
Flags:: RUN_LAST
Parameters:: window (Libxfce4windowing.Window) – The object which received the signal

Emitted when window's icon changes.

Libxfce4windowing.Window.signals.name_changed(window)¶

Signal Name:: name-changed
Flags:: RUN_LAST
Parameters:: window (Libxfce4windowing.Window) – The object which received the signal

Emitted when window's name/title changes.

Libxfce4windowing.Window.signals.state_changed(window, changed_mask, new_state)¶

Signal Name:

state-changed

Flags:

RUN_LAST

Parameters:

window (Libxfce4windowing.Window) – The object which received the signal
changed_mask (Libxfce4windowing.WindowState) – bitfield representing which state bits have changed.
new_state (Libxfce4windowing.WindowState) – the new state bitfield.

Emitted when window's state changes.

Libxfce4windowing.Window.signals.type_changed(window, old_type)¶

Signal Name:

type-changed

Flags:

RUN_LAST

Parameters:

window (Libxfce4windowing.Window) – The object which received the signal
old_type (Libxfce4windowing.WindowType) – the previous window type.

Emitted when window's type changes.

Libxfce4windowing.Window.signals.workspace_changed(window)¶

Signal Name:: workspace-changed
Flags:: RUN_LAST
Parameters:: window (Libxfce4windowing.Window) – The object which received the signal

Emitted when window is moved to a different worksapce.

Property Details¶

Libxfce4windowing.Window.props.application¶

Name:: application
Type:: Libxfce4windowing.Application
Default Value:: None
Flags:: READABLE

The Libxfce4windowing.Application that owns this window.

Libxfce4windowing.Window.props.capabilities¶

Name:: capabilities
Type:: Libxfce4windowing.WindowCapabilities
Default Value:: Libxfce4windowing.WindowCapabilities.NONE
Flags:: READABLE

The window’s capabilities bitfield.

Libxfce4windowing.Window.props.class_ids¶

Name:: class-ids
Type:: [str]
Default Value:: []
Flags:: READABLE

The window’s class ids.

New in version 4.19.3.

Libxfce4windowing.Window.props.gicon¶

Name:: gicon
Type:: Gio.Icon
Default Value:: None
Flags:: READABLE

The Gio.Icon that represents this window.

Libxfce4windowing.Window.props.monitors¶

Name:: monitors
Type:: int
Default Value:: None
Flags:: READABLE

The list of Libxfce4windowing.Monitor s (if any) that the window is displayed on.

Libxfce4windowing.Window.props.name¶

Name:: name
Type:: str
Default Value:: ''
Flags:: READABLE

The window’s name or title.

Libxfce4windowing.Window.props.screen¶

Name:: screen
Type:: Libxfce4windowing.Screen
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The Libxfce4windowing.Screen instances that owns this window.

Libxfce4windowing.Window.props.state¶

Name:: state
Type:: Libxfce4windowing.WindowState
Default Value:: Libxfce4windowing.WindowState.NONE
Flags:: READABLE

The window’s state bitfield.

Libxfce4windowing.Window.props.type¶

Name:: type
Type:: Libxfce4windowing.WindowType
Default Value:: Libxfce4windowing.WindowType.NORMAL
Flags:: READABLE

The window’s type or function.

Libxfce4windowing.Window.props.workspace¶

Name:: workspace
Type:: Libxfce4windowing.Workspace
Default Value:: None
Flags:: READABLE

workspace