EDataServer.SourceSelectable

Subclasses:

EDataServer.SourceCalendar, EDataServer.SourceMemoList, EDataServer.SourceTaskList

Methods

Inherited:

EDataServer.SourceBackend (3), EDataServer.SourceExtension (4), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

	dup_color ()
	get_color ()
	get_order ()
	get_selected ()
	set_color (color)
	set_order (order)
	set_selected (selected)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Inherited:

EDataServer.SourceBackend (1), EDataServer.SourceExtension (1)

Name	Type	Flags	Short Description
color	str	r/w/c/en	Textual specification of a color
order	int	r/w/c/en	Preferred sorting order
selected	bool	r/w/c/en	Whether the data source is selected

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent	EDataServer.SourceBackend	r

Class Details

class EDataServer.SourceSelectable(**kwargs)

Bases:

EDataServer.SourceBackend

Abstract:

Yes

Structure:

EDataServer.SourceSelectableClass

Contains only private data that should be read and manipulated using the functions below.

New in version 3.6.

dup_color()

Returns:

a newly-allocated copy of EDataServer.SourceSelectable :color, or None, when none is set

Return type:

str or None

Thread-safe variation of EDataServer.SourceSelectable.get_color(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.6.

get_color()

Returns:

the color specification for the EDataServer.Source, or None, when none is set

Return type:

str or None

Returns the color specification for the EDataServer.Source to which self belongs. A colored block is often displayed next to the data source’s display name in user interfaces.

New in version 3.6.

get_order()

Returns:

the preferred sorting order for the EDataServer.Source

Return type:

int

Returns the preferred sorting order for the EDataServer.Source to which self belongs. Default is 0.

New in version 3.40.

get_selected()

Returns:

the selected state for the EDataServer.Source

Return type:

bool

Returns the selected state of the EDataServer.Source to which self belongs. The selected state is often represented as a checkbox next to the data source’s display name in user interfaces.

New in version 3.6.

set_color(color)

Parameters:

color (str or None) – a color specification, or None

Sets the color specification for the EDataServer.Source to which self belongs. A colored block is often displayed next to the data source’s display name in user interfaces.

The internal copy of color is automatically stripped of leading and trailing whitespace. If the resulting string is empty, None is set instead.

New in version 3.6.

set_order(order)

Parameters:

order (int) – the sorting order

Sets the sorting order for the EDataServer.Source to which self belongs.

New in version 3.40.

set_selected(selected)

Parameters:

selected (bool) – selected state

Sets the selected state for the EDataServer.Source to which self belongs. The selected state is often represented as a checkbox next to the data source’s display name in user interfaces.

New in version 3.6.

Property Details

EDataServer.SourceSelectable.props.color

Name:

color

Type:

str

Default Value:

'#62a0ea'

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Textual specification of a color

EDataServer.SourceSelectable.props.order

Name:

order

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Preferred sorting order

EDataServer.SourceSelectable.props.selected

Name:

selected

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether the data source is selected