Ags.Conversion¶

Subclasses:: None

Methods¶

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

class	`new` ()
	`convert` (x, reverse)

Virtual Methods¶

Inherited:: GObject.Object (7)

do_convert (x, reverse)

Properties¶

Name	Type	Flags	Short Description
`description`	`str`	r/w	The description of the conversion
`name`	`str`	r/w	The name of the conversion

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`convert`	The `::convert` signal notifies about converted value.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
description	`str`	r
gobject	`GObject.Object`	r
name	`str`	r
obj_mutex	`GLib.RecMutex`	r

Class Details¶

class Ags.Conversion(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Ags.ConversionClass

classmethod new()¶

Returns:: the new instance
Return type:: Ags.Conversion

Instantiate a new Ags.Conversion.

New in version 3.0.0.

convert(x, reverse)¶

Parameters:

x (float) – the value to convert
reverse (bool) – the direction to convert

Returns:

the converted value as float

Return type:

float

Convert a value if reverse is False then use the target format otherwise if True convert back to original format.

New in version 3.0.0.

do_convert(x, reverse) virtual¶

Parameters:

x (float) – the value to convert
reverse (bool) – the direction to convert

Returns:

the converted value as float

Return type:

float

Convert a value if reverse is False then use the target format otherwise if True convert back to original format.

New in version 3.0.0.

Signal Details¶

Ags.Conversion.signals.convert(conversion, x, reverse)¶

Signal Name:

convert

Flags:

RUN_LAST

Parameters:

conversion (Ags.Conversion) – The object which received the signal
x (float) – the value to convert
reverse (bool) – the direction to translate

Returns:

the converted value

Return type:

float

The ::convert signal notifies about converted value.

New in version 3.0.0.

Property Details¶

Ags.Conversion.props.description¶

Name:: description
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The description of the conversion.

New in version 3.0.0.

Ags.Conversion.props.name¶

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

The name of the conversion.

New in version 3.0.0.