ClapperGtk.Billboard¶

Subclasses:: None

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` ()
	`announce_speed` ()
	`announce_volume` ()
	`pin_message` (icon_name, message)
	`post_message` (icon_name, message)
	`unpin_pinned_message` ()

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)

Signals¶

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

Fields¶

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

Class Details¶

class ClapperGtk.Billboard(**kwargs)¶

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

A layer where various messages can be displayed.

ClapperGtk.Billboard widget is meant to be overlaid on top of [class`ClapperGtk`.Video] as a normal (non-fading) overlay.

It is used to display various messages/announcements and later takes care of fading them on its own.

If automatic volume/speed change notifications when their values do change are desired, functions for announcing them can be run in callbacks to corresponding property notify signals on the [class`Clapper`.Player].

classmethod new()¶

Returns:: a new billboard Gtk.Widget.
Return type:: Gtk.Widget

Creates a new ClapperGtk.Billboard instance.

announce_speed()¶

Temporarily displays current speed value on the side of self.

Use this if you want to present current speed value to the user.

announce_volume()¶

Temporarily displays current volume level on the side of self.

Use this if you want to present current volume level to the user.

pin_message(icon_name, message)¶

Parameters:

icon_name (str) – an icon name
message (str) – a message text

Pins a permanent message on the self.

The message will stay on the self until a [method`ClapperGtk`.Billboard.unpin_pinned_message] is called.

post_message(icon_name, message)¶

Parameters:

icon_name (str) – an icon name
message (str) – a message text

Posts a temporary message on the self.

Duration how long a message will stay is automatically calculated based on amount of text.

unpin_pinned_message()¶

Unpins previously pinned message on the self.

If no message was pinned this function will do nothing, so it is safe to call when unsure.