ClapperGtk.LeadContainer¶

Subclasses:: ClapperGtk.TitleHeader

Methods¶

Inherited:: ClapperGtk.Container (11), Gtk.Widget (181), GObject.Object (37), Gtk.Accessible (15), Gtk.Buildable (1)
Structs:: Gtk.WidgetClass (18), GObject.ObjectClass (5)

class	`new` ()
	`get_blocked_actions` ()
	`get_leading` ()
	`set_blocked_actions` (actions)
	`set_leading` (leading)

Virtual Methods¶

Inherited:: Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9)

Properties¶

Inherited:: ClapperGtk.Container (4), Gtk.Widget (34), Gtk.Accessible (1)

Name	Type	Flags	Short Description
`blocked-actions`	`ClapperGtk.VideoActionMask`	r/w/en
`leading`	`bool`	r/w/en

Signals¶

Inherited:: ClapperGtk.Container (1), Gtk.Widget (13), GObject.Object (1)

Fields¶

Inherited:: ClapperGtk.Container (1), Gtk.Widget (13), GObject.Object (1)

Name	Type	Access	Description
parent_instance	`ClapperGtk.Container`	r

Class Details¶

class ClapperGtk.LeadContainer(**kwargs)¶

Bases:: ClapperGtk.Container
Abstract:: No
Structure:: ClapperGtk.LeadContainerClass

A ClapperGtk.Container that can take priority in user interactions with the ClapperGtk.Video.

ClapperGtk.LeadContainer is a special type of [class`ClapperGtk`.Container] that can lead in interaction events. When “leading”, it is assumed that user interactions over it which would normally trigger actions can be blocked/ignored when set in mask of actions that this widget should block.

This kind of container is useful when creating some statically visible overlays covering top of [class`ClapperGtk`.Video] that you want to take priority instead of triggering default actions such as toggle play on click or revealing fading overlays.

For more info how container widget works see [class`ClapperGtk`.Container] documentation.

classmethod new()¶

Returns:: a new lead container Gtk.Widget.
Return type:: Gtk.Widget

Creates a new ClapperGtk.LeadContainer instance.

get_blocked_actions()¶

Returns:: a mask of actions that container blocks from being triggered on video.
Return type:: ClapperGtk.VideoActionMask

Get actions that were set for this self to block.

get_leading()¶

Returns:: True if container is leading, False otherwise.
Return type:: bool

Get a whenever self has leadership set.

set_blocked_actions(actions)¶

Parameters:: actions (ClapperGtk.VideoActionMask) – a ClapperGtk.VideoActionMask of actions to block

Set actions that ClapperGtk.Video should skip when Gdk.Event which would normally trigger them happens inside self.

set_leading(leading)¶

Parameters:: leading (bool) – enable leadership

Set if self leadership should be enabled.

When enabled, interactions with self will not trigger their default behavior, instead container and its contents will take priority.

Property Details¶

ClapperGtk.LeadContainer.props.blocked_actions¶

Name:: blocked-actions
Type:: ClapperGtk.VideoActionMask
Default Value:: ClapperGtk.VideoActionMask.NONE
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Mask of actions that container blocks from being triggered on video.

ClapperGtk.LeadContainer.props.leading¶

Name:: leading
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Width that container should target.