Class: Wnck::Handle

Inherits:

Object

• Object
• Wnck::Handle

Defined in:

(unknown)

Instance Method Summary

• #client_type ⇒ Wnck::ClientType

  Client-type.

• #client_type=(client_type) ⇒ Wnck::ClientType
• #default_icon_size=(icon_size) ⇒ nil

  The default main icon size is %WNCK_DEFAULT_ICON_SIZE.

• #default_mini_icon_size=(icon_size) ⇒ nil

  The default main icon size is %WNCK_DEFAULT_MINI_ICON_SIZE.

• #default_screen ⇒ Wnck::Screen

  Gets the default Wnck::Screen on the default display.

• #get_application(xwindow) ⇒ Wnck::Application

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

• #get_class_group(id) ⇒ Wnck::ClassGroup

  Gets the Wnck::ClassGroup corresponding to id.

• #get_screen(index) ⇒ Wnck::Screen

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

• #get_screen_for_root(root_window_id) ⇒ Wnck::Screen

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

• #get_window(xwindow) ⇒ Wnck::Window

  Gets a preexisting Wnck::Window for the X window xwindow.

• #initialize(client_type) ⇒ Wnck::Handle constructor

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

Constructor Details

#initialize(client_type) ⇒ Wnck::Handle

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

Parameters:

• client_type (Wnck::ClientType) —

  a role for the client

Instance Method Details

#client_type ⇒ Wnck::ClientType

Returns client-type.

Returns:

• (Wnck::ClientType) —

  client-type

#client_type=(client_type) ⇒ Wnck::ClientType

Parameters:

• client_type (Wnck::ClientType)

Returns:

• (Wnck::ClientType) —

  client-type

• (Wnck::ClientType) —

  client-type

#default_icon_size=(icon_size) ⇒ nil

The default main icon size is %WNCK_DEFAULT_ICON_SIZE. This function allows to change this value.

Parameters:

• icon_size (Integer) —

  the default size for windows and application standard icons.

Returns:

• (nil)

#default_mini_icon_size=(icon_size) ⇒ nil

The default main icon size is %WNCK_DEFAULT_MINI_ICON_SIZE. This function allows to change this value.

Parameters:

• icon_size (Integer) —

  the default size for windows and application mini icons.

Returns:

• (nil)

#default_screen ⇒ Wnck::Screen

Gets the default Wnck::Screen on the default display. returned Wnck::Screen is owned by #WnckHandle and must not be referenced or unreferenced. This can return nil if not on X11.

Returns:

• (Wnck::Screen) —

  the default Wnck::Screen. The

#get_application(xwindow) ⇒ Wnck::Application

Gets the Wnck::Application corresponding to the group leader with xwindow as X window ID. xwindow, or nil if there no such Wnck::Application could be found. The returned Wnck::Application is owned by libwnck and must not be referenced or unreferenced.

Parameters:

• xwindow (Wnck::gulong) —

  the X window ID of a group leader.

Returns:

• (Wnck::Application) —

  the Wnck::Application corresponding to

#get_class_group(id) ⇒ Wnck::ClassGroup

Gets the Wnck::ClassGroup corresponding to id. id, or nil 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.

Parameters:

• id (String) —

  identifier name of the sought resource class.

Returns:

• (Wnck::ClassGroup) —

  the Wnck::ClassGroup corresponding to

#get_screen(index) ⇒ Wnck::Screen

Gets the Wnck::Screen for a given screen on the default display. if no such screen exists. The returned Wnck::Screen is owned by #WnckHandle and must not be referenced or unreferenced.

Parameters:

• index (Integer) —

  screen number, starting from 0.

Returns:

• (Wnck::Screen) —

  the Wnck::Screen for screen index, or nil

#get_screen_for_root(root_window_id) ⇒ Wnck::Screen

Gets the Wnck::Screen for the root window at root_window_id, or nil 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 nil. root_window_id, or nil. The returned Wnck::Screen is owned by Wnck::Handle and must not be referenced or unreferenced.

Parameters:

• root_window_id (Wnck::gulong) —

  an X window ID.

Returns:

• (Wnck::Screen) —

  the Wnck::Screen for the root window at

#get_window(xwindow) ⇒ 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. Wnck::Window is owned by libwnck and must not be referenced or unreferenced.

Parameters:

• xwindow (Wnck::gulong) —

  an X window ID.

Returns:

• (Wnck::Window) —

  the Wnck::Window for xwindow. The returned