Workrave.Timerbox¶

Subclasses:: None

Methods¶

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

	`draw` (cr)
	`get_height` ()
	`get_time_bar` (timer)
	`get_width` ()
	`set_enabled` (enabled)
	`set_force_icon` (force)
	`set_operation_mode` (mode)
	`set_slot` (slot, brk)
	`update` (image)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`workrave`	`str`	r/w/co	Set workrave’s name

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Workrave.Timerbox(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Workrave.TimerboxClass

draw(cr)¶

Parameters:: cr (cairo.Context) – a cairo_t where the timerbox will be drawn into

get_height()¶

Returns:: The width of the WorkraveTimerbox
Return type:: int

get_time_bar(timer)¶

Parameters:: timer (Workrave.BreakId) – the ID of the Workrave.Timebar to return
Returns:: The WorkraveTimebar of the specified timer
Return type:: Workrave.Timebar

get_width()¶

Returns:: The width of the WorkraveTimerbox
Return type:: int

set_enabled(enabled)¶

Parameters:: enabled (bool) –

set_force_icon(force)¶

Parameters:: force (bool) – Whether the icon is always visible

set_operation_mode(mode)¶

Parameters:: mode (str) –

set_slot(slot, brk)¶

Parameters:

slot (int) – slot to set
brk (Workrave.BreakId) – break to put in slot

update(image)¶

Parameters:: image (Gtk.Image) – a GtkImage where the timerbox will be drawn into

Property Details¶

Workrave.Timerbox.props.workrave¶

Name:: workrave
Type:: str
Default Value:: 'no-name-set'
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Set workrave’s name