Wnck.Tasklist

g Atk.ImplementorIface Atk.ImplementorIface Gtk.Widget Gtk.Widget Atk.ImplementorIface->Gtk.Widget GObject.GInterface GObject.GInterface GObject.GInterface->Atk.ImplementorIface Gtk.Buildable Gtk.Buildable GObject.GInterface->Gtk.Buildable GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Gtk.Widget GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gtk.Buildable->Gtk.Widget Gtk.Container Gtk.Container Wnck.Tasklist Wnck.Tasklist Gtk.Container->Wnck.Tasklist Gtk.Widget->Gtk.Container

Subclasses:

None

Methods

Inherited:

Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10)

Structs:

Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class

new ()

class

new_with_handle (handle)

get_scroll_enabled ()

get_size_hint_list (n_elements)

set_button_relief (relief)

set_grouping (grouping)

set_grouping_limit (limit)

set_include_all_workspaces (include_all_workspaces)

set_middle_click_close (middle_click_close)

set_orientation (orient)

set_scroll_enabled (scroll_enabled)

set_switch_workspace_on_unminimize (switch_workspace_on_unminimize)

Virtual Methods

Inherited:

Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10)

Properties

Inherited:

Gtk.Container (3), Gtk.Widget (39)

Name

Type

Flags

Short Description

handle

Wnck.Handle

r/w/co/en

handle

Style Properties

Inherited:

Gtk.Widget (17)

Name

Type

Default

Flags

Short Description

fade-loop-time

float

3.0

r

The time one loop takes when fading, in seconds. Default: 3.0

fade-max-loops

int

5

r

The number of fading loops. 0 means the button will only fade to the final color. Default: 5

fade-opacity

float

0.800000011920929

r

The final opacity that will be reached. Default: 0.8

fade-overlay-rect

bool

True

r

Compatibility mode for pixbuf engine themes that cannot react to color changes. If enabled, a rectangle with the correct color will be drawn on top of the button. Default: True

Signals

Inherited:

Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name

Short Description

task-enter-notify

Emitted when the task is entered.

task-leave-notify

Emitted when the task is entered.

Fields

Inherited:

Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name

Type

Access

Description

parent_instance

Gtk.Container

r

Class Details

class Wnck.Tasklist(**kwargs)
Bases:

Gtk.Container

Abstract:

No

Structure:

Wnck.TasklistClass

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

classmethod new()
Returns:

a newly created Wnck.Tasklist.

Return type:

Gtk.Widget

Creates a new Wnck.Tasklist. The Wnck.Tasklist will list Wnck.Window of the Wnck.Screen it is on.

classmethod new_with_handle(handle)
Parameters:

handle (Wnck.Handle) – a Wnck.Handle

Returns:

a newly created Wnck.Tasklist.

Return type:

Gtk.Widget

Creates a new Wnck.Tasklist. The Wnck.Tasklist will list Wnck.Window of the Wnck.Screen it is on.

get_scroll_enabled()
Return type:

bool

Gets the scroll behavior of the self.

New in version 3.24.0.

get_size_hint_list(n_elements)
Parameters:

n_elements (int) – return location for the number of elements in the array returned by this function. This number should always be pair.

Returns:

a list of size hints that can be used to allocate an appropriate size for self.

Return type:

int

Since a Wnck.Tasklist does not have a fixed size (Wnck.Window can be grouped when needed, for example), the standard size request mechanism in GTK+ is not enough to announce what sizes can be used by self. The size hints mechanism is a solution for this. See panel_applet_set_size_hints() for more information.

Deprecated since version 3.42: Use minimum and natural size instead.

set_button_relief(relief)
Parameters:

relief (Gtk.ReliefStyle) – a relief type.

Sets the relief type of the buttons in self to relief. The main use of this function is proper integration of Wnck.Tasklist in panels with non-system backgrounds.

New in version 2.12.

set_grouping(grouping)
Parameters:

grouping (Wnck.TasklistGroupingType) – a grouping policy.

Sets the grouping policy for self to grouping.

set_grouping_limit(limit)
Parameters:

limit (int) – a size in pixels.

Sets the maximum size of buttons in self before self tries to group Wnck.Window in the same Wnck.Application in only one button. This limit is valid only when the grouping policy of self is Wnck.TasklistGroupingType.AUTO_GROUP.

set_include_all_workspaces(include_all_workspaces)
Parameters:

include_all_workspaces (bool) – whether to display Wnck.Window from all Wnck.Workspace in self.

Sets self to display Wnck.Window from all Wnck.Workspace or not, according to include_all_workspaces.

Note that if the active Wnck.Workspace has a viewport and if include_all_workspaces is False, then only the Wnck.Window visible in the viewport are displayed in self. The rationale for this is that the viewport is generally used to implement workspace-like behavior. A side-effect of this is that, when using multiple Wnck.Workspace with viewport, it is not possible to show all Wnck.Window from a Wnck.Workspace (even those that are not visible in the viewport) in self without showing all Wnck.Window from all Wnck.Workspace.

set_middle_click_close(middle_click_close)
Parameters:

middle_click_close (bool) – whether to close windows with middle click on button.

Sets self to close windows with mouse middle click on button, according to middle_click_close.

New in version 3.4.6.

set_orientation(orient)
Parameters:

orient (Gtk.Orientation) – a Gtk.Orientation.

Set the orientation of the self to match orient. This function can be used to integrate a Wnck.Tasklist in vertical panels.

New in version 3.4.6.

set_scroll_enabled(scroll_enabled)
Parameters:

scroll_enabled (bool) – a boolean.

Sets the scroll behavior of the self. When set to True, a scroll event over the tasklist will change the current window accordingly.

New in version 3.24.0.

set_switch_workspace_on_unminimize(switch_workspace_on_unminimize)
Parameters:

switch_workspace_on_unminimize (bool) – whether to activate the Wnck.Workspace a Wnck.Window is on when unminimizing it.

Sets self to activate or not the Wnck.Workspace a Wnck.Window is on when unminimizing it, according to switch_workspace_on_unminimize.

FIXME: does it still work?

Signal Details

Wnck.Tasklist.signals.task_enter_notify(tasklist, windows)
Signal Name:

task-enter-notify

Flags:

RUN_LAST

Parameters:

Emitted when the task is entered.

Wnck.Tasklist.signals.task_leave_notify(tasklist, windows)
Signal Name:

task-leave-notify

Flags:

RUN_LAST

Parameters:

Emitted when the task is entered.

Property Details

Wnck.Tasklist.props.handle
Name:

handle

Type:

Wnck.Handle

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY, EXPLICIT_NOTIFY

handle