Known subclasses: kiwi.ui.widgets.entry.Entry

The Kiwi Entry widget has many special features that extend the basic gtk entry.

First of all, as every Kiwi Widget, it implements the Proxy protocol. As the users types the entry can interact with the application model automatically. Kiwi Entry also implements interesting UI additions. If the input data does not match the data type of the entry the background nicely fades to a light red color. As the background changes an information icon appears. When the user passes the mouse over the information icon a tooltip is displayed informing the user how to correctly fill the entry. When dealing with date and float data-type the information on how to fill these entries is displayed according to the current locale.

Method __init__ Undocumented
Method __post_init__ No summary
Method do_changed Undocumented
Method prop_set_data_type Set the data type for the widget
Method set_mask_for_data_type Set a mask for the parameter data_type. @param data_type:
Method set_completion_strings Set strings used for entry completion. If values are provided, each string will have an additional data type.
Method set_text Sets the text of the entry
Method read No summary
Method update Update the content value of the widget. @param value:

Inherited from ProxyWidgetMixin (via ValidatableProxyWidgetMixin):

Class Variable allowed_data_types A list of types which we are allowed to use in this class.
Method set_data_format Undocumented
Method set_options_for_datatype No summary
Method _as_string Convert a value to a string @param data: data to convert
Method _from_string No summary

Inherited from ProxyWidgetMixin (via ValidatableProxyWidgetMixin):

Class Variable allowed_data_types A list of types which we are allowed to use in this class.
Method set_data_format Undocumented
Method set_options_for_datatype No summary
Method _as_string Convert a value to a string @param data: data to convert
Method _from_string No summary

Inherited from ProxyWidgetMixin (via ValidatableProxyWidgetMixin):

Class Variable allowed_data_types A list of types which we are allowed to use in this class.
Method set_data_format Undocumented
Method set_options_for_datatype No summary
Method _as_string Convert a value to a string @param data: data to convert
Method _from_string No summary

Inherited from ProxyWidgetMixin (via ValidatableProxyWidgetMixin):

Class Variable allowed_data_types A list of types which we are allowed to use in this class.
Method set_data_format Undocumented
Method set_options_for_datatype No summary
Method _as_string Convert a value to a string @param data: data to convert
Method _from_string No summary
def __init__(self, data_type=None):
def __post_init__(self):

A hook which is called after the constructor is called. It's mainly here to workaround http://bugzilla.gnome.org/show_bug.cgi?id=425501 so you can set properties at construction time

def do_changed(self):
Undocumented
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_mask_for_data_type(self, data_type):

Set a mask for the parameter data_type.

Parametersdata_type
def set_completion_strings(self, strings=[], values=[]):

Set strings used for entry completion. If values are provided, each string will have an additional data type.

Parametersstrings (type: list of strings)
values (type: list of values)
def set_text(self, text):

Sets the text of the entry

Parameterstext
def read(self):

Get the content of the widget. The type of the return value

ReturnsNone if the user input a invalid value (type: Must matche the data-type property.)
def update(self, data):

Update the content value of the widget.

Parametersvalue
API Documentation for Kiwi, generated by pydoctor at 2015-12-15 11:23:22.