ClapperGtk.TitleHeader¶

Subclasses:: None

Methods¶

Inherited:: ClapperGtk.LeadContainer (5), 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_current_title` ()
	`get_fallback_to_uri` ()
	`set_fallback_to_uri` (enabled)

Virtual Methods¶

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

Properties¶

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

Name	Type	Flags	Short Description
`current-title`	`str`	r/en
`fallback-to-uri`	`bool`	r/w

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.TitleHeader(**kwargs)¶

Bases:: ClapperGtk.LeadContainer
Abstract:: No
Structure:: ClapperGtk.TitleHeaderClass

A header panel widget that displays current media title.

ClapperGtk.TitleHeader is a simple, ready to be used header widget that displays current media title. It can be placed as-is as a [class`ClapperGtk`.Video] overlay (either fading or not).

If you need a further customized header, you can use [class`ClapperGtk`.TitleLabel] which is used by this widget to build your own implementation instead.

classmethod new()¶

Returns:: a new title header Gtk.Widget.
Return type:: Gtk.Widget

Creates a new ClapperGtk.TitleHeader instance.

get_current_title()¶

Returns:: text of title label.
Return type:: str

Get currently displayed title by self.

get_fallback_to_uri()¶

Returns:: True when item URI will be used as fallback, False otherwise.
Return type:: bool

Get whether a [property`Clapper`.MediaItem:uri] property is going be displayed as a header text when no other title could be determined.

set_fallback_to_uri(enabled)¶

Parameters:: enabled (bool) – whether enabled

Set whether a [property`Clapper`.MediaItem:uri] property should be displayed as a header text when no other title could be determined.

Property Details¶

ClapperGtk.TitleHeader.props.current_title¶

Name:: current-title
Type:: str
Default Value:: None
Flags:: READABLE, EXPLICIT_NOTIFY

Currently displayed title.

ClapperGtk.TitleHeader.props.fallback_to_uri¶

Name:: fallback-to-uri
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

When title cannot be determined, show URI instead.