kiwi.ui.proxywidget.ValidatableProxyWidgetMixin(ProxyWidgetMixin) class documentationkiwi.ui.proxywidget
(View In Hierarchy)
Known subclasses: kiwi.ui.widgets.combo.ProxyComboBoxEntry, kiwi.ui.widgets.combo.ProxyComboEntry, kiwi.ui.widgets.entry.ProxyDateEntry, kiwi.ui.widgets.entry.ProxyEntry, kiwi.ui.widgets.spinbutton.ProxySpinButton, kiwi.ui.widgets.textview.ProxyTextView
Class used by some Kiwi Widgets that need to support mandatory input and validation features such as custom validation and data-type validation.
Mandatory support provides a way to warn the user when input is necessary. The validatation feature provides a way to check the data entered and to display information about what is wrong.
| Method | __init__ | Undocumented |
| Method | update_background | Implement in subclass |
| Method | get_background | Implement in subclass |
| Method | set_pixbuf | Implement in subclass |
| Method | get_icon_window | Implement in subclass |
| Method | set_tooltip | Implement in subclass |
| Method | is_valid | Verify the widget state. @returns: True if the widget is in validated state |
| Method | validate | Checks if the data is valid. Validates data-type and custom validation. |
| Method | set_valid | Changes the validation state to valid, which will remove icons and reset the background color |
| Method | set_invalid | Changes the validation state to invalid. @param text: text of tooltip of None @param fade: if we should fade the background |
| Method | set_blank | Changes the validation state to blank state, this only applies for mandatory widgets, draw an icon and set a tooltip |
| Method | _set_valid_state | Updates the validation state and emits a signal iff it changed |
| Method | _draw_stock_icon | Undocumented |
| Method | _on_fadeout__color_changed | Undocumented |
Inherited from ProxyWidgetMixin:
| Class Variable | allowed_data_types | A list of types which we are allowed to use in this class. |
| 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 |
Implement in subclass
Implement in subclass
Implement in subclass
Checks if the data is valid. Validates data-type and custom validation.
| Parameters | force | if True, force validation |
| Returns | validated data or ValueUnset if it failed | |
Changes the validation state to valid, which will remove icons and reset the background color
Changes the validation state to invalid.
| Parameters | text | text of tooltip of None |
| fade | if we should fade the background |
Changes the validation state to blank state, this only applies for mandatory widgets, draw an icon and set a tooltip