Tepl.PanelItem¶

Subclasses:: None

Methods¶

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

class	`new` (widget, name, title, icon_name, position)
	`compare` (b)
	`compare_by_title` (b)
	`get_icon_name` ()
	`get_name` ()
	`get_position` ()
	`get_title` ()
	`get_widget` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags
`icon-name`	`str`	r/w/co
`name`	`str`	r/w/co
`position`	`int`	r/w/co
`title`	`str`	r/w/co
`widget`	`Gtk.Widget`	r/w/co

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Tepl.PanelItem(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Tepl.PanelItemClass

classmethod new(widget, name, title, icon_name, position)¶

Parameters:

widget (Gtk.Widget) – a Gtk.Widget.
name (str) – the name.
title (str or None) – the title.
icon_name (str or None) – the icon-name.
position (int) – the position.

Returns:

a new Tepl.PanelItem object.

Return type:

Tepl.PanelItem

Creates a new Tepl.PanelItem object.

See the properties for the meaning of the parameters.

New in version 6.11.

compare(b)¶

Parameters:: b (Tepl.PanelItem) – a Tepl.PanelItem.
Returns:: the usual return value for a GLib.CompareFunc.
Return type:: int

A GLib.CompareFunc that takes into account the Tepl.PanelItem :position property in priority, and falls back to the Tepl.PanelItem :title property if two items have the same position.

New in version 6.11.

compare_by_title(b)¶

Parameters:: b (Tepl.PanelItem) – a Tepl.PanelItem.
Returns:: the usual return value for a GLib.CompareFunc.
Return type:: int

A GLib.CompareFunc that takes into account only the Tepl.PanelItem :title property.

New in version 6.8.

get_icon_name()¶

Returns:: the value of the Tepl.PanelItem :icon-name property.
Return type:: str or None

New in version 6.8.

get_name()¶

Returns:: the value of the Tepl.PanelItem :name property.
Return type:: str

New in version 6.8.

get_position()¶

Returns:: the value of the Tepl.PanelItem :position property.
Return type:: int

New in version 6.11.

get_title()¶

Returns:: the value of the Tepl.PanelItem :title property.
Return type:: str or None

New in version 6.8.

get_widget()¶

Returns:: the value of the Tepl.PanelItem :widget property.
Return type:: Gtk.Widget or None

New in version 6.8.

Property Details¶

Tepl.PanelItem.props.icon_name¶

Name:: icon-name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The icon name.

It can be shown in the UI to choose this item, for example with the Gtk.Image's Gtk.Image :icon-name property.

New in version 6.11.

Tepl.PanelItem.props.name¶

Name:: name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The name.

It is an ID as a UTF-8 string. It is not displayed in the UI. It uniquely identifies an item within a list.

New in version 6.11.

Tepl.PanelItem.props.position¶

Name:: position
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The position.

Used to sort items in the desired order.

New in version 6.11.

Tepl.PanelItem.props.title¶

Name:: title
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The title.

It is a human-readable UTF-8 string that can be shown in the UI to choose this item.

New in version 6.11.

Tepl.PanelItem.props.widget¶

Name:: widget
Type:: Gtk.Widget
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The Gtk.Widget (the main content).

New in version 6.11.