Functions

  pid_read_resource_usage (gdk_display, pid, usage)
  set_client_type (ewmh_sourceindication_client_type)
  set_default_icon_size (size)
  set_default_mini_icon_size (size)
  shutdown ()
  xid_read_resource_usage (gdk_display, xid, usage)

Details

Wnck.pid_read_resource_usage(gdk_display, pid, usage)
Parameters:

Looks for the X resource usage of the application with process ID pid on display gdisplay. If no resource usage can be found, then all fields of usage are set to 0.

In order to find the resource usage of an application that does not have an X window visible to libwnck (panel applets do not have any toplevel windows, for example), Wnck.pid_read_resource_usage() walks through the whole tree of X windows. Since this walk is expensive in CPU, a cache is created. This cache is updated in the background. This means there is a non-null probability that no resource usage will be found for an application, even if it is an X client. If this happens, calling Wnck.pid_read_resource_usage() again after a few seconds should work.

To properly work, this function requires the XRes extension on the X server.

New in version 2.6.

Wnck.set_client_type(ewmh_sourceindication_client_type)
Parameters:ewmh_sourceindication_client_type (Wnck.ClientType) – a role for the client.

Sets the role of the libwnck user.

The default role is Wnck.ClientType.APPLICATION. Therefore, for applications providing some window management features, like pagers or tasklists, it is important to set the role to Wnck.ClientType.PAGER for libwnck to properly work.

This function should only be called once per program. Additional calls with the same client type will be silently ignored. An attempt to change the client type to a differnet value after it has already been set will be ignored and a critical warning will be logged.

New in version 2.14.

Wnck.set_default_icon_size(size)
Parameters: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.

New in version 2.4.6.

Wnck.set_default_mini_icon_size(size)
Parameters: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.

New in version 2.4.6.

Wnck.shutdown()

Makes libwnck stop listening to events and tear down all resources from libwnck. This should be done if you are not going to need the state change notifications for an extended period of time, to avoid wakeups with every key and focus event.

After this, all pointers to Wnck object you might still hold are invalid.

Due to the fact that ‘Wnck objects are all owned by libwnck [getting-started.pitfalls.memory-management]’, users of this API through introspection should be extremely careful: they must explicitly clear variables referencing objects before this call. Failure to do so might result in crashes.

New in version 3.4.

Wnck.xid_read_resource_usage(gdk_display, xid, usage)
Parameters:

Looks for the X resource usage of the application owning the X window ID xid on display gdisplay. If no resource usage can be found, then all fields of usage are set to 0.

To properly work, this function requires the XRes extension on the X server.

New in version 2.6.