Known subclasses: kiwi.ui.proxywidget.ValidatableProxyWidgetMixin, kiwi.ui.widgets.button.ProxyButton, kiwi.ui.widgets.checkbutton.ProxyCheckButton, kiwi.ui.widgets.colorbutton.ProxyColorButton, kiwi.ui.widgets.combo.ProxyComboBox, kiwi.ui.widgets.filechooser.ProxyFileChooserButton, kiwi.ui.widgets.filechooser.ProxyFileChooserWidget, kiwi.ui.widgets.fontbutton.ProxyFontButton, kiwi.ui.widgets.label.ProxyLabel, kiwi.ui.widgets.radiobutton.ProxyRadioButton, kiwi.ui.widgets.scale.ProxyHScale, kiwi.ui.widgets.scale.ProxyVScale

This class is a mixin that provide a common interface for KiwiWidgets.

Usually the Proxy class need to set and get data from the widgets. It also need a validation framework.

Class Variable allowed_data_types A list of types which we are allowed to use in this class.
Method __init__ Undocumented
Method prop_set_data_type Set the data type for the widget
Method set_data_format Undocumented
Method set_options_for_datatype No summary
Method read No summary
Method update Update the content value of the widget. @param value:
Method _as_string Convert a value to a string @param data: data to convert
Method _from_string No summary
allowed_data_types =
A list of types which we are allowed to use in this class.
def prop_set_data_type(self, data_type):

Set the data type for the widget

Parametersdata_typecan be None, a type object or a string with the name of the type object, so None, "<type 'str'>" or 'str'
def set_data_format(self, format):
Undocumented
def set_options_for_datatype(self, datatype, **options):

Set some options to be passed to the datatype converter. Any additional parameter will be passed the the converter when converting an object to a string, for displaying in the widget. Note that the converter.as_string method should be able to handle such parameters.

Parametersdatatypethe datatype.
def _as_string(self, data):

Convert a value to a string

Parametersdatadata to convert
def _from_string(self, data):

Convert a string to the data type of the widget This may raise a kiwi.datatypes.ValidationError if conversion failed

Parametersdatadata to convert
API Documentation for Kiwi, generated by pydoctor at 2019-12-22 23:48:14.