Tepl.PanelSimple¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Tepl.Panel (3)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`get_active_item` ()
	`get_active_item_name` ()
	`get_items` ()
	`has_several_items` ()
	`set_active_item_name` (name)

Virtual Methods¶

Inherited:: GObject.Object (7), Tepl.Panel (3)

	`do_add_item` (item)
	`do_changed` ()
	`do_remove_item` (item)

Properties¶

Name	Type	Flags	Short Description
`active-item`	`Tepl.PanelItem`	r/w
`active-item-name`	`str`	r/w

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`add-item`	The `::add-item` signal is emitted when a `Tepl.PanelItem` needs to be added.
`changed`	The `::changed` signal is for convenience: it is emitted when the `Tepl.PanelSimple` `::add-item` and `Tepl.PanelSimple` `::remove-item` signals are emitted, and also when the `Tepl.PanelSimple` `:active-item` property changes.
`remove-item`	The `::remove-item` signal is emitted when a `Tepl.PanelItem` needs to be removed.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Tepl.PanelSimple(**kwargs)¶

Bases:: GObject.Object, Tepl.Panel
Abstract:: No
Structure:: Tepl.PanelSimpleClass

classmethod new()¶

Returns:: a new Tepl.PanelSimple object.
Return type:: Tepl.PanelSimple

New in version 6.11.

get_active_item()¶

Returns:: the value of the Tepl.PanelSimple :active-item property.
Return type:: Tepl.PanelItem or None

New in version 6.11.

get_active_item_name()¶

Returns:: the name of the Tepl.PanelSimple :active-item.
Return type:: str or None

A convenience function.

New in version 6.11.

get_items()¶

Returns:: all the items of self.
Return type:: [Tepl.PanelItem]

New in version 6.11.

has_several_items()¶

Returns:: whether self has more than one Tepl.PanelItem.
Return type:: bool

A convenience function. Useful to implement a switcher widget.

New in version 6.11.

set_active_item_name(name)¶

Parameters:: name (str or None) – a name.

A convenience function that calls Tepl.Panel.set_active() with the Tepl.PanelItem named name (if found).

New in version 6.11.

do_add_item(item) virtual¶

Parameters:: item (Tepl.PanelItem) –

do_changed() virtual¶

do_remove_item(item) virtual¶

Parameters:: item (Tepl.PanelItem) –

Signal Details¶

Tepl.PanelSimple.signals.add_item(panel_simple, item)¶

Signal Name:

add-item

Flags:

RUN_LAST

Parameters:

panel_simple (Tepl.PanelSimple) – The object which received the signal
item (Tepl.PanelItem) – the Tepl.PanelItem being added.

The ::add-item signal is emitted when a Tepl.PanelItem needs to be added.

It is a GObject.SignalFlags.RUN_LAST signal: the item is added by the Tepl.PanelSimple's method handler for this signal.

New in version 6.11.

Tepl.PanelSimple.signals.changed(panel_simple)¶

Signal Name:: changed
Flags:: RUN_FIRST
Parameters:: panel_simple (Tepl.PanelSimple) – The object which received the signal

The ::changed signal is for convenience: it is emitted when the Tepl.PanelSimple ::add-item and Tepl.PanelSimple ::remove-item signals are emitted, and also when the Tepl.PanelSimple :active-item property changes.

It is a GObject.SignalFlags.RUN_FIRST signal: the action is already done.

This signal is useful if you don’t need the more detailed information on what has changed.

New in version 6.11.

Tepl.PanelSimple.signals.remove_item(panel_simple, item)¶

Signal Name:

remove-item

Flags:

RUN_LAST

Parameters:

panel_simple (Tepl.PanelSimple) – The object which received the signal
item (Tepl.PanelItem) – the Tepl.PanelItem being removed.

The ::remove-item signal is emitted when a Tepl.PanelItem needs to be removed.

It is a GObject.SignalFlags.RUN_LAST signal: the item is removed by the Tepl.PanelSimple's method handler for this signal.

New in version 6.11.

Property Details¶

Tepl.PanelSimple.props.active_item¶

Name:: active-item
Type:: Tepl.PanelItem
Default Value:: None
Flags:: READABLE, WRITABLE

The Tepl.PanelItem currently shown.

New in version 6.11.

Tepl.PanelSimple.props.active_item_name¶

Name:: active-item-name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The name of the Tepl.PanelSimple :active-item.

New in version 6.11.