Detailed API documentation

Core functionality

Functions

add_callback(instance, prop, callback[, ...])

Attach a callback function to a property in an instance

callback_property(getter)

A decorator to build a CallbackProperty.

ignore_callback(instance, *props)

Temporarily ignore any callbacks from one or more callback properties

remove_callback(instance, prop, callback)

Remove a callback function from a property in an instance

Classes

CallbackDict(callback, *args, **kwargs)

A dictionary that calls a callback function when it is modified.

CallbackList(callback, *args, **kwargs)

A list that calls a callback function when it is modified.

CallbackProperty([default, docstring, ...])

A property that callback functions can be added to.

ChoiceSeparator

Methods

DictCallbackProperty([default, docstring, ...])

A dictionary property that calls callbacks when its contents are modified

HasCallbackProperties()

A class that adds functionality to subclasses that use callback properties.

ListCallbackProperty([default, docstring, ...])

A list property that calls callbacks when its contents are modified

SelectionCallbackProperty([default_index, ...])

Methods

delay_callback(instance, *props)

Delay any callback functions from one or more callback properties

keep_in_sync(instance1, prop1, instance2, prop2)

Methods

Qt helpers

Functions

autoconnect_callbacks_to_qt(instance, widget)

Given a class instance with callback properties and a Qt widget/window, connect callback properties to Qt widgets automatically.

Classes

BaseConnection(instance, prop, widget)

connect_checkable_button(instance, prop, widget)

Connect a boolean callback property with a Qt button widget.

connect_combo_data(instance, prop, widget)

Connect a callback property with a QComboBox widget based on the userData.

connect_combo_selection(instance, prop, widget)

Methods

connect_combo_text(instance, prop, widget)

Connect a callback property with a QComboBox widget based on the text.

connect_float_text(instance, prop, widget[, fmt])

Connect a numerical callback property with a Qt widget containing text.

connect_list_selection(instance, prop, widget)

Methods

connect_text(instance, prop, widget)

Connect a string callback property with a Qt widget containing text.

connect_value(instance, prop, widget[, ...])

Connect a numerical callback property with a Qt widget representing a value.