Wnck.Handle¶

Subclasses:: None

Methods¶

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

class	`new` (client_type)
	`get_application` (xwindow)
	`get_class_group` (id)
	`get_default_screen` ()
	`get_screen` (index)
	`get_screen_for_root` (root_window_id)
	`get_window` (xwindow)
	`set_default_icon_size` (icon_size)
	`set_default_mini_icon_size` (icon_size)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`client-type`	`Wnck.ClientType`	r/w/c	client-type

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Wnck.Handle(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Wnck.HandleClass

The Wnck.Handle struct contains only private fields and should not be directly accessed.

classmethod new(client_type)¶

Parameters:: client_type (Wnck.ClientType) – a role for the client
Returns:: newly created Wnck.Handle.
Return type:: Wnck.Handle

Creates a new Wnck.Handle object with a given client_type.

get_application(xwindow)¶

Parameters:: xwindow (int) – the X window ID of a group leader.
Returns:: the Wnck.Application corresponding to xwindow, or None if there no such Wnck.Application could be found. The returned Wnck.Application is owned by libwnck and must not be referenced or unreferenced.
Return type:: Wnck.Application

Gets the Wnck.Application corresponding to the group leader with xwindow as X window ID.

get_class_group(id)¶

Parameters:: id (str) – identifier name of the sought resource class.
Returns:: the Wnck.ClassGroup corresponding to id, or None if there is no Wnck.ClassGroup with the specified id. The returned Wnck.ClassGroup is owned by libwnck and must not be referenced or unreferenced.
Return type:: Wnck.ClassGroup

Gets the Wnck.ClassGroup corresponding to id.

get_default_screen()¶

Returns:: the default Wnck.Screen. The returned Wnck.Screen is owned by Wnck.Handle and must not be referenced or unreferenced. This can return None if not on X11.
Return type:: Wnck.Screen or None

Gets the default Wnck.Screen on the default display.

get_screen(index)¶

Parameters:: index (int) – screen number, starting from 0.
Returns:: the Wnck.Screen for screen index, or None if no such screen exists. The returned Wnck.Screen is owned by Wnck.Handle and must not be referenced or unreferenced.
Return type:: Wnck.Screen

Gets the Wnck.Screen for a given screen on the default display.

get_screen_for_root(root_window_id)¶

Parameters:: root_window_id (int) – an X window ID.
Returns:: the Wnck.Screen for the root window at root_window_id, or None. The returned Wnck.Screen is owned by Wnck.Handle and must not be referenced or unreferenced.
Return type:: Wnck.Screen

Gets the Wnck.Screen for the root window at root_window_id, or None if no Wnck.Screen exists for this root window.

This function does not work if Wnck.Handle.get_screen() was not called for the sought Wnck.Screen before, and returns None.

get_window(xwindow)¶

Parameters:: xwindow (int) – an X window ID.
Returns:: the Wnck.Window for xwindow. The returned Wnck.Window is owned by libwnck and must not be referenced or unreferenced.
Return type:: Wnck.Window

Gets a preexisting Wnck.Window for the X window xwindow. This will not create a Wnck.Window if none exists. The function is robust against bogus window IDs.

set_default_icon_size(icon_size)¶

Parameters:: icon_size (int) – the default size for windows and application standard icons.

The default main icon size is Wnck.DEFAULT_ICON_SIZE. This function allows to change this value.

set_default_mini_icon_size(icon_size)¶

Parameters:: icon_size (int) – the default size for windows and application mini icons.

The default main icon size is Wnck.DEFAULT_MINI_ICON_SIZE. This function allows to change this value.

Property Details¶

Wnck.Handle.props.client_type¶

Name:: client-type
Type:: Wnck.ClientType
Default Value:: Wnck.ClientType.APPLICATION
Flags:: READABLE, WRITABLE, CONSTRUCT

client-type