Dazzle.PathElement

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (id, icon_name, title)
	get_icon_name ()
	get_id ()
	get_title ()

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name	Type	Flags	Short Description
icon-name	str	r/w/co	The icon name for the path element
id	str	r/w/co	Identifier
title	str	r/w/co	Title

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Dazzle.PathElement(**kwargs)

Bases:

GObject.Object

Abstract:

No

Structure:

Dazzle.PathElementClass

classmethod new(id, icon_name, title)

Parameters:

• id (str or None) – An id for the path element.

• icon_name (str or None) – An optional icon name for the element

• title (str) – The title of the element.

Returns:

A Dazzle.PathElement

Return type:

Dazzle.PathElement

Creates a new path element for an Dazzle.Path.

New in version 3.26.

get_icon_name()

Returns:

The icon-name for the Dazzle.PathElement.

Return type:

str or None

Gets the Dazzle.PathElement :icon-name property. This is used by the path bar to display an icon next to the element of the path.

New in version 3.26.

get_id()

Returns:

The id for the Dazzle.PathElement.

Return type:

str

Gets the id for the element. Generally, a path is built of multiple elements and each element should have an id that is useful to the application that it using it. You might store the name of a directory, or some other key as the id.

New in version 3.26.

get_title()

Returns:

The title for the Dazzle.PathElement.

Return type:

str or None

Gets the Dazzle.PathElement :title property. This is used by the path bar to display text representing the element of the path.

New in version 3.26.

Property Details

Dazzle.PathElement.props.icon_name

Name:

icon-name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The icon-name of the icon to display next to the path element in the path bar. Set to None for no icon.

New in version 3.26.

Dazzle.PathElement.props.id

Name:

id

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The id property is an application specific identifier for the element within the path.

New in version 3.26.

Dazzle.PathElement.props.title

Name:

title

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The title property should contain the display text that should be shown to represent the element in the Dazzle.PathBar.

New in version 3.26.