Bamf.View¶

Subclasses:: Bamf.Application, Bamf.Tab, Bamf.Window

Methods¶

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

	`get_children` ()
	`get_click_suggestion` ()
	`get_icon` ()
	`get_name` ()
	`get_view_type` ()
	`has_child` (child)
	`is_active` ()
	`is_closed` ()
	`is_running` ()
	`is_starting` ()
	`is_sticky` ()
	`is_urgent` ()
	`is_user_visible` ()
	`peek_children` ()
	`set_sticky` (value)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_active_changed` (active)
	`do_child_added` (child)
	`do_child_moved` (child)
	`do_child_removed` (child)
	`do_click_behavior` ()
	`do_closed` ()
	`do_get_children` ()
	`do_get_icon` ()
	`do_get_name` ()
	`do_icon_changed` (icon)
	`do_is_active` ()
	`do_is_running` ()
	`do_is_starting` ()
	`do_is_urgent` ()
	`do_is_user_visible` ()
	`do_name_changed` (old_name, new_name)
	`do_running_changed` (running)
	`do_set_path` (path)
	`do_set_sticky` (value)
	`do_starting_changed` (starting)
	`do_urgent_changed` (urgent)
	`do_user_visible_changed` (user_visible)
	`do_view_type` ()

Properties¶

Name	Type	Flags	Short Description
`active`	`bool`	r	active
`path`	`str`	r	path
`running`	`bool`	r	running
`starting`	`bool`	r	starting
`urgent`	`bool`	r	urgent
`user-visible`	`bool`	r	user-visible

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`active-changed`
`child-added`
`child-moved`
`child-removed`
`closed`
`icon-changed`
`name-changed`
`running-changed`
`starting-changed`
`urgent-changed`
`user-visible-changed`

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.InitiallyUnowned`	r

Class Details¶

class Bamf.View(**kwargs)¶

Bases:: GObject.InitiallyUnowned
Abstract:: No
Structure:: Bamf.ViewClass

get_children()¶

Returns:: Returns a list of Bamf.View which must be freed after usage. Elements of the list are owned by bamf and should not be unreffed.
Return type:: [Bamf.View]

Note: Makes sever dbus calls the first time this is called on a view. Dbus messaging is reduced afterwards.

get_click_suggestion()¶

Return type:: Bamf.ClickBehavior

get_icon()¶

Return type:: str

Gets the icon of a view. This icon is used to visually represent the view.

get_name()¶

Return type:: str

Gets the name of a view. This name is a short name best used to represent the view with text.

get_view_type()¶

Return type:: str

The view type of a window is a short string used to represent all views of the same class. These descriptions should not be used to do casting as they are not considered stable.

has_child(child)¶

Parameters:: child (Bamf.View) –
Returns:: True whether the Bamf.View self has the specified child.
Return type:: bool

is_active()¶

Return type:: bool

Determines if the view is currently active and focused by the user. Useful for an active window indicator.

is_closed()¶

Return type:: bool

Determines if the view is closed or not.

is_running()¶

Return type:: bool

Determines if the view is currently running. Useful for a running window indicator.

is_starting()¶

Return type:: bool

Determines if the view is currently starting. Useful for the startup animation.

is_sticky()¶

Return type:: bool

is_urgent()¶

Return type:: bool

Determines if the view is currently requiring attention. Useful for a running window indicator.

is_user_visible()¶

Returns:: a boolean useful for determining if a particular view is “user visible”. User visible is a concept relating to whether or not a window should be shown in a launcher tasklist.
Return type:: bool

New in version 0.4.0.

peek_children()¶

Returns:: Returns a list of Bamf.View which is owned by the Bamf.View and should not freed or modified after usage.
Return type:: [Bamf.View]

Note: Makes sever dbus calls the first time this is called on a view. Dbus messaging is reduced afterwards.

New in version 0.5.2.

set_sticky(value)¶

Parameters:: value (bool) –

do_active_changed(active) virtual¶

Parameters:: active (bool) –

do_child_added(child) virtual¶

Parameters:: child (Bamf.View) –

do_child_moved(child) virtual¶

Parameters:: child (Bamf.View) –

do_child_removed(child) virtual¶

Parameters:: child (Bamf.View) –

do_click_behavior() virtual¶

Return type:: Bamf.ClickBehavior

do_closed() virtual¶

do_get_children() virtual¶

Returns:: Returns a list of Bamf.View which must be freed after usage. Elements of the list are owned by bamf and should not be unreffed.
Return type:: [Bamf.View]

Note: Makes sever dbus calls the first time this is called on a view. Dbus messaging is reduced afterwards.

do_get_icon() virtual¶

Return type:: str

Gets the icon of a view. This icon is used to visually represent the view.

do_get_name() virtual¶

Return type:: str

Gets the name of a view. This name is a short name best used to represent the view with text.

do_icon_changed(icon) virtual¶

Parameters:: icon (str) –

do_is_active() virtual¶

Return type:: bool

Determines if the view is currently active and focused by the user. Useful for an active window indicator.

do_is_running() virtual¶

Return type:: bool

Determines if the view is currently running. Useful for a running window indicator.

do_is_starting() virtual¶

Return type:: bool

Determines if the view is currently starting. Useful for the startup animation.

do_is_urgent() virtual¶

Return type:: bool

Determines if the view is currently requiring attention. Useful for a running window indicator.

do_is_user_visible() virtual¶

Returns:: a boolean useful for determining if a particular view is “user visible”. User visible is a concept relating to whether or not a window should be shown in a launcher tasklist.
Return type:: bool

New in version 0.4.0.

do_name_changed(old_name, new_name) virtual¶

Parameters:

old_name (str) –
new_name (str) –

do_running_changed(running) virtual¶

Parameters:: running (bool) –

do_set_path(path) virtual¶

Parameters:: path (str) –

do_set_sticky(value) virtual¶

Parameters:: value (bool) –

do_starting_changed(starting) virtual¶

Parameters:: starting (bool) –

do_urgent_changed(urgent) virtual¶

Parameters:: urgent (bool) –

do_user_visible_changed(user_visible) virtual¶

Parameters:: user_visible (bool) –

do_view_type() virtual¶

Return type:: str

The view type of a window is a short string used to represent all views of the same class. These descriptions should not be used to do casting as they are not considered stable.

Signal Details¶

Bamf.View.signals.active_changed(view, object)¶

Signal Name:

active-changed

Flags:

RUN_FIRST

Parameters:

view (Bamf.View) – The object which received the signal
object (bool) –

Bamf.View.signals.child_added(view, object)¶

Signal Name:

child-added

Flags:

RUN_FIRST

Parameters:

view (Bamf.View) – The object which received the signal
object (Bamf.View) –

Bamf.View.signals.child_moved(view, object)¶

Signal Name:

child-moved

Flags:

RUN_FIRST

Parameters:

view (Bamf.View) – The object which received the signal
object (Bamf.View) –

Bamf.View.signals.child_removed(view, object)¶

Signal Name:

child-removed

Flags:

RUN_FIRST

Parameters:

view (Bamf.View) – The object which received the signal
object (Bamf.View) –

Bamf.View.signals.closed(view)¶

Signal Name:: closed
Flags:: RUN_LAST
Parameters:: view (Bamf.View) – The object which received the signal

Bamf.View.signals.icon_changed(view, object)¶

Signal Name:

icon-changed

Flags:

Parameters:

view (Bamf.View) – The object which received the signal
object (str) –

Bamf.View.signals.name_changed(view, object, p0)¶

Signal Name:

name-changed

Flags:

Parameters:

view (Bamf.View) – The object which received the signal
object (str) –
p0 (str) –

Bamf.View.signals.running_changed(view, object)¶

Signal Name:

running-changed

Flags:

RUN_FIRST

Parameters:

view (Bamf.View) – The object which received the signal
object (bool) –

Bamf.View.signals.starting_changed(view, object)¶

Signal Name:

starting-changed

Flags:

RUN_FIRST

Parameters:

view (Bamf.View) – The object which received the signal
object (bool) –

Bamf.View.signals.urgent_changed(view, object)¶

Signal Name:

urgent-changed

Flags:

RUN_FIRST

Parameters:

view (Bamf.View) – The object which received the signal
object (bool) –

Bamf.View.signals.user_visible_changed(view, object)¶

Signal Name:

user-visible-changed

Flags:

RUN_FIRST

Parameters:

view (Bamf.View) – The object which received the signal
object (bool) –

Property Details¶

Bamf.View.props.active¶

Name:: active
Type:: bool
Default Value:: False
Flags:: READABLE

active

Bamf.View.props.path¶

Name:: path
Type:: str
Default Value:: None
Flags:: READABLE

path

Bamf.View.props.running¶

Name:: running
Type:: bool
Default Value:: False
Flags:: READABLE

running

Bamf.View.props.starting¶

Name:: starting
Type:: bool
Default Value:: False
Flags:: READABLE

starting

Bamf.View.props.urgent¶

Name:: urgent
Type:: bool
Default Value:: False
Flags:: READABLE

urgent

Bamf.View.props.user_visible¶

Name:: user-visible
Type:: bool
Default Value:: False
Flags:: READABLE

user-visible